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.

UIMA Java SDK and UIMA-AS Manuals and Guides

There are two "current" versions of UIMA Java SDK. The true "current" version is version 3.0.1, which may require a migration step for existing UIMA applications. Because of that potential migration step, we will also list here the latest version of UIMA version 2.

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

PDF version for printing:

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 2.2.2 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

Note: Many of these have not (yet) been updated for UIMA V3.

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.