Comparison Document Creation Tool


MAT 2.0 introduces comparison documents, which contain multiple sets of annotations against the same signal, together with pairings and similarity judgments. These pairings are created by the same algorithm that underlies MATScore. These pairings can be visualized, and (ultimately) reconciled, in the MAT UI, and these comparison documents are created by the MAT server in response to comparison requests from the UI. The standalone viewer has no corresponding ability to create these documents on demand; this tool is provided for those who wish to create comparison documents for viewing in the standalone tool.



% $MAT_PKG_HOME/bin/MATCreateComparisonDocument

Windows native:

> %MAT_PKG_HOME%\bin\MATCreateComparisonDocument

Usage: MATCreateComparisonDocument [options] task_name output_doc pivot_doc otherdoc...

task_name: the name of a known task. Known tasks are: ...
output_doc: the file to save the comparison document to.
pivot_doc: the document to which each of the other documents will be compared.
otherdoc...: a sequence of other documents, which all share the same signal with the pivot_doc.


--file_type <t>
The file type of the input document(s). One of the readers. Default is mat-json.
If provided, the name of a similarity profile in the specified task.


Let's say you've annotated a document ne.json using the "Named Entity" task, and you have another annotator's annotations as well, in the file ne_other.json and you want to create a comparison document for use in the standalone viewer, and you want to treat your document as the reference (pivot) document.


% $MAT_PKG_HOME/bin/MATCreateComparisonDocument "Named Entity" ne_comparison.json ne.json ne_other.json

Windows native:

> %MAT_PKG_HOME%\bin\MATCreateComparisonDocument.cmd "Named Entity" ne_comparison.json ne.json ne_other.json