Update 'README.md'

This commit is contained in:
Samuel Sloniker 2022-04-02 11:11:04 -07:00
parent 34af3a8a0a
commit 75bae768b6

View File

@ -6,21 +6,21 @@ GPTC provides both a CLI tool and a Python library.
## CLI Tool ## CLI Tool
### Classifying text ### Classifying text
`python -m gptc <modelfile>` python -m gptc <modelfile>
This will prompt for a string and classify it, outputting the category on This will prompt for a string and classify it, outputting the category on
stdout (or "None" if it cannot determine anything). stdout (or "None" if it cannot determine anything).
Alternatively, if you need confidence data, use: Alternatively, if you need confidence data, use:
`python -m gptc -j <modelfile>` python -m gptc -j <modelfile>
This will print (in JSON) a dict of the format `{category: probability, This will print (in JSON) a dict of the format `{category: probability,
category:probability, ...}` to stdout. category:probability, ...}` to stdout.
### Compiling models ### Compiling models
gptc <raw model file> -c|--compile <compiled model file> python -m gptc <raw model file> -c|--compile <compiled model file>
## Library ## Library
### `gptc.Classifier(model)` ### `gptc.Classifier(model)`