From 30287288f231d990fc08feb9b4c646ba703b063d Mon Sep 17 00:00:00 2001 From: Samuel Sloniker Date: Sat, 26 Nov 2022 16:45:30 -0800 Subject: [PATCH] Fix README issues --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c64ae33..d000ff0 100644 --- a/README.md +++ b/README.md @@ -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 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: @@ -111,7 +111,8 @@ reduced to the one used when compiling the model. ## 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: @@ -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 -in any way these Python objects can be. However, it is recommended to store -them in JSON format for compatibility with the command-line tool. +GPTC handles raw models as `list`s of `dict`s of `str`s (`List[Dict[str, +str]]`), and they can be stored in any way these Python objects can be. +However, it is recommended to store them in JSON format for compatibility with +the command-line tool. ## Emoji