Multi-document Annotation Environment
MAE (Multi-document Annotation Environment) is a lightweight, general-purpose natural language annotation tool. It was originally created by Amber Stubbs for use in her dissertation research at Brandeis University, and currently Keigh Rim is maintaining the project.
MAE allows users to define their own annotation tasks, mark up arbitrary text spans, use non-consuming tags, easily create links between annotations, and it outputs annotations in stand-off XML. It also allows for easy adjudication with visualization of extent tags, link tags, and non-consuming tags from any XML standoff annotated documents. (for best results, the files output by MAE should be used). While it does not enforce strict rules for annotation schemes, it is very easy to set up and start running. Check out the wiki for the user guide with detailed instructions.
How to use
Latest MAE requires Java 8 to run (Java 9 or later is recommended for HiDPI machines), and Maven to build. See the project wiki for more details.
For robust Unicode support, MAE uses DejaVu Sans font as the default. If the annotation task involves lots of Unicode characters, such as Emojis, users are also recommended to have DejaVu Sans font installed.
Download and run
Download release package or executable
.jar from from releases page. Once you have
mae-<VERSION>.jar file, simply double click the file will run MAE. Be sure that you have a proper version of Java installed.
Annotation and Adjudication
See the project wiki for detailed users’ guide.
MAE is a free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Also, MAE is written using open source software below.
- For 1.0 and later version:
- Kyeongmin Rim. “MAE2: Portable Annotation Tool for General Natural Language Use”. In Proceedings of the 12th Joint ACL-ISO Workshop on Interoperable Semantic Annotation, Portorož, Slovenia, May 28, 2016.
- For 0.x:
- Amber Stubbs. “MAE and MAI: Lightweight Annotation and Adjudication Tools”. In 2011 Proceedings of the Linguistic Annotation Workshop V, Association of Computational Linguistics, Portland, Oregon, July 23-24, 2011.
Open source software used in MAE
- Maven (apache2)
- Apache common-io (apache2)
- Xerial sqlite3-JDBC driver (apache2)
- LogBack logging framework (LGPL 2.1)
- SLF4J logging framwork (MIT)
- ORMlite (open source license)
All changes are documented on releases page.
To learn more about natural language annotation, please refer to Amber Stubbs and James Pustejovsky’s book Natural Language Annotation for Machine Learning. (Note that the book is written using MAE 0.9.6)
You can also visit Amber Stubb’s old code base archive hosted on Google Code.