Documentation
The Semantic Engine has been written as a series of C++ libraries to make it easier for other developers to integrate it into their code. The documentation below describes the main features of the Semantic Engine and how it can be used.1. Installation: Steps for installing the Semantic Engine software on Windows, Mac OS X and Linux.
2. Getting Started: Some usage notes for getting the Semantic Engine to work with your code.
3. Examples: Some examples for building programs that index and search text.
4. Tools: A command-line indexing and searching tool is included in the Semantic Engine distribution. The program usage is described here.
5. C++ Detailed API:
- Semantic Graph: descriptions of the base graph classes
- Ranking: documentation of the graph traversal and ranking algorithms.
- Weights: descriptions of the various weighting schemes available to the semantic classes
- Indexing: API documentation for the indexing classes
- Filtering: explanation of how documents and words are filtered as a part of the pre-processing stage.
- Utility functions: miscellaneous methods available to semantic classes
6. Perl API: Documentation of the perl bindings to the Semantic Engine code