Skip to content

Commit e7a07af

Browse files
committed
docs: update GroqCloud model documentation and links
- Minor formatting changes in the README.md file - Update description for GroqCloud-supported models - Replace specific model list with links to production and preview models on GroqCloud Signed-off-by: Bo-Yi Wu <[email protected]>
1 parent fc8a7d5 commit e7a07af

File tree

1 file changed

+24
-32
lines changed

1 file changed

+24
-32
lines changed

README.md

Lines changed: 24 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,25 @@
88

99
A CLI written in [Go](https://go.dev) that writes git commit messages or provides a code review summary for you using ChatGPT AI (gpt-3.5-turbo, gpt-4 model) and automatically installs a [git prepare-commit-msg hook](https://git-scm.com/docs/githooks).
1010

11-
* [繁體中文介紹][1]
12-
* [繁體中文影片][2]
11+
- [繁體中文介紹][1]
12+
- [繁體中文影片][2]
1313

14-
[1]:https://blog.wu-boy.com/2023/03/writes-git-commit-messages-using-chatgpt/
15-
[2]:https://www.youtube.com/watch?v=4Yei_t6eMZU
14+
[1]: https://blog.wu-boy.com/2023/03/writes-git-commit-messages-using-chatgpt/
15+
[2]: https://www.youtube.com/watch?v=4Yei_t6eMZU
1616

1717
![flow](./images/flow.svg)
1818

1919
## Features
2020

21-
* Supports [Azure OpenAI Service](https://azure.microsoft.com/en-us/products/cognitive-services/openai-service), [OpenAI API](https://platform.openai.com/docs/api-reference), [Gemini][60], [Ollama][41], [Groq][30], and [OpenRouter][50].
22-
* Supports [conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0/).
23-
* Supports Git prepare-commit-msg Hook, see the [Git Hooks documentation](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks).
24-
* Supports customizing generated diffs with n lines of context, the default is three.
25-
* Supports excluding files from the git diff command.
26-
* Supports commit message translation into another language (supports `en`, `zh-tw`, or `zh-cn`).
27-
* Supports socks proxy or custom network HTTP proxy.
28-
* Supports [model lists](https://github.com/appleboy/CodeGPT/blob/bf28f000463cfc6dfa2572df61e1b160c5c680f7/openai/openai.go#L18-L38) like `gpt-4`, `gpt-3.5-turbo`, etc.
29-
* Supports generating a brief code review.
21+
- Supports [Azure OpenAI Service](https://azure.microsoft.com/en-us/products/cognitive-services/openai-service), [OpenAI API](https://platform.openai.com/docs/api-reference), [Gemini][60], [Ollama][41], [Groq][30], and [OpenRouter][50].
22+
- Supports [conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0/).
23+
- Supports Git prepare-commit-msg Hook, see the [Git Hooks documentation](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks).
24+
- Supports customizing generated diffs with n lines of context, the default is three.
25+
- Supports excluding files from the git diff command.
26+
- Supports commit message translation into another language (supports `en`, `zh-tw`, or `zh-cn`).
27+
- Supports socks proxy or custom network HTTP proxy.
28+
- Supports [model lists](https://github.com/appleboy/CodeGPT/blob/bf28f000463cfc6dfa2572df61e1b160c5c680f7/openai/openai.go#L18-L38) like `gpt-4`, `gpt-3.5-turbo`, etc.
29+
- Supports generating a brief code review.
3030

3131
![code review](./images/code_review.png)
3232

@@ -141,18 +141,10 @@ codegpt config set openai.api_key gsk_xxxxxxxxxxxxxx
141141
codegpt config set openai.model llama3-8b-8192
142142
```
143143

144-
Support the [following models][32]:
144+
GroqCloud currently supports the [following models][32]:
145145

146-
1. `llama-3.1-8b-instant` (Meta)
147-
2. `llama-3.1-70b-versatile` (Meta)
148-
3. `llama-3.1-405b-reasoning` (Meta)
149-
4. `llama3-8b-8192` (Meta)
150-
5. `llama3-70b-8192` (Meta)
151-
6. `llama3-groq-8b-8192-tool-use-preview`
152-
7. `llama3-groq-70b-8192-tool-use-preview`
153-
8. `mixtral-8x7b-32768` (Mistral)
154-
9. `gemma2-9b-it` (Google)
155-
10. `gemma-7b-it` (Google)
146+
1. [Production Models](https://console.groq.com/docs/models#production-models)
147+
2. [Preview Models](https://console.groq.com/docs/models#preview-models)
156148

157149
[30]: https://groq.com/
158150
[31]: https://console.groq.com/keys
@@ -206,19 +198,19 @@ codegpt config set openai.api_key sk-or-v1-xxxxxxxxxxxxxxxx
206198
codegpt config set openai.model google/learnlm-1.5-pro-experimental:free
207199
```
208200

209-
[50]:https://openrouter.ai/
210-
[51]:https://openrouter.ai/docs#models
211-
[52]:https://openrouter.ai/terms#services
212-
[53]:https://openrouter.ai/api/v1/models
201+
[50]: https://openrouter.ai/
202+
[51]: https://openrouter.ai/docs#models
203+
[52]: https://openrouter.ai/terms#services
204+
[53]: https://openrouter.ai/api/v1/models
213205

214206
For including your app on openrouter.ai rankings and Shows in rankings on openrouter.ai, you can set the `openai.headers` in your config file.
215207

216208
```sh
217209
codegpt config set openai.headers "HTTP-Referer=https://github.com/appleboy/CodeGPT X-Title=CodeGPT"
218210
```
219211

220-
* **HTTP-Refer**: Optional, for including your app on openrouter.ai rankings.
221-
* **X-Title**: Optional, for Shows in rankings on openrouter.ai.
212+
- **HTTP-Refer**: Optional, for including your app on openrouter.ai rankings.
213+
- **X-Title**: Optional, for Shows in rankings on openrouter.ai.
222214

223215
## Usage
224216

@@ -472,5 +464,5 @@ make test
472464
473465
## Reference
474466
475-
* [OpenAI Chat completions documentation](https://platform.openai.com/docs/guides/chat).
476-
* [Introducing ChatGPT and Whisper APIs](https://openai.com/blog/introducing-chatgpt-and-whisper-apis)
467+
- [OpenAI Chat completions documentation](https://platform.openai.com/docs/guides/chat).
468+
- [Introducing ChatGPT and Whisper APIs](https://openai.com/blog/introducing-chatgpt-and-whisper-apis)

0 commit comments

Comments
 (0)