From b21f8016297abb5bae0bb7fd7f8d3ab323fd9948 Mon Sep 17 00:00:00 2001 From: henrycunh Date: Tue, 29 Aug 2023 11:09:30 -0300 Subject: [PATCH] docs: update readme --- README.md | 29 ++++++++++++++++++++++++----- pyproject.toml | 2 +- 2 files changed, 25 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4f61f23..e009038 100644 --- a/README.md +++ b/README.md @@ -165,16 +165,22 @@ cursive = Cursive( ``` ## available models -#### OpenAI +
+OpenAI models + - `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. +
+ +
+Anthropic models -#### Anthropic - `claude-2` - `claude-instant-1` - `claude-instant-1.2` @@ -182,8 +188,10 @@ You can pass your OpenAI API key to `Cursive`'s constructor, or set the `OPENAI_ ###### Credentials You can pass your Anthropic API key to `Cursive`'s constructor, or set the `ANTHROPIC_API_KEY` environment variable. +
-#### OpenRouter +
+OpenRouter models OpenRouter is a service that gives you access to leading language models in an OpenAI-compatible API, including function calling! @@ -212,15 +220,22 @@ cursive.ask( prompt="What is the meaning of life?" ) ``` +
+ + +
+Cohere models -#### 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 +
+ +
+Replicate models You can prepend `replicate/` to any model name and version available on Replicate. ###### Example @@ -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. + +
+ ## roadmap ### vendor support - [x] Anthropic - [x] Cohere - [x] Replicate +- [x] OpenRouter - [ ] Azure OpenAI models - [ ] Huggingface diff --git a/pyproject.toml b/pyproject.toml index e8ed2af..52f5fb2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "cursivepy" -version = "0.6.0" +version = "0.6.1" description = "" authors = [ "Rodrigo Godinho ",