Lemur Toolkit Documentation (Version 3.0)

(Older versions: 1.0, 1.1, 1.9.x, 2.0.x, 2.1.x, 2.2.x)



Introduction to Lemur

Overview An overview of what Lemur is, what it has, and how people use it.
Beginner's Guide to Indexing A Q/A beginner's guide to indexing, what Lemur can index, and what kind of indexes Lemur has.
Language Modeling Background A summary on recent research on language modeling and information retrieval.


Getting Started with Lemur

Installing and Running Lemur Step-by-step instructions on how to compile, configure and test the toolkit.
Installing and Running Lemur CGI and GUI Instructions on how to compile and use the CGI web interface and stand-alone retrieval GUI. Also some tips about which indexes to use and how to deal with query processing.
Basic Components A description of the organization and design of the sytem, including major classes and how they interact within the indexing, retrieval, and language modeling framework.
Tutorials Guides on how to prepare documents for parsing and indexing using Lemur. These tutorials are in progress. (In other words, some links don't work yet..but we're working on it.) Feedback on what topics would be most helpful and how to improve the format is most welcome.


Lemur Reference Material

Lemur Modules and Applications General descriptions for the major modules in Lemur plus documentation for how to use all the Lemur applications. (Parsing and Preprocessing, Building/Adding to an index, General Retrieval and Evaluation, User Interfaces, Distributed IR and Query-based Sampling, Structured Query Language, Summarization, Clustering)
Basic Lemur Indexing and Retrieval API Documentation for the Application Program Interface, which allows users to build customized retrieval applications using language modeling or other methods.
API Programming Examples A number of examples to illustrate how to add new methods to the Lemur toolkit, adhering to the API, and how to write programs that use the Lemur API.
Source Code Documentation Automatically generated documentation for all of the source code.


Lemur Support

Public Forum This forum is for the users and developers of the Lemur toolkit to discuss the software. Feel free to share tips on using Lemur as well as to ask questions. The developers of the toolkit monitor this forum on a regular basis.
  Feel free to email us with questions, comments and feedback. For general questions, please use the forum so that others may also benefit from the answers.
Licensing Terms for using the Lemur Toolkit.


  The Lemur Project
  Last modified: Wednesday, 15-Sep-2004 16:48:56 EDT