The Label Index module reads the top words from topic data to create an index of labels which is then saved in an Index JSON file.

The use of this module is optional.

The Label Index module is contained in the P4_Analysis.LabelIndex package, in the LabelIndexing.java class.

The Label Index module entry in the project file should have the following structure:

{...
  "indexLabels": {
    "topics" | "mainTopics": "path",
    "subTopics": "path",
    "documents": "path",
    "useAllDocuments": false,
    "useAllLabels": false,
    "output": "path"
  },
...}

• * These paths are relative to the data directory;
• ** This default value implies a non-hierarchical model, if the model type meta-parameter is set to hierarchical, a path must be provided;
• *** This path is relative to the output directory.

The Label Index module generates an index JSON file with the following structure:

{
  "label1":{
    "mainTopics": ["id", ... ],
    "subTopics": [["id", ["mainTopicId", ... ]], ... ],
    "documents": ["id", ... ]
  },
  "label2":{
    "mainTopics": ["id", ... ],
    "subTopics": [["id", ["mainTopicId", ... ]], ... ],
    "documents": ["id", ... ]
  },
...}

It lists all the labels indexed and attaches an object to them, with the following lists:

• mainTopics the list of topic ids from the mainTopics JSON file containing this label;
• subTopics the list of tuple, with the first item being a topic id from the subTopics JSON file containing this label, and the second item the list of ids for their assigned main topics;
• documents the list of document ids from the documents JSON file containing this label.