update labelling documentation

zinggAI · Jan 2, 2022 · 045d0e8 · 045d0e8
1 parent ccc90bd
commit 045d0e8
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 2 deletions.
diff --git a/assets/update.gif b/assets/update.gif
diff --git a/docs/generatingDocumentation.md b/docs/generatingDocumentation.md
@@ -3,6 +3,6 @@ layout: default
 nav_order: 6
 ---
 ## Generating Documentation
-Zingg allows generating readable documentation about the training data, including those marked as matches as non matches. The documentation is written to the zinggDir/modelId folder and can be built using the following
+Zingg generates readable documentation about the training data, including those marked as matches as non matches. The documentation is written to the zinggDir/modelId folder and can be built using the following
 
 `./scripts/zingg.sh --phase generateDocs --conf <location to conf.json>`
diff --git a/docs/stepByStep.md b/docs/stepByStep.md
@@ -31,4 +31,6 @@ The training data in Step 4 above is used to train Zingg and build and save the
 ### Step 6: Voila, lets match!
 Its now time to apply the model above on our data. This si done by running the *match* or the *link* phases depending on whether you are matching within a single source or linking multiple sources respectively. You can read more about [matching](setup/match.md) and [linking](setup/linking.md)
 
-As long as your input columns and the field types are not changing, the same model should work and you do not need to build a new model. 
+As long as your input columns and the field types are not changing, the same model should work and you do not need to build a new model. If you change the match type, you can cotinue to use the training data and add more labelled pairs on top of it. 
+
+
diff --git a/docs/updatingLabels.md b/docs/updatingLabels.md
@@ -0,0 +1,13 @@
+---
+layout: default
+nav_order: 6
+---
+## Updating Labeled Pairs
+As our understanding of our data changes, we may need to revisit the previously marked pairs and update them. To do this, please [generate the documentation of the model.](./generatingDocumentation.md)
+
+You can then invoke the updater by invoking  
+`./scripts/zingg.sh --phase updateLabel --conf <location to conf.json>`
+
+This brings up the console labeller which accepts the cluster id of the pairs you want to update. 
+
+![Shows records and asks user to update yes, no, cant say on the cli.](/assets/update.gif)