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 16, 2023
1 parent d4822d7 commit 007d457
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,22 +171,43 @@ cursive = Cursive(
- `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.

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

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

##### 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
You can prepend `replicate/` to any model name and version available on Replicate.

###### Example
```python
cursive.ask(
prompt='What is the meaning of life?',
model='replicate/a16z-infra/llama-2-13b-chat:2a7f981751ec7fdf87b5b91ad4db53683a98082e9ff7bfd12c8cd5ea85980a52',
)
```

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

### vendor support
- [x] Anthropic
- [x] Cohere
- [x] Replicate
- [ ] Azure OpenAI models
- [ ] Huggingface
- [ ] Replicate
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.4.0"
version = "0.4.1"
description = ""
authors = ["Rodrigo Godinho <[email protected]>", "Henrique Cunha <[email protected]>"]
readme = "README.md"
Expand Down

0 comments on commit 007d457

Please sign in to comment.