Skip to content

BeeAI Framework Workshop: Prework Instructions

Welcome to the BeeAI Framework Workshop, in partnership with Tavily and Redis.
Please complete the following setup steps before the workshop.

Development Environment

You may use any IDE, but this workshop assumes you're using Visual Studio Code (VS Code).

  • Download Visual Studio Code (VS Code)

  • Install the VS Code Python and Jupyter extensions from the Extensions Marketplace:

    1. Open the Extensions view in VS Code (Ctrl+Shift+X or Cmd+Shift+X)
    2. Search for “Python” by Microsoft and install it
    3. Search for "Jupyter" by Microsoft and install it

Python Environment Manager

We recommend using uv as your Python package and environment manager.

  • If you’re unfamiliar with uv, refer to the uv installation guide
  • uv is a fast and modern alternative to pip and virtualenv, fully compatible with both

API Keys

Tavily (Required)

  • Go to Tavily and sign up for a free API key.

Redis as a vector database (Required)

We'll be using Redis Cloud for vector storage.

  • Use Redis Cloud by creating a free account
  • Create a database
    • Set a database name
    • Select Database version 8.0
    • Click Create database
  • When the database creation is complete:
    • Under General, copy the database Public endpoint (to use later in .env setup)
    • Expand Security and copy the Default user password (to use later in .env setup)

OpenAI (Optional)

Local Model (Optional if using OpenAI)

Install Ollama

Note

To run the Granite model locally, we recommend having at least 16GB of RAM for optimal performance.

To run models locally on your machine:

  1. Download and install Ollama: https://ollama.com/download
  2. Run or pull the Granite model:
ollama run granite3.3:8b

or

ollama pull granite3.3:8b

Model link: Granite 3.3:8b

You're Ready

Once you've completed these steps, you're ready for the workshop.