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

Add cached results for AWS Bedrock Titan example in "Connecting to GenAI Models" tutorial #82

Open
rgriff23 opened this issue Jan 8, 2025 · 0 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@rgriff23
Copy link
Contributor

rgriff23 commented Jan 8, 2025

Describe the bug

The AWS Bedrock - Titan example in the Connecting to GenAI Models tutorial is missing cached results. As a result, the notebook is not reproducible for ARTKIT developers, and it will output errors if the developer attempts to run the notebook without valid AWS Bedrock credentials.

The notebook is also missing adequate explanation of how to configure your environment to use AWS credentials with the ARTKIT connector.

To Reproduce

This error impacts ARTKIT contributors in their dev environment.

Documentation notebooks should have cached results committed to the repo, ensuring contributors can reproducibly run documentation notebooks e2e without requiring credentials.

For example, we can see cached results for the Connecting the GenAI Models tutorial here: https://github.com/BCG-X-Official/artkit/tree/1.0.x/sphinx/source/user_guide/introduction_to_artkit/cache

However, the AWS Bedrock - Titan connector is missing cached results. Thus, when a developer runs the notebook in their local dev environment, it attempts to make fresh API calls. If valid AWS credentials are available, it will make the API calls and create a new cache, otherwise it will produce an error. Either way, this is undesirable.

Solution

  1. Obtain AWS Bedrock credentials
  2. Run the Titan example in this notebook locally to create cached results
  3. Commit the cached results
  4. Add instructions to the tutorial notebook for how to set up AWS credentials for use with the ARTKIT connector
@rgriff23 rgriff23 added bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant