Skip to main content

A modular Python package for implementing Retrieval Augmented Generation chains for the chATLAS project.

Project description

chATLAS_Chains

This package implements and benchmarks various Retrieval Augmented Generation (RAG) chains for use in the chATLAS project.

Installation

From PyPI

pip install chATLAS-Chains

From source

We recommend using uv

cd chATLAS_Chains
uv sync

Environment variables

These are required for the following use cases

  1. Using an OpenAI LLM
export CHATLAS_OPENAI_KEY="your api key"
  1. Using LLMs via the Groq API
export CHATLAS_GROQ_BASE_URL="http://cs-513-ml003:3000"
export CHATLAS_GROQ_KEY="your groq api key"

note The API address is local to the CERN network. If not at CERN, you can forward it like so:

ssh -L 3000:cs-513-ml003:3000 <LXPLUS_USERNAME>@lxplus.cern.ch
export CHATLAS_GROQ_BASE_URL="http://localhost:3000"

Available Chains

  • chains.basic.basic_retrieval_chain
  • chains.basic_graph.basic_retrieval_graph
  • chains.advanced.advanced_rag

Postgres

If you want to create a local postgres server, you need to install psql. Some instructions to do this on macOS using homebrew are here:

Software install

brew install postgresql
brew services start postgresql
brew install pgvector
brew unlink pgvector && brew link pgvector

Create a user

psql -h localhost -U postgres
ALTER USER postgres WITH PASSWORD 'Set_your_password_here';
CREATE EXTENSION IF NOT EXISTS vector;

CHANGELOG

0.1.6

Fix bug in reciprocal_rank_fusion which caused it to silently return only one document

Add fallback_models optional argument to advanced_rag

0.1.5

Fix missing retry_config argument in advanced_rag caused by early PyPI upload

0.1.4

Support for Groq-hosted models

Some new functions that go beyond the "basic RAG" workflow:

  • Reciprocal Rerank Fusion chATLAS_Chains.documents.rrf.reciprocal_rank_fusion
  • Document reranking via the Pinecone API chATLAS_Chains.documents.rerank.rerank_documents
  • Query rewriting step chATLAS_Chains.query.query_rewriting.rewrite_query

These are all usable via the new chain chATLAS_Chains.chains.advanced.advanced_rag

Added unit tests to gitlab CI/CD pipeline

0.1.3

Fixing imports

Changed output format of basic_retrieval_chain (docs key is now a list of Document objects, rather than a dict)

Unit tests for basic_retrieval_chain

0.1.2

Unit tests

First Langgraph chain

0.1.1

Initial Release


📄 License

chATLAS_Benchmark is released under Apache v2.0 license.


Made with ❤️ by the ATLAS Collaboration

For questions and support, please contact

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chatlas_chains-0.1.6.tar.gz (54.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chatlas_chains-0.1.6-py3-none-any.whl (63.3 kB view details)

Uploaded Python 3

File details

Details for the file chatlas_chains-0.1.6.tar.gz.

File metadata

  • Download URL: chatlas_chains-0.1.6.tar.gz
  • Upload date:
  • Size: 54.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.13

File hashes

Hashes for chatlas_chains-0.1.6.tar.gz
Algorithm Hash digest
SHA256 c41986310c9a40cbcadb6b976f58609bc1a747232c1a3b39da121744dbb2ed14
MD5 2109a69226a616adf2ac9bcd81011888
BLAKE2b-256 769ac16d939e1d32a82335e2ca8bb95ed3ce26adcaf73e311597152e3b37f2a9

See more details on using hashes here.

File details

Details for the file chatlas_chains-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for chatlas_chains-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4713da40a7715cc6526b83fc5f8ae8787f5f630a744494ddba80a97fc05b3221
MD5 b371609a8d8511f2a8a22c2c96f0e6db
BLAKE2b-256 6a820fa4d266fb73c8911c197b22060582e2b076d172c45c04f970cf6f4b9974

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page