aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Czygan <martin.czygan@gmail.com>2020-11-05 17:22:46 +0100
committerMartin Czygan <martin.czygan@gmail.com>2020-11-05 17:22:46 +0100
commit5c4711b4546fc2a6e679cb68dc75b2d64f6996af (patch)
treefeaf21b9d7121978ca3c1fd8a6b751988952822e
parentb3212a4bf5d0a5b21cc5f4abae9acce5f7acddbc (diff)
downloadfuzzycat-5c4711b4546fc2a6e679cb68dc75b2d64f6996af.tar.gz
fuzzycat-5c4711b4546fc2a6e679cb68dc75b2d64f6996af.zip
update README
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
index fec6dd0..805d1d9 100644
--- a/README.md
+++ b/README.md
@@ -51,3 +51,27 @@ $ cat data/sample.json | parallel -j 8 --pipe --roundrobin python -m fuzzycat.ma
Interestingly, the parallel variants detects fewer clusters (because data is
split and clusters are searched within each batch).
+
+
+## Cluster
+
+```shell
+usage: fuzzycat command [options] cluster [-h] [--prefix PREFIX]
+ [--tmpdir TMPDIR] [-P] [-f FILES]
+ [-t TYPE]
+ {cluster,verify} ...
+
+positional arguments:
+ {cluster,verify}
+ cluster group entities
+ verify verify groups
+
+optional arguments:
+ -h, --help show this help message and exit
+ --prefix PREFIX temp file prefix
+ --tmpdir TMPDIR temporary directory
+ -P, --profile profile program
+ -f FILES, --files FILES
+ output files
+ -t TYPE, --type TYPE cluster algorithm: title, tnorm, tnysi
+```