Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 2.3 KB

README.md

File metadata and controls

51 lines (37 loc) · 2.3 KB

Tools and prerequisites

To build your LLM and set up automated testing, you’ll need the following frameworks and tools:

  • PareaAI – A tool created to more efficiently debug language model applications by showing the trace of LLM calls, as well as inputs and outputs for certain prompts. This allows you to view the test results and metadata for all LLM calls in a single dashboard.

  • LangChain – An open-source framework for developing language model-powered applications. It provides prompt templates, models, document loaders, text splitters, and many other tools for interacting with models.

  • ChromaDB – An open-source embedding database/vector store, which tokenizes inputs (in our case, text) and stores them in an n-dimensional vector space. Chunks of text similar to new inputs can be returned using a modified K-nearest-neighbor algorithm in the vector space.

Directory structure

  • The rag/ directory contains an example LLM-powered application and unit test suite spread across multiple Python scripts.
    • These scripts rely on a .env file with API keys to OpenAI and Langchain, as well as other environment variables. An example is provided, but you need to populate it with your own variables.

Set up environment

  • Install and activate your virtual environment (we use Poetry)

  • Create a .env file by running cp .env.example .env, then set the necessary environment variables in it. This will include:

    • OpenAI API key: Go to https://platform.openai.com/account/api-keys, set up a paid account, and create a new secret key. This key should be stored in the OPENAI_API_KEY environment variable in your .env file.
    • Parea API key: Go to https://app.parea.ai/settings, create an account, and create an API key by clicking on the API Keys button on the bottom left of the page and following the instructions. This key should be stored in the PAREA_API_KEY environment variable in your .env file.

Run tests

Pytest

poetry run pytest -s

or

make test