Skip to content
This repository has been archived by the owner on Apr 16, 2024. It is now read-only.

Update docs for new config classes #218

Merged
merged 14 commits into from
Feb 28, 2024
Merged

Update docs for new config classes #218

merged 14 commits into from
Feb 28, 2024

Conversation

collindutter
Copy link
Member

@collindutter collindutter commented Feb 16, 2024


📚 Documentation preview 📚: https://griptape--218.org.readthedocs.build//218/

@collindutter collindutter requested review from andrewfrench and a team February 16, 2024 21:35
@collindutter collindutter marked this pull request as ready for review February 28, 2024 16:58
@collindutter
Copy link
Member Author

Should definitely merge in the other PRs first.

@collindutter collindutter changed the base branch from dev to main February 28, 2024 17:55
@collindutter collindutter changed the base branch from main to dev February 28, 2024 17:55
@collindutter collindutter force-pushed the feature/config branch 2 times, most recently from 07537cf to ddc4af6 Compare February 28, 2024 18:29
Copy link
Member

@andrewfrench andrewfrench left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nits

docs/griptape-framework/structures/config.md Outdated Show resolved Hide resolved
docs/griptape-framework/structures/config.md Outdated Show resolved Hide resolved
@andrewfrench
Copy link
Member

The Marqo test error is annoying flakiness we'll have to contend with at some points, but the other failures seem legit to me.

@collindutter collindutter merged commit 85a0d8d into dev Feb 28, 2024
1 of 2 checks passed
@collindutter collindutter deleted the feature/config branch February 28, 2024 21:58
collindutter added a commit that referenced this pull request Feb 29, 2024
* Multi-agent shared vector database (#202)

* add example

* create env variables

* add md file

* Update pull-request-links.yml

* testing action

* testing action

* testing action

* testing action

* action works

* PR updates

* update to shared memory

* vectors

* Remove reference to `create_index()` for `VectorStoreDriver`s (#205)

* remove reference to create_index()

* Update image tool documentation for task memory support (#206)

* Update ImageLoader interface (#208)

* Add example mappings for Amazon OpenSearch index creation (#209)

* Add example mappings for Amazon OpenSearch index creation

* Removed carryover comment

* Refactor header structure, fix a couple headings (#211)

* Fix marqo query example (#214)

* Fix directory structure to match new layout (#215)

* Updated ToS (#213)

* Updated Terms of Service

Added instructions for generating from .docx with Pandoc

* Updated Terms of Service

Added instructions for generating from .docx with Pandoc

* Switch to rtf format

* Fix pandoc errors

* More pandoc errors

Maybe Pandox was a bad idea

* Hack to exclude code snippets from pytest (#216)

* Run integration tests on PRs (#217)

* Run integration tests on PRs

* Fix env vars

* Update deps

* Update readthedocs build def (#223)

* Fix integration tests (#220)

* Run integration tests on PRs

* Fix env vars

* Fix some examples

* test code blocks in specific path/file with CODE_PATH env var

* update engine tests to define prompt driver

* Fix test failures in vector store drivers

* Fix task memory example execution

* Fix tasks example execution

* Update prompt driver

* Update env var thing

* Add pgvector service container

* Wire up pgvector vars

* save workflow config

* Replicate .csv assets locally

* Test workflow updates

* Update dependencies

* Update workflow

* Update spec

* Widen test scope to all integration tests

* misc and example fixes

* Remove dev dependency

* wire env var

---------

Co-authored-by: Andrew French <[email protected]>

* Add Image Query docs (#219)

* Update docs for new config classes (#218)

* Update docs for new config classes

* Fix links

* Revert poetry lock to main

* Remove docs gruop

* Ignore assets

* Update env

* Update config

* Add back assets

* Revert poetry

* Revert group

* Regerate lock file

* Regenerate lockfile

* Fixes

* Fix tests

* Version bump v0.23.0

---------

Co-authored-by: Matt Vallillo <[email protected]>
Co-authored-by: Collin Dutter <[email protected]>
Co-authored-by: cjkindel <[email protected]>
collindutter added a commit that referenced this pull request Mar 27, 2024
* Multi-agent shared vector database (#202)

* add example

* create env variables

* add md file

* Update pull-request-links.yml

* testing action

* testing action

* testing action

* testing action

* action works

* PR updates

* update to shared memory

* vectors

* Remove reference to `create_index()` for `VectorStoreDriver`s (#205)

* remove reference to create_index()

* Update image tool documentation for task memory support (#206)

* Update ImageLoader interface (#208)

* Add example mappings for Amazon OpenSearch index creation (#209)

* Add example mappings for Amazon OpenSearch index creation

* Removed carryover comment

* Refactor header structure, fix a couple headings (#211)

* Fix marqo query example (#214)

* Fix directory structure to match new layout (#215)

* Updated ToS (#213)

* Updated Terms of Service

Added instructions for generating from .docx with Pandoc

* Updated Terms of Service

Added instructions for generating from .docx with Pandoc

* Switch to rtf format

* Fix pandoc errors

* More pandoc errors

Maybe Pandox was a bad idea

* Hack to exclude code snippets from pytest (#216)

* Run integration tests on PRs (#217)

* Run integration tests on PRs

* Fix env vars

* Update deps

* Update readthedocs build def (#223)

* Fix integration tests (#220)

* Run integration tests on PRs

* Fix env vars

* Fix some examples

* test code blocks in specific path/file with CODE_PATH env var

* update engine tests to define prompt driver

* Fix test failures in vector store drivers

* Fix task memory example execution

* Fix tasks example execution

* Update prompt driver

* Update env var thing

* Add pgvector service container

* Wire up pgvector vars

* save workflow config

* Replicate .csv assets locally

* Test workflow updates

* Update dependencies

* Update workflow

* Update spec

* Widen test scope to all integration tests

* misc and example fixes

* Remove dev dependency

* wire env var

---------

Co-authored-by: Andrew French <[email protected]>

* Add Image Query docs (#219)

* Update docs for new config classes (#218)

* Update docs for new config classes

* Fix links

* Revert poetry lock to main

* Remove docs gruop

* Ignore assets

* Update env

* Update config

* Add back assets

* Revert poetry

* Revert group

* Regerate lock file

* Regenerate lockfile

* Fixes

* Fix tests

* Update docs for loader extras (#210)

* Update docs for loader extras

* Add extras to loaders, add missing loader docs

* Remove cloud links (#225)

* Add Image Query Task docs (#226)

* Remove references to default tokenizers (#212)

* Update test deps (#233)

* Update test deps

* Fix tokenizer examples

* Update simple tokenizer

* Fix missing args

* Update lock

* Fix import

* Fix missing models

* Ignore marqo

* Fix model names

* Add docs for voyageai (#230)

* Add docs for voyageai

* Fix example, add key

* Fix key

* Regenerate lock

* Add docs for gemini (#231)

* Add docs for gemini

* Fix reference links

* Claude 3 image query docs (#234)

* adding anthropic and bedrock image query docs

* updating max_token name

* fixing typo

* updating to remove openai default model for image query driver

* updated wording

* updating path for image file

* docs: max_tokens documentation for vision

* updating engines page for max_tokens specification

---------

Co-authored-by: Michael Bianco <[email protected]>

* Add web scraper driver docs (#227)

* Update docs for Anthropic (#229)

* Update docs for Anthropic

* Link to example of overriding

* Update link

* Fix url

* Update deps

* Version bump v0.24.0

* Update poetry.lock

---------

Co-authored-by: Matt Vallillo <[email protected]>
Co-authored-by: Andrew French <[email protected]>
Co-authored-by: Collin Dutter <[email protected]>
Co-authored-by: Zach Giordano <[email protected]>
Co-authored-by: Emily Danielson <[email protected]>
Co-authored-by: Michael Bianco <[email protected]>
Co-authored-by: dylanholmes <[email protected]>
collindutter added a commit that referenced this pull request Mar 27, 2024
* Release version v0.23.0 (#224)

* Multi-agent shared vector database (#202)

* add example

* create env variables

* add md file

* Update pull-request-links.yml

* testing action

* testing action

* testing action

* testing action

* action works

* PR updates

* update to shared memory

* vectors

* Remove reference to `create_index()` for `VectorStoreDriver`s (#205)

* remove reference to create_index()

* Update image tool documentation for task memory support (#206)

* Update ImageLoader interface (#208)

* Add example mappings for Amazon OpenSearch index creation (#209)

* Add example mappings for Amazon OpenSearch index creation

* Removed carryover comment

* Refactor header structure, fix a couple headings (#211)

* Fix marqo query example (#214)

* Fix directory structure to match new layout (#215)

* Updated ToS (#213)

* Updated Terms of Service

Added instructions for generating from .docx with Pandoc

* Updated Terms of Service

Added instructions for generating from .docx with Pandoc

* Switch to rtf format

* Fix pandoc errors

* More pandoc errors

Maybe Pandox was a bad idea

* Hack to exclude code snippets from pytest (#216)

* Run integration tests on PRs (#217)

* Run integration tests on PRs

* Fix env vars

* Update deps

* Update readthedocs build def (#223)

* Fix integration tests (#220)

* Run integration tests on PRs

* Fix env vars

* Fix some examples

* test code blocks in specific path/file with CODE_PATH env var

* update engine tests to define prompt driver

* Fix test failures in vector store drivers

* Fix task memory example execution

* Fix tasks example execution

* Update prompt driver

* Update env var thing

* Add pgvector service container

* Wire up pgvector vars

* save workflow config

* Replicate .csv assets locally

* Test workflow updates

* Update dependencies

* Update workflow

* Update spec

* Widen test scope to all integration tests

* misc and example fixes

* Remove dev dependency

* wire env var

---------

Co-authored-by: Andrew French <[email protected]>

* Add Image Query docs (#219)

* Update docs for new config classes (#218)

* Update docs for new config classes

* Fix links

* Revert poetry lock to main

* Remove docs gruop

* Ignore assets

* Update env

* Update config

* Add back assets

* Revert poetry

* Revert group

* Regerate lock file

* Regenerate lockfile

* Fixes

* Fix tests

* Version bump v0.23.0

---------

Co-authored-by: Matt Vallillo <[email protected]>
Co-authored-by: Collin Dutter <[email protected]>
Co-authored-by: cjkindel <[email protected]>

* Version bump v0.24.0 (#237)

* Multi-agent shared vector database (#202)

* add example

* create env variables

* add md file

* Update pull-request-links.yml

* testing action

* testing action

* testing action

* testing action

* action works

* PR updates

* update to shared memory

* vectors

* Remove reference to `create_index()` for `VectorStoreDriver`s (#205)

* remove reference to create_index()

* Update image tool documentation for task memory support (#206)

* Update ImageLoader interface (#208)

* Add example mappings for Amazon OpenSearch index creation (#209)

* Add example mappings for Amazon OpenSearch index creation

* Removed carryover comment

* Refactor header structure, fix a couple headings (#211)

* Fix marqo query example (#214)

* Fix directory structure to match new layout (#215)

* Updated ToS (#213)

* Updated Terms of Service

Added instructions for generating from .docx with Pandoc

* Updated Terms of Service

Added instructions for generating from .docx with Pandoc

* Switch to rtf format

* Fix pandoc errors

* More pandoc errors

Maybe Pandox was a bad idea

* Hack to exclude code snippets from pytest (#216)

* Run integration tests on PRs (#217)

* Run integration tests on PRs

* Fix env vars

* Update deps

* Update readthedocs build def (#223)

* Fix integration tests (#220)

* Run integration tests on PRs

* Fix env vars

* Fix some examples

* test code blocks in specific path/file with CODE_PATH env var

* update engine tests to define prompt driver

* Fix test failures in vector store drivers

* Fix task memory example execution

* Fix tasks example execution

* Update prompt driver

* Update env var thing

* Add pgvector service container

* Wire up pgvector vars

* save workflow config

* Replicate .csv assets locally

* Test workflow updates

* Update dependencies

* Update workflow

* Update spec

* Widen test scope to all integration tests

* misc and example fixes

* Remove dev dependency

* wire env var

---------

Co-authored-by: Andrew French <[email protected]>

* Add Image Query docs (#219)

* Update docs for new config classes (#218)

* Update docs for new config classes

* Fix links

* Revert poetry lock to main

* Remove docs gruop

* Ignore assets

* Update env

* Update config

* Add back assets

* Revert poetry

* Revert group

* Regerate lock file

* Regenerate lockfile

* Fixes

* Fix tests

* Update docs for loader extras (#210)

* Update docs for loader extras

* Add extras to loaders, add missing loader docs

* Remove cloud links (#225)

* Add Image Query Task docs (#226)

* Remove references to default tokenizers (#212)

* Update test deps (#233)

* Update test deps

* Fix tokenizer examples

* Update simple tokenizer

* Fix missing args

* Update lock

* Fix import

* Fix missing models

* Ignore marqo

* Fix model names

* Add docs for voyageai (#230)

* Add docs for voyageai

* Fix example, add key

* Fix key

* Regenerate lock

* Add docs for gemini (#231)

* Add docs for gemini

* Fix reference links

* Claude 3 image query docs (#234)

* adding anthropic and bedrock image query docs

* updating max_token name

* fixing typo

* updating to remove openai default model for image query driver

* updated wording

* updating path for image file

* docs: max_tokens documentation for vision

* updating engines page for max_tokens specification

---------

Co-authored-by: Michael Bianco <[email protected]>

* Add web scraper driver docs (#227)

* Update docs for Anthropic (#229)

* Update docs for Anthropic

* Link to example of overriding

* Update link

* Fix url

* Update deps

* Version bump v0.24.0

* Update poetry.lock

---------

Co-authored-by: Matt Vallillo <[email protected]>
Co-authored-by: Andrew French <[email protected]>
Co-authored-by: Collin Dutter <[email protected]>
Co-authored-by: Zach Giordano <[email protected]>
Co-authored-by: Emily Danielson <[email protected]>
Co-authored-by: Michael Bianco <[email protected]>
Co-authored-by: dylanholmes <[email protected]>

---------

Co-authored-by: Andrew French <[email protected]>
Co-authored-by: Matt Vallillo <[email protected]>
Co-authored-by: Collin Dutter <[email protected]>
Co-authored-by: Zach Giordano <[email protected]>
Co-authored-by: Emily Danielson <[email protected]>
Co-authored-by: Michael Bianco <[email protected]>
Co-authored-by: dylanholmes <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants