UIMA project logo
Apache UIMA Documentation
Apache UIMA

Search the site

 Documentation

Here you will find Apache UIMA™ Manuals and Guides (Overview and Setup, Tutorials and Users' Guides, Tools, and References), the Javadocs for the public APIs of UIMA, and Getting Started Guides.

  • Note: The UIMA manuals/guides and Javadocs are also distributed as part of the binary distribution.

UIMA Manuals and Guides

The UIMA documentation is available in two formats (HTML and PDF). Here are the latest versions:

PDF version for printing:

The UIMA Documentation for version 2.4.2 of the UIMA SDK is here:

The UIMA Documentation for version 2.4.0 of the UIMA SDK is here:

The UIMA documentation for version 2.3.1 is available in two formats (HTML and PDF):

PDF version for printing:

The documentation version for version 2.3.0-incubating is also available in two formats (HTML and PDF):

PDF version for printing:

Previous releases (HTML only)

Javadoc (current version only)

Apache UIMA Javadoc is supplied with the binary distribution, or can be built from the source distribution. We also make it available directly from this website.

UIMA DUCC

Documentation for the Apache UIMA DUCC 1.0.0 release:

uimaFIT

Documentation for the latest Apache uimaFIT™ release:

UIMA Ruta

Documentation for the latest Apache UIMA Ruta release:

Annotators, Web Servers, Tooling, and more

Many of the additional components found in the Addons and Sandbox have individual documentation files, which you can access from the Addons and Sandbox page

Getting Started

The UIMA "Getting Started" guides are intended to offer a quick overview of UIMA and how it works. They are designed to address different audiences that want to work with UIMA.

The section below lists all currently available "getting started" guides with their links. For more advanced documentation about these topics, please refer to the Apache UIMA release documentation.