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.18.tar.gz (437.9 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.18-py3-none-any.whl (557.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rcabench_platform-0.4.18.tar.gz
  • Upload date:
  • Size: 437.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","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.18.tar.gz
Algorithm Hash digest
SHA256 176a192f01e82d84996e6ec3db69f1d97906da5b41ba77f9775cb2eb264a2545
MD5 be6f9bf35c9091fb45dbf2387502700e
BLAKE2b-256 7b9bbf0a28a25bacbe1f88f1237d25178200f14e5821bd045774af7a66de3699

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rcabench_platform-0.4.18-py3-none-any.whl
  • Upload date:
  • Size: 557.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","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.18-py3-none-any.whl
Algorithm Hash digest
SHA256 2c2c0e9fd9753ba6d9b47f0d0e95a80c7535460911ec70ffd3e49b5e8e870ccd
MD5 65eadfb12998843cc19d99f3f47c8cbd
BLAKE2b-256 5b4b925de48d196235103b60b55b15b67945c4e605dbe3504433d41f6d02137b

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