From 007d4579e3e9230b7371be0041d561437fc73c99 Mon Sep 17 00:00:00 2001 From: henrycunh Date: Wed, 16 Aug 2023 16:48:52 -0300 Subject: [PATCH] docs: update readme --- README.md | 25 +++++++++++++++++++++++-- pyproject.toml | 2 +- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3a45be4..fcf8f08 100644 --- a/README.md +++ b/README.md @@ -171,6 +171,8 @@ 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` @@ -178,15 +180,34 @@ cursive = Cursive( - `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 diff --git a/pyproject.toml b/pyproject.toml index 456dfdf..499ca9b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "cursivepy" -version = "0.4.0" +version = "0.4.1" description = "" authors = ["Rodrigo Godinho ", "Henrique Cunha "] readme = "README.md"