Skip to content

Commit

Permalink
docs(README.md): update model recommendation for documentation genera…
Browse files Browse the repository at this point in the history
…tion

Strike through previous recommendations about `gpt-3.5` and `gpt-4` models due to their inconsistent results. Add new recommendation for `gpt-4-1106-preview` model as it provides the best results for documentation generation. Also, mention that the default model of JotBot is `gpt-3.5-turbo` for its cost-effectiveness.
  • Loading branch information
bounoable committed Nov 13, 2023
1 parent 93e196f commit c95d2fc
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,16 @@ projects, bridging the gap between comprehensive code and insightful documentati
~~The documentation of this repository was entirely generated by JotBot using
`gpt-4` but currently (2023/07/18) I get the best results using `gpt-3.5-turbo`.~~

OpenAI's `gpt-3.5` and `gpt-4` models demonstrate fluctuations in quality over time.
Determining which model excels at any given instance can be challenging, but `gpt-4` often yields more consistent results.
~~OpenAI's `gpt-3.5` and `gpt-4` models demonstrate fluctuations in quality over time.
Determining which model excels at any given instance can be challenging, but `gpt-4` often yields more consistent results.~~

For general applications, I recommend using `gpt-3.5-turbo-16k` as a default,
~~For general applications, I recommend using `gpt-3.5-turbo-16k` as a default,
and temporarliy switching to `gpt-4` in scenarios where `gpt-3.5` might fall
short.
short.~~

`gpt-4-1106-preview` is the best model for generating documentation so far.
The default model of JotBot is `gpt-3.5-turbo` which is gives the best value
for money.

You can find generated TypeScript documentation in [packages/jotbot](./packages/jotbot).

Expand Down

0 comments on commit c95d2fc

Please sign in to comment.