Skip to content

Commit 0b00f69

Browse files
Update README.md
1 parent f673f40 commit 0b00f69

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,36 @@ multiple LLMs through a standardized interface. Based on the OpenAI interface st
99
makes it easy to interact with the most popular LLMs and compare the results of their chat based
1010
functionality, with support for more interfaces coming in the near future.
1111

12+
Currently supported providers are -
13+
OpenAI, Anthropic, Azure, Google, AWS, Groq, Mistral, HuggingFace and Ollama.
14+
Internally, aisuite uses either the HTTP endpoint or the SDK for making calls to the provider.
15+
1216
## Installation
1317

18+
This installs just the base package without installing any provider's SDK.
19+
1420
```shell
1521
pip install aisuite
1622
```
1723

24+
This installs anthropic along with anthropic
25+
```shell
26+
pip install aisuite[anthropic]
27+
```
28+
29+
This installs all the provider specific libraries
30+
```shell
31+
pip install aisuite[all]
32+
```
33+
1834
## Set up
1935

2036
This library provides a thin wrapper around python client libraries to interact with
2137
various Generative AI providers allowing creators to seamlessly swap out or test responses
2238
from a number of LLMs without changing their code.
2339

24-
To get started you will need the API Keys for the providers
25-
you intend to use and install the provider specific library to use.
40+
To get started you will need the API Keys for the providers you intend to use. You also need to
41+
install the provider specific library to use either separately or when installing aisuite.
2642

2743
The API Keys are expected to be in the host ENV and can be set manually or by using a tool such
2844
as [`python-dotenv`](https://pypi.org/project/python-dotenv/) or [`direnv`](https://direnv.net/).
@@ -35,12 +51,6 @@ export ANTHROPIC_API_KEY="your-anthropic-api-key"
3551
export OPENAI_API_KEY="your-openai-api-key"
3652
```
3753

38-
Install the respective client libraries:
39-
40-
```shell
41-
pip install openai anthropic
42-
```
43-
4454
In your python code:
4555

4656
```python
@@ -63,13 +73,13 @@ for model in models:
6373
print(response.choices[0].message.content)
6474

6575
```
76+
Note that the model name in the create() call needs to be replaced with `<provider>:<model-name>`
77+
aisuite will call the appropriate provider with the right parameters based on the provider value.
78+
The current list of supported providers can be found by executing `aisuite.ProviderNames.values()`
6679

6780
For more examples, check out the `examples` directory where you will find several
6881
notebooks that you can run to experiment with the interface.
6982

70-
The current list of supported providers can be found in the `aisuite.providers`
71-
package.
72-
7383
## License
7484

7585
aisuite is released under the MIT License. You are free to use, modify, and distribute

0 commit comments

Comments
 (0)