UIMA Documentation Overview

Authors: The Apache UIMA Development Community

Version 3.0.0-beta

License and Disclaimer. The ASF licenses this documentation to you under the Apache License, Version 2.0 (the "License"); you may not use this documentation except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, this documentation and its contents are distributed under the License on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Trademarks. All terms mentioned in the text that are known to be trademarks or service marks have been appropriately capitalized. Use of such terms in this book should not be regarded as affecting the validity of the the trademark or service mark.

March, 2017


UIMA Version 3.0.0-beta Documentation

The UIMA documentation is available in both PDF and HTML formats. It is divided into five books:

1. Overview & Setup
This includes overview material, a general guide to all the rest of the documentation, and some setup instructions if you are using the Eclipse IDE.
2. UIMA Tutorial and Developers' Guides
This is a set of tutorial chapters and some general overview guides to the major features and capabilities of UIMA.
3. UIMA Tools Guide and Reference
UIMA comes with a set of tools, which are described in this book.
4. UIMA References
Reference materials, covering the XML descriptors, the major APIs, the data interchange formats, and the component packaging.
5. Version 3 User's Guide
UIMA Version 3 is a major rework of the internals, and adds many new capabilities. It is mostly backwards compatible with Version 2, except for the need to regenerate or migrate any user-defined JCas classes.

Release Notes

Click RELEASE_NOTES.html for the 3.0.0-beta Apache UIMA JAVA SDK release notes.

API changes for V3

Click api change report for a report of the APIs in UIMA that were changed in this release, versus the 2.9.0 version.

Issues Fixed

Click issues fixed for the list of Jira issues fixed since the previous release.