Skip to main content

An experiment framework for Root Cause Analysis

Project description

rcabench-platform

An experiment framework for Root Cause Analysis (RCA), supporting fast development of RCA algorithms and their evaluation on various datasets.

Installation

To add this package to another uv-managed project:

# Install lightweight SDK (for algorithm/sampler development)
uv add rcabench-platform

# Install with platform-internal tools (kubernetes, neo4j, clickhouse, etc.)
uv add "rcabench-platform[internal]"

# Install with analysis/visualization tools (matplotlib, plotly, etc.)
uv add "rcabench-platform[analysis]"

# Install everything (equivalent to the old monolithic install)
uv add "rcabench-platform[all]"

The base package includes only the SDK core for developing and evaluating RCA algorithms and trace samplers. Use optional dependency groups to install additional functionality:

  • [internal] — Platform server clients, cloud storage, dataset converters, SDG builder
  • [analysis] — Visualization, statistical analysis, Streamlit dashboards
  • [all] — All of the above

See Package Restructuring Plan for details.

Documentation

  • User Guide: Complete guide for using rcabench-platform as both a console command and SDK.
  • Development Guide: How to set up the development environment and contribute to this project.
  • Specifications: Our design details about RCA algorithms and data formats.
  • Workflow References: How to use the functionalities of this project.
  • Maintenance: Guidelines for maintaining the project and release procedures.
  • Package Restructuring Plan: v3 directory structure, v2→v3 migration guide, and optional dependency groups.

Related Projects

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

rcabench_platform-0.4.9.tar.gz (431.4 kB view details)

Uploaded Source

Built Distribution

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

rcabench_platform-0.4.9-py3-none-any.whl (549.9 kB view details)

Uploaded Python 3

File details

Details for the file rcabench_platform-0.4.9.tar.gz.

File metadata

  • Download URL: rcabench_platform-0.4.9.tar.gz
  • Upload date:
  • Size: 431.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.0 {"installer":{"name":"uv","version":"0.11.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for rcabench_platform-0.4.9.tar.gz
Algorithm Hash digest
SHA256 20f571cad65a96696a4a4ae3566db4f9f629cb2aa238ac91ae696bb594339e12
MD5 cff4da8386ca17716839e9f6d9707f4a
BLAKE2b-256 02541a013184098a8b62ea7fb918be888a26c202e7afc063fb5646f84457d32d

See more details on using hashes here.

File details

Details for the file rcabench_platform-0.4.9-py3-none-any.whl.

File metadata

  • Download URL: rcabench_platform-0.4.9-py3-none-any.whl
  • Upload date:
  • Size: 549.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.0 {"installer":{"name":"uv","version":"0.11.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for rcabench_platform-0.4.9-py3-none-any.whl
Algorithm Hash digest
SHA256 dc9e898281b74b7d805371b6c9ac28b6bb5b48ddb5de70f7349c2cd787e936bb
MD5 3dc312e8870f9fa6ce06eb88c698dbad
BLAKE2b-256 fd84069f997efe1d26a04fad552df7345e46dbe6ed634bcaa6e8c915921541f8

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