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.17.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.17-py3-none-any.whl (557.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rcabench_platform-0.4.17.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.17.tar.gz
Algorithm Hash digest
SHA256 cfbb7099bcb83331d3574b213ca5d3e551aee37c5b94efdc5b33fc81db840cd8
MD5 1d9648519eeda41c02923c4da6814a54
BLAKE2b-256 5f3a77c98b75ad9aeb8c9078a1bb99f39a408f88f6cb3299117810882fb5066e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rcabench_platform-0.4.17-py3-none-any.whl
  • Upload date:
  • Size: 557.3 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.17-py3-none-any.whl
Algorithm Hash digest
SHA256 2de2fb4417433904daa1b6e5762105427bcff3964e22d12897683be4bc9e4ea6
MD5 b6893acb86ad32bda84a88ec0e68f45f
BLAKE2b-256 7c253a1bbd6401c64abb0c2af1717f878983260b4d1cb5ff6e266b11d4d006a9

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