Skip to content

v0.2.49..v0.2.50 changeset score matches.asciidoc

Garret Voltz edited this page Nov 6, 2019 · 1 revision
diff --git a/docs/commands/score-matches.asciidoc b/docs/commands/score-matches.asciidoc
index 00e1828..198fee4 100644
--- a/docs/commands/score-matches.asciidoc
+++ b/docs/commands/score-matches.asciidoc
@@ -3,20 +3,21 @@
 
 === Description
 
-The +score-matches+ command scores how well conflation performs using manually matched data as a reference.  It reads from inputs,
-adds UUIDs, conflates using unify, and scores the matches. The command will return  an error if the first input file contains any
-REF2 tags or the second input file contains any REF1 tags.
+The +score-matches+ command scores how well conflation performs using manually matched data as a reference.  It validates manual matches, 
+conflates using unify, and scores the matches created during conflation against the manual matches. The command will return an error if any 
+manual match is invalid.
 
-* +input1+      - Input 1; may be any supported input format (e.g. OSM file).
-* +input2+      - Input 2; may be any supported input format (e.g. OSM file).
-* +output+      - Output file for debugging; may be any supported output format (e.g. OSM file). Only the first conflation will be output.
-* +--confusion+ - print the confusion matrix
-* +--optimize+  - optimizes the scoring function
+* +input1+            - Input 1; may be any supported input format (e.g. OSM file).
+* +input2+            - Input 2; may be any supported input format (e.g. OSM file).
+* +output+            - Output file for debugging; may be any supported output format (e.g. OSM file). Only the first conflation will be output.
+* +--confusion+       - print the confusion matrix
+* +--optimize+        - optimizes the scoring function
+* +--validation-off+  - Turns off manual match validation; recommended for debugging manual matches only
 
 === Usage
 
 --------------------------------------
-score-matches [--confusion] [--optimize] (input1 input2) [input1 input2 ...] (output)
+score-matches [--confusion] [--optimize] [--validation-off] (input1 input2) [input1 input2 ...] (output)
 --------------------------------------
 
 === See Also
Clone this wiki locally