diff --git a/README.md b/README.md index 5dbd51a627..3f2da28d73 100644 --- a/README.md +++ b/README.md @@ -31,18 +31,33 @@ Install dependencies for [`openai.embeddings_utils`](openai/embeddings_utils.py) pip install openai[embeddings] ``` +If you receive an error message stating: _no matches found: openai[embeddings]_, try running: +```sh +pip install openai"[embeddings]" +``` + Install support for [Weights & Biases](https://wandb.me/openai-docs): ``` pip install openai[wandb] ``` +If you receive an error message stating: _no matches found: openai[wandb]_, try running: +```sh +pip install openai"[wandb]" +``` + Data libraries like `numpy` and `pandas` are not installed by default due to their size. They’re needed for some functionality of this library, but generally not for talking to the API. If you encounter a `MissingDependencyError`, install them with: ```sh pip install openai[datalib] ```` +If you receive an error message stating: _no matches found: openai[datalib]_, try running: +```sh +pip install openai"[datalib]" +``` + ## Usage The library needs to be configured with your account's secret key which is available on the [website](https://platform.openai.com/account/api-keys). Either set it as the `OPENAI_API_KEY` environment variable before using the library: @@ -267,7 +282,7 @@ async def create_completion(): ``` To make async requests more efficient, you can pass in your own -``aiohttp.ClientSession``, but you must manually close the client session at the end +``aiohttp.ClientSession``, but you must manually close the client session at the end of your program/event loop: ```python