Metadata-Version: 2.3
Name: rcabench-platform
Version: 0.3.3
Summary: An experiment framework for Root Cause Analysis
Author: Nugine
Author-email: Nugine <xuyangwang@link.cuhk.edu.cn>
Requires-Dist: backports-strenum>=1.3.1 ; python_full_version < '3.11'
Requires-Dist: clickhouse-connect>=0.8.18
Requires-Dist: huggingface-hub>=0.33.4
Requires-Dist: kubernetes>=33.1.0
Requires-Dist: loguru>=0.7.3
Requires-Dist: minio>=7.2.15
Requires-Dist: neo4j>=5.28.1
Requires-Dist: networkx>=3.4.2
Requires-Dist: numpy>=2.2.6
Requires-Dist: pandas>=2.3.1
Requires-Dist: polars>=1.31.0
Requires-Dist: pyarrow>=20.0.0
Requires-Dist: python-dotenv>=1.1.1
Requires-Dist: rcabench>=1.0.50
Requires-Dist: requests>=2.32.4
Requires-Dist: scikit-learn>=1.7.0
Requires-Dist: scipy>=1.15.0
Requires-Dist: tqdm>=4.67.1
Requires-Dist: typer>=0.16.0
Requires-Dist: graphviz>=0.20.3 ; extra == 'analysis'
Requires-Dist: matplotlib>=3.10.3 ; extra == 'analysis'
Requires-Python: >=3.10
Provides-Extra: analysis
Description-Content-Type: text/markdown

# 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:

```bash
# Install basic package
uv add rcabench-platform

# Install with dataset analysis functionality
uv add "rcabench-platform[analysis]"
```

The `analysis` extra includes additional dependencies like `graphviz` and `matplotlib` needed for the dataset analysis features.

## Documentation

+ [Development Guide](./CONTRIBUTING.md): How to set up the development environment and contribute to this project.
+ [Specifications](./docs/specifications.md): Our design details about RCA algorithms and data formats.
+ [Workflow References](./docs/workflow-references.md): How to use the functionalities of this project.
+ [Maintenance](./docs/maintenance.md): Guidelines for maintaining the project and release procedures.

## Related Projects

+ [rcabench](https://github.com/LGU-SE-Internal/rcabench)
+ [rca-algo-contrib](https://github.com/LGU-SE-Internal/rca-algo-contrib)
+ [rca-algo-random](https://github.com/LGU-SE-Internal/rca-algo-random)
