Readme shorted. Docs referenced #465
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jakethekoenig
commented
Jan 10, 2024
| @@ -173,4 +89,4 @@ The goal for Mentat is to become the best way to write code. Some big improvemen | |||
|
|
|||
| If this is something you'd like to work on, jump right in! And if you want to join the team to work on this full time, message [@bio_bootloader](https://twitter.com/bio_bootloader) on twitter. | |||
|
|
|||
| To find something specific to work on, take a look at [open issues](https://github.com/AbanteAI/mentat/issues) and/or check this Github Project: [Mentat Development](https://github.com/users/biobootloader/projects/2) | |||
| To find something specific to work on, take a look at [open issues](https://github.com/AbanteAI/mentat/issues). | |||
There was a problem hiding this comment.
It doesn't seem like we really use the project so I thought it was better to remove the link.
PCSwingle
reviewed
Jan 10, 2024
README.md
Outdated
| ## Selecting which LLM Model to use | ||
|
|
||
| We highly recommend using the default model, `gpt-4-1106-preview`, as it performs vastly better than any other model benchmarked so far. However, if you wish to use a different model, jump [here](#alternative-models). | ||
|
|
||
| ### Add your OpenAI API Key | ||
|
|
||
| You'll need to have API access to GPT-4 to run Mentat. There are a few options to provide Mentat with your OpenAI API key: |
There was a problem hiding this comment.
Maybe this should be changed; everybody has gpt-4 access now, and it isn't even necessary anymore.
PCSwingle
reviewed
Jan 10, 2024
| @@ -70,66 +67,6 @@ You'll need to have API access to GPT-4 to run Mentat. There are a few options t | |||
| 2. Run `export OPENAI_API_KEY=<your key here>` prior to running Mentat | |||
| 3. Place the previous command in your `.bashrc` or `.zshrc` to export your key on every terminal startup | |||
|
|
|||
| ### Azure OpenAI | |||
There was a problem hiding this comment.
Is any of this information anywhere else? I think it's important to keep somewhere
There was a problem hiding this comment.
It should all be here: https://docs.mentat.ai/en/latest/user/alternative_models.html
There was a problem hiding this comment.
Could we link here here? I think it's important that it's easy for people to find the docs for alternative models
biobootloader
approved these changes
Jan 10, 2024
| @@ -1,5 +1,6 @@ | |||
| [](https://twitter.com/bio_bootloader) | |||
There was a problem hiding this comment.
Suggested change
| [](https://twitter.com/bio_bootloader) | |
| [](https://twitter.com/AbanteAI) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Pull Request Checklist