Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
henrycunh committed Aug 29, 2023
1 parent 6ddfe26 commit b21f801
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 6 deletions.
29 changes: 24 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,25 +165,33 @@ cursive = Cursive(
```

## available models
#### OpenAI
<details>
<summary><strong>OpenAI models<strong></summary>

- `gpt-3.5-turbo`
- `gpt-3.5-turbo-16k`
- `gpt-4`
- `gpt-4-32k`
- Any other chat completion model version

###### Credentials
You can pass your OpenAI API key to `Cursive`'s constructor, or set the `OPENAI_API_KEY` environment variable.
</details>

<details>
<summary><strong>Anthropic models</strong></summary>

#### Anthropic
- `claude-2`
- `claude-instant-1`
- `claude-instant-1.2`
- Any other model version

###### Credentials
You can pass your Anthropic API key to `Cursive`'s constructor, or set the `ANTHROPIC_API_KEY` environment variable.
</details>

#### OpenRouter
<details>
<summary><strong>OpenRouter models</strong></summary>

OpenRouter is a service that gives you access to leading language models in an OpenAI-compatible API, including function calling!

Expand Down Expand Up @@ -212,15 +220,22 @@ cursive.ask(
prompt="What is the meaning of life?"
)
```
</details>


<details>
<summary><strong>Cohere models</strong></summary>

#### Cohere
- `command`
- Any other model version (such as `command-nightly`)

###### Credentials
You can pass your Cohere API key to `Cursive`'s constructor, or set the `COHERE_API_KEY` environment variable.

#### Replicate
</details>

<details>
<summary><strong>Replicate models</strong></summary>
You can prepend `replicate/` to any model name and version available on Replicate.

###### Example
Expand All @@ -233,11 +248,15 @@ cursive.ask(

###### Credentials
You can pass your Replicate API key to `Cursive`'s constructor, or set the `REPLICATE_API_TOKEN` environment variable.

</details>

## roadmap

### vendor support
- [x] Anthropic
- [x] Cohere
- [x] Replicate
- [x] OpenRouter
- [ ] Azure OpenAI models
- [ ] Huggingface
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "cursivepy"
version = "0.6.0"
version = "0.6.1"
description = ""
authors = [
"Rodrigo Godinho <[email protected]>",
Expand Down

0 comments on commit b21f801

Please sign in to comment.