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.23.tar.gz (639.2 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.23-py3-none-any.whl (817.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rcabench_platform-0.4.23.tar.gz
  • Upload date:
  • Size: 639.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","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.23.tar.gz
Algorithm Hash digest
SHA256 ae0b0c86f5978f94bc0bca044953a014368ca866c74da36aa8b56904a1106f07
MD5 afeaf880c27934e62395b0347004b380
BLAKE2b-256 1dad9a82b9c0e3c7990abd5cfdda6cb4513cbd2007b113e29f593220461ab347

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rcabench_platform-0.4.23-py3-none-any.whl
  • Upload date:
  • Size: 817.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","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.23-py3-none-any.whl
Algorithm Hash digest
SHA256 f69b512c342c133f3e6c73b656bcc5fac3624be6ce8a4f501092c472ee0632db
MD5 ea500b922602a71603563a5fe7adf2d2
BLAKE2b-256 1363ac4c66926fe781cd0d5268af2e86ce1c1e4dbca8c6f7e02132da97347aea

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