{"id":38692463,"url":"https://github.com/squaredev-io/whitebox","last_synced_at":"2026-01-17T10:34:50.067Z","repository":{"id":63706352,"uuid":"534625527","full_name":"squaredev-io/whitebox","owner":"squaredev-io","description":"[Not Actively Maintained] Whitebox is an open source E2E ML monitoring platform with edge capabilities that plays nicely with kubernetes","archived":false,"fork":false,"pushed_at":"2023-07-11T22:37:38.000Z","size":22279,"stargazers_count":183,"open_issues_count":29,"forks_count":5,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-06T20:42:18.449Z","etag":null,"topics":["accuracy","accuracy-metrics","accuracy-score","confusion-matrix","explainability","explainable-ai","f1-score","k8s","kubernetes","machine-learning","ml-monitoring","mlflow","mlops","model-monitoring","modelops","monitoring","observability","python","recall","xai"],"latest_commit_sha":null,"homepage":"https://squaredev.io/whitebox/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/squaredev-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-09-09T12:02:53.000Z","updated_at":"2024-11-13T18:09:59.000Z","dependencies_parsed_at":"2024-01-08T17:24:34.572Z","dependency_job_id":"4e9cc9b9-b3dc-4837-a66a-d6e9795e91d4","html_url":"https://github.com/squaredev-io/whitebox","commit_stats":null,"previous_names":["whitebox-ai/whitebox"],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/squaredev-io/whitebox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squaredev-io%2Fwhitebox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squaredev-io%2Fwhitebox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squaredev-io%2Fwhitebox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squaredev-io%2Fwhitebox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/squaredev-io","download_url":"https://codeload.github.com/squaredev-io/whitebox/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squaredev-io%2Fwhitebox/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28506589,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T10:25:30.148Z","status":"ssl_error","status_checked_at":"2026-01-17T10:25:29.718Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accuracy","accuracy-metrics","accuracy-score","confusion-matrix","explainability","explainable-ai","f1-score","k8s","kubernetes","machine-learning","ml-monitoring","mlflow","mlops","model-monitoring","modelops","monitoring","observability","python","recall","xai"],"created_at":"2026-01-17T10:34:49.990Z","updated_at":"2026-01-17T10:34:50.059Z","avatar_url":"https://github.com/squaredev-io.png","language":"Python","readme":"Update June 19, 2023: Whitebox is now prioritizing monitoring LLMs. This repo is no longer maintained, but our commitment to building fair and responsible AI applications remains. If you're passionate about ML or React and want to join us as a founding engineer, reach out to Kostas on Discord.\n\n---\n\n# Whitebox - E2E machine learning monitoring\n\n\u003cp align=\"center\"\u003e\n    \u003cem\u003eWhitebox is an open source E2E ML monitoring platform with edge capabilities that plays nicely with kubernetes\n\u003c/em\u003e\n\u003c/p\u003e\n\n---\n\n**Documentation**: \u003ca href=\"https://whitebox-ai.github.io/whitebox/\" target=\"_blank\"\u003ehttps://whitebox-ai.github.io/whitebox\u003c/a\u003e\n\n**Source Code**: \u003ca href=\"https://github.com/whitebox-ai/whitebox\" target=\"_blank\"\u003ehttps://github.com/whitebox-ai/whitebox\u003c/a\u003e\n\n**Roadmap**: \u003ca href=\"https://github.com/whitebox-ai/whitebox/milestones\" target=\"_blank\"\u003ehttps://github.com/whitebox-ai/whitebox/milestones\u003c/a\u003e\n\n**Issue tracking** \u003ca href=\"https://github.com/orgs/whitebox-ai/projects/1/views/3\" target=\"_blank\"\u003ehttps://github.com/orgs/whitebox-ai/projects/1/views/3\u003c/a\u003e\n\n**Discord**: \u003ca href=\"https://discord.gg/G5TKJMmGUt\" target=\"_blank\"\u003ehttps://discord.gg/G5TKJMmGUt\u003c/a\u003e\n\n---\n\nWhitebox is an open source E2E ML monitoring platform with edge capabilities that plays nicely with kubernetes.\n\nThe key features are:\n\n- **Classification models metrics**\n- **Regression models metrics**\n- **Data / model drift monitoring**\n- **Alerts**\n\nDesign guidelines:\n\n- **Easy**: Very easy to set up and get started with.\n- **Intuitive**: Designed to be intuitive and easy to use.\n- **Pythonic SDK**: Pythonic SDK for building your own monitoring infrastructure.\n- **Robust**: Get production-ready MLOps system.\n- **Kubernetes**: Get production-ready code. With automatic interactive documentation.\n\n# Installation\n\nInstall the server using `docker compose`. See the [docs](https://whitebox-ai.github.io/whitebox/tutorial/installation) for more info.\n\nInstall the SDK with `pip`:\n\n```bash\npip install whitebox-sdk\n```\n\n# How to use\n\nAfter you are done installing the server and the SDK, you can start using it.\n\nAfter you get the API key, all you have to do is create an instance of the Whitebox class adding your host and API key as parameters:\n\n```python\nfrom whitebox import Whitebox\n\nwb = Whitebox(host=\"127.0.0.1:8000\", api_key=\"some_api_key\")\n```\n\nNow you're ready to start using Whitebox! Read the [documentation](https://whitebox-ai.github.io/whitebox/) to learn more about the SDK.\n\n# Set up locally for development\n\nWhitebox supports Postgres and SQLite. You can use either one of them.\nIf you want to use SQLite, you need to set up a SQLite database and set the `DATABASE_URL` environment variable to the database URL.\nIf you want to use Postgres, you don't need to do anything. Just have a Postgres database running and set the `DATABASE_URL` environment variable to the database URL.\n\n### Install packages:\n\n```bash\npython -m venv .venv\npip install -r requirements.txt\npre-commit install\n```\n\n### Run the server:\n\n```bash\nENV=dev uvicorn whitebox.main:app --reload\n```\n\n### Quick way to start a postgres database:\n\n```bash\ndocker compose up postgres -d\n```\n\n### Tests:\n\n- Run: `ENV=test pytest` or `ENV=test pytest -s` to preserve logs.\n- Watch: `ENV=test ptw`\n- Run test coverage `ENV=test coverage run -m pytest`\n- Look at coverage report: `coverage report` or `coverage html` to generate an html. To view it in your browser open the `htmlcov/index.html` file.\n\n### Docs\n\n**Documentation is hosted bby GitHub here**: \u003ca href=\"https://whitebox-ai.github.io/whitebox/\" target=\"_blank\"\u003ehttps://whitebox-ai.github.io/whitebox\u003c/a\u003e\n\n```\nmkdocs serve -f docs/mkdocs/mkdocs.yml -a localhost:8001\n```\n\n# Deploy Whitebox\n\n## Using docker\n\nWhitebox uses postgres as its database. They need to run in the same docker network. An example docker-compose file is located in the `examples` folder. Make sure you replace the SECRET_KEY with one of your own. Look below for more info.\n\n```bash\ndocker-compose -f examples/docker-compose/docker-compose.yml up\n```\n\nIf you just need to run Whitebox, make sure you set the `DATABASE_URL` in the environment.\n\n```bash\ndocker run -dp 8000:8000 sqdhub/whitebox:main -e DATABASE_URL=postgresql://user:password@host:port/db_name\n```\n\nTo save the api key encrypted in the database, provide a SECRET_KEY variable in the environment that is consisted of a 16 bytes string.\n\n```bash\npython -c \"from secrets import token_hex; print(token_hex(16))\"\n```\n\n**_Save this token somewhere safe._**\n\nThe api key can be retrieved directly from the postgres database:\n\n```bash\nAPI_KEY=$(docker exec \u003cpostgres_container_id\u003e /bin/sh -c \"psql -U postgres -c \\\"SELECT api_key FROM users WHERE username='admin';\\\" -tA\")\n\necho $API_KEY\n```\n\nIf you've set the `SECRET_KEY` in the environment get the decrypted key using:\n\n```bash\ndocker exec \u003cwhitebox_container_id\u003e /usr/local/bin/python scripts/decrypt_api_key.py $API_KEY\n```\n\n## Using Helm\n\nYou can also install Whitebox server and all of its dependencies in your k8s cluster using `helm`\n\n```bash\nhelm repo add squaredev https://chartmuseum.squaredev.io/\nhelm repo update\nhelm install whitebox squaredev/whitebox\n```\n\n# Contributing\n\nWe happily welcome contributions to Whitebox. You can start by opening a new issue!\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsquaredev-io%2Fwhitebox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsquaredev-io%2Fwhitebox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsquaredev-io%2Fwhitebox/lists"}