UIMA project logo
Apache UIMA Documentation
Apache UIMA

Search the site

 Documentation

Here you can find documentation for the different parts of Apache UIMA and a few Getting Started Guides.

Apache UIMA Java SDK v3
Overview and Setup [HTML] [PDF]
Tutorials and Users' Guides [HTML] [PDF]
Tools [HTML] [PDF]
References [HTML] [PDF]
(New) Version 3 User's Guide [HTML] [PDF]
API Documentation [HTML]
Apache UIMA uimaFIT v3
Guide and Reference Manual [HTML] [PDF]
API Documentation [HTML]
Apache UIMA Ruta v3
Guide and Reference Manual [HTML] [PDF]
Apache UIMA Distributed UIMA Cluster Computing v3
Installation [HTML] [PDF]
Manual [HTML] [PDF]
API Documentation [HTML]

 Older Releases

Archived versions may also be found at https://svn.apache.org/repos/asf/uima/site/archive/docs/d/.

Apache UIMA Java SDK v2
Overview and Setup [HTML] [PDF]
Tutorials and Users' Guides [HTML] [PDF]
Tools [HTML] [PDF]
References [HTML] [PDF]
API Documentation [HTML]
Apache UIMA uimaFIT v2
Guide and Reference Manual [HTML] [PDF]
API Documentation [HTML]
Apache UIMA Ruta v2
Guide and Reference Manual [HTML] [PDF]
Apache UIMA Distributed UIMA Cluster Computing v2
Installation [HTML] [PDF]
Manual [HTML] [PDF]
API Documentation [HTML]
Apache UIMA Asynchronous Scaleout v2
Overview and Setup [HTML] [PDF]
Reference Manual [HTML] [PDF]
Tutorials and User's Guides [HTML] [PDF]
Tools [HTML] [PDF]
References [HTML] [PDF]

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.