From ebf22e69cd9a7005d09eb196378fe57d4525adbe Mon Sep 17 00:00:00 2001 From: Sjur N Moshagen Date: Sun, 5 May 2024 22:40:07 +0300 Subject: [PATCH] Update usage text Fixes #36 --- README.md | 49 +++++++++++++++++++++++++------------------------ 1 file changed, 25 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 202b6aa..702dfaf 100644 --- a/README.md +++ b/README.md @@ -38,30 +38,31 @@ cargo build --release ### divvunspell Usage: -``` -divvunspell 0.5.0 -Testing frontend for the Divvunspell library - -USAGE: - divvunspell [FLAGS] [OPTIONS] <--zhfst |--bhfst |--acceptor > [WORDS]... - -FLAGS: - -S, --always-suggest Always show suggestions even if word is correct (implies -s) - -h, --help Prints help information - --json Output results in JSON - -s, --suggest Show suggestions for given word(s) - -V, --version Prints version information - -OPTIONS: - --acceptor Use the given acceptor file - -b, --bhfst Use the given BHFST file - --errmodel Use the given errmodel file - -n, --nbest Maximum number of results for suggestions - -w, --weight Maximum weight limit for suggestions - -z, --zhfst Use the given ZHFST file - -ARGS: - ... The words to be processed +```sh +Usage: divvunspell SUBCOMMAND [OPTIONS] + +Optional arguments: + -h, --help print help message + +Available subcommands: + suggest get suggestions for provided input + tokenize print input in word-separated tokenized form + predict predict next words using GPT2 model + +$ divvunspell suggest -h +Usage: divvunspell suggest [OPTIONS] + +Positional arguments: + inputs words to be processed + +Optional arguments: + -h, --help print help message + -a, --archive ARCHIVE BHFST or ZHFST archive to be used + -S, --always-suggest always show suggestions even if word is correct + -w, --weight WEIGHT maximum weight limit for suggestions + -n, --nbest NBEST maximum number of results + --no-case-handling disables case-handling algorithm (makes results more like hfst-ospell) + --json output in JSON format ``` ### accuracy