OverwriteMapModule_v2 - Strategic-Futures-Lab/Topic_Mapping_Pipeline GitHub Wiki
The Overwrite Map module creates a Map JSON file based on existing mappable data (from an existing Map JSON file), and with new topic data, such as labels and topic size (as computed by the Topic Distribution module).
The use of this module is optional, and only fits with the use of the Document Inference module: with new documents having their topic distribution inferred, topics have new weights.
The Overwrite Map module is contained in the P5_TopicMapping package, in the OverwriteMap.java class.
The Overwrite Map module entry in the project file should have the following structure:
{...,
"overwriteMap": {
"distribution" | "mainDistribution": "path",
"subDistribution": "path",
"map" | "mainMap": "path",
"subMaps": "path",
"mapOutput" | "mainMapOutput": "path",
"subMapsOutput": "path",
"sizeName": "distributionName",
"overwriteLabels": false
},
...}| Name | Description | Optional | Default |
|---|---|---|---|
distribution or mainDistribution (if the model is hierarchical) |
Path to the distributed (main) topics JSON file, with updated topics * | No | |
subDistribution |
Path to the sub topics JSON file, with updated topics * | Required if the model is hierarchical |
"" ** |
map or mainMap (if the model is hierarchical) |
Path to the existing (main) map JSON file *** | No | |
subMaps |
Path to the existing sub map JSON file *** | Required if the model is hierarchical | |
mapOutput or mainMapOutput (if the model is hierarchical) |
Path to the output new (main) map JSON file **** | No | |
subMapsOutput |
Path to the output new sub map JSON file **** | Required if the model is hierarchical | |
sizeName |
Name of the topic distribution to use to update topic size data in the map | Yes |
"" (no update) |
overwriteLabels |
Flag for updating the topics' top labels in the map | Yes |
false (no update) |
- * 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; - *** These paths are relative to the source directory;
- **** These paths are relative to the output directory.
The output of the Overwrite Map module is similar to the output of the Topic Mapping module.
