Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs for extras #770

Merged
merged 2 commits into from
May 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ Tools provide capabilities for LLMs to interact with data and services. Griptape

Drivers facilitate interactions with external resources and services:

- 🔢 **Prompt and Embedding Drivers** generate vector embeddings from textual inputs.
- 🗣️ **Prompt Drivers** manage textual interactions with LLMs.
- 🔢 **Embedding Drivers** generate vector embeddings from textual inputs.
- 💾 **Vector Store Drivers** manage the storage and retrieval of embeddings.
- 🎨 **Image Generation Drivers** create images from text descriptions.
- 🔎 **Image Query Drivers** query images from text queries.
Expand Down
6 changes: 3 additions & 3 deletions docs/griptape-framework/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ By default, Griptape uses [OpenAI Completions API](https://platform.openai.com/d
Install **griptape**:

```
pip install griptape[all] -U
pip install "griptape[all]" -U
```

### Using Poetry
Expand All @@ -36,7 +36,7 @@ poetry new griptape-quickstart
Change your working directory to the new `griptape-quickstart` directory created by Poetry and add the the `griptape` dependency.

```
poetry add griptape[all]
poetry add "griptape[all]"
```

### Extras
Expand All @@ -56,7 +56,7 @@ poetry add griptape

To install specific extras (e.g., drivers for [AnthropicPromptDriver](./drivers/prompt-drivers.md#anthropic) and [PineconeVectorStoreDriver](./drivers/vector-store-drivers.md#pinecone)):
```
poetry add griptape[drivers-prompt-anthropic,drivers-vector-pinecone]
poetry add "griptape[drivers-prompt-anthropic,drivers-vector-pinecone]"
```

For a comprehensive list of extras, please refer to the `[tool.poetry.extras]` section of Griptape's [pyproject.toml](https://github.com/griptape-ai/griptape/blob/main/pyproject.toml).
Expand Down
Loading