Docs: try to make model options / model install methods clearer #1806
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Primary goal: make it easy to -- from the "Quick start" section -- get info about models by following a link to
./models/README.md
, and then quickly find answers to some basic questions about the various models, i.e. the meaning of.en
,-q5_0
, &-tdrz
. And link upstream (to openai/whisper) to see their info on the various models.Related issues: #1396, #1076
Aside: Noticed some inconsistencies along the way, I can back those changes out and put them in a different PR if they make this PR too unwieldy to review.
ggml
was most often wrapped in backticks, but not always, fixed that..md
files), as non-hard-wrapped seemed to be the convention.bash
,text
(for mixture of shell input & output), orpowershell
, primarily in place ofjava
or non-specified.*
bullets to-
(which was already most often the case), changing[X]
checkmarks to[x]
(this was a toss-up, it was 50/50 before, but at least now the default VS Code Markdown formatter won't try to change them?). There were a few changes Prettier made that I backed out, e.g. changing*
for italics to_
.$
shell prompts, for consistency (was at 4/8, now 8/8, unless I missed some).//
comment to a#
comment (in a Bash code block), per convention.Actual changes of substance:
./README.md
:Before: README.md#quick-start
After: README.md#quick-start
Minor clean-up of "Quick start" instructions. Mostly wanted to make it obvious where to go to learn about the available models (
./models/README.md
)../models/README.md
:Before: models/README.md
After: models/README.md
./models/download-ggml-model.sh
:Before: models/download-ggml-model.sh
After: models/download-ggml-model.sh
./models/README.md
, e.g.tiny
beforetiny.en
.large-v2-q5_0
to the list.Bash usage output, before (screenshot is 80 characters wide, 4 lines wrapping to 7 lines):
Bash usage output, after (screenshot is 80 characters wide, 11 lines, no wrapping):
Remaining questions
Edit: moved my remaining questions to a new issue: #1807