Documentation

Here you will find 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 current UIMA documentation version 2.3.0-incubating is available in two formats (HTML and PDF): HTML online version - UIMA Java SDK HTML online version - UIMA Asynchronous Scaleout PDF version for printing: Overview and Setup Tutorials and Users' Guides Tools References UIMA Asynchronous Scaleout Previous releases (HTML only) Version 2.2.2-incubating Version 2.2.1-incubating Version 2.2.0-incubating Version 2.1.0-incubating

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. Javadoc online

Annotators, Web Servers, Tooling, and more

Many of the additional components found in the sandbox have individual documentation files, which you can access from the 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. Getting Started: Why UIMA For first time UIMA users who want to know what UIMA is and how it can be used for. Getting Started: Install UIMA And Run Examples For first time UIMA users who want to know how UIMA is installed and how they can run the UIMA analysis examples that are provided with the release package. Getting Started: Writing My First UIMA Annotator For UIMA beginners that want to develop their first UIMA analysis component using eclipse. Getting Started: Working With PEARs For UIMA users who want to know what a UIMA PEAR package is, how to generate them and how to use them within UIMA applications. Getting Started: UIMA Asynchronous Scaleout For UIMA users who need to scale out their UIMA analytics to achieve higher throughput, get faster response time, and to develop applications utilizing UIMA Flow Controllers, CAS Multipliers and advanced error handling capability. Getting Started: UIMA C++ Framework For UIMA users who want to create UIMA compliant Analysis Engines from programs written in C++, Perl, Python or Tcl.