kj7rrv/gptc
1
0
Fork 0
Code Issues 2 Pull Requests Projects Releases 12 Wiki Activity

Fix README issues

Browse Source
This commit is contained in:
Samuel Sloniker 2022-11-26 16:45:30 -08:00
parent 448f200923
commit 30287288f2
Signed by: kj7rrv
GPG Key ID: 1BB4029E66285A62
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -73,7 +73,7 @@ For information about `max_ngram_length`, see section "Ngrams."
Words or ngrams used less than `min_count` times throughout the input text are Words or ngrams used less than `min_count` times throughout the input text are
excluded from the model. excluded from the model.
### `gptc.pack(directory, print_exceptions=False) ### `gptc.pack(directory, print_exceptions=False)`
Pack the model in `directory` and return a tuple of the format: Pack the model in `directory` and return a tuple of the format:
@ -111,7 +111,8 @@ reduced to the one used when compiling the model.
## Model format ## Model format
This section explains the raw model format, which is how models are created and edited. This section explains the raw model format, which is how models are created and
edited.
Raw models are formatted as a list of dicts. See below for the format: Raw models are formatted as a list of dicts. See below for the format:
@ -122,9 +123,10 @@ Raw models are formatted as a list of dicts. See below for the format:
} }
] ]
GPTC handles raw models as `list`s of `dict`s of `str`s (`List[Dict[str, str]]`), and they can be stored GPTC handles raw models as `list`s of `dict`s of `str`s (`List[Dict[str,
in any way these Python objects can be. However, it is recommended to store str]]`), and they can be stored in any way these Python objects can be.
them in JSON format for compatibility with the command-line tool. However, it is recommended to store them in JSON format for compatibility with
the command-line tool.
## Emoji ## Emoji