Skip to content

PtolemyLovesYou/ptolemy

Ptolemy Ptolemy

tests docs

codecov codspeed Discord

Universal monitoring observability for AI systems, without reinventing the wheel for each new methodology.

Setup (Quickstart)

Docker

To run using the quickstart docker-compose.yml, run the following command:

> docker compose up

You should be able to access the experimental Streamlit app at http://localhost:8501.

Setup (Development)

Run locally

To run outside of docker, you must have:

  • uv and cargo installed
  • a postgres instance running available at http://localhost:5432. If the user credentials for the Postgres instance are different than those in .cargo/config.toml, you can override them by exporting them as environment variables.
# Start API
> make run-api

# Build Python client (necessary for running the prototype frontend)
> make build-client

# If you want to run postgres in docker:
> docker compose up -d postgres

Configuration

API

Ptolemy API has the following configurations that can be set via environment variables (you can find these in .env.example):

# Postgres settings
POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres
POSTGRES_DB=ptolemy
POSTGRES_HOST=postgres
POSTGRES_PORT=5432

# Sysadmin Credentials
PTOLEMY_USER=admin
PTOLEMY_PASS=admin

# Can be DEV, STAGE, or PROD (default is PROD)
PTOLEMY_ENV=DEV

# JWT Secret
JWT_SECRET=your-base64-encoded-secret-here

# Optional configurations
API_PORT=7865

For convenience, these variables are included in .cargo/config.toml as default environment variables.

About

Universal monitoring observability for AI systems, without reinventing the wheel for each new methodology.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors