Skip to content

Manage annotations

Overview

Annotating documents with the categories included in the taxonomy is critical. This action in fact "teaches" the categorization models to "learn" from these examples and thus to give the models the ability to "predict" similar categorizations.

Annotations should be done for all the information resources before generating the categorization model, according to the principle: "no annotations, no categorizations".

Annotations should also be done in the set of test documents, especially after experiments that return resulting categories, because they are necessary for a measurement of the categorization quality, that is, if the ML model has actually learned to categorize.

In the Documents tab you can manage annotations.

The Main topics strip, at the top of the document, can be a hint for proper annotations.

After an annotation or a change, an icon suggests to refresh the page.

Note

A colored dot beside the category in the Taxonomy panel in the list view represents the population count.

  • = Less than 6 documents annotated for the category.
  • = Between 6 and 20 documents annotated for the category.
  • No dots = more than 20 annotations

Warning

The annotation features are disabled in documents in a language other than the one selected for the project.

Annotate a document

Annotating a document means to manually select a category for a text. The selected category is visually represented by an indigo chip . It is an operation initially performed in the training library, but it is also important for the test library.

Annotate a document in the list view

  1. Select or hover over the document.
  2. Select Add category .
  3. Enter the category name, then press Enter.

    Note

    A notification will suggest a category while typing, if it is included in the taxonomy, and will alert, if the category is not included.

    Note

    Use the Taxonomy panel on the right side to check if a category is in the taxonomy. You can also search for it using the search bar placed above the taxonomy itself.

Or:

  1. Select the documents you want to annotate, multiple selections with CTRL+CLICK and SHIFT+CLICK are allowed.
  2. Drag the documents in the desired category displayed in the Taxonomy panel on the right side or select in the toolbar and enter the category in Annotate documents.

Tip

If you think that the displayed text is not enough to decide the category of the annotation, select show more or switch to the detail view.

Annotate a document in the detail view

  1. Select a document from the left panel list or consider the opened one.
  2. Select Add category .
  3. Enter the category name, then press Enter.

Or:

  1. Select a category in the Taxonomy panel.
  2. Drag it into the text.

After manual annotations, the Ann annotation counter displays the annotations count.

Annotate suggestions coming from Building magic taxonomy procedure

If you create the taxonomy with the Building magic taxonomy procedure, the documents have annotations suggestions displayed with a dashed outline.

  • To find suggestions for a category, enter $SUG and the category name in the search bar .
  • To hide the suggestions, select Hide suggestions .
  • To show suggestions, select Show suggestions .
  • To annotate the documents categories, the procedure is the same as already described, but the chip visualization is different .

Annotate resulting categories

Annotating categories in a document means confirming or rejecting categories resulting from an experiment, or even change the already annotated ones. This is an operation that is performed generally in the test library and after running an experiment.

Suggested resulting categories are represented by a blue chip:

In detail view the categories counter Cat shows the number of resulting categories. The resulting categories visualization depends on the used engine type in the experiment.

With AutoML Categorization:

With Explainable Categorization or CPK:

In this case, in addition to the category, it is displayed the frequency and the hits number that triggered the category.

Select the chip to check also the score and to display the annotation bar.

Select the hits number to highlight in the text the hits that triggered the category.

To annotate a category, in list and detail view:

  1. Select the category chip.
  2. Select Annotate .

If you annotate resulting categories, the chips switch to the green color that represents the true positive TP.

Automatically the other possible returned categories are turned into orange chips that represent false positives FP. It is possible to annotate them too if desired.

The annotation counter Ann is then updated accordingly.

Annotate all the categories in the detail view

To annotate all the categories of the document in the detail view, select Annotate all categories .

Remove an annotation or a category

To Remove an annotation or a category in list or detail view:

  1. Select the annotation.
  2. Select Remove .

Remove all the categories in detail view

In detail view, if you want to remove all the categories from a document, select Remove all categories .

Replace an annotation

To replace an annotation:

  1. Select the annotation.
  2. Select Replace .
  3. Enter the new category name, then press Enter.

Show the resources for a specific annotation or category

To show the resources for a specific annotation or category:

  1. Select the annotation.
  2. Select Show resources .

The Resources tab displays the category in the taxonomy.

Show the overall annotations for that specific annotation category

To show the overall annotations for that specific annotation category:

  1. Select the annotation.
  2. Select Show info .