Metadata-Version: 2.3
Name: rcabench-platform
Version: 0.4.18
Summary: An experiment framework for Root Cause Analysis
Author: Nugine, Lincyaw, rainystevn1, YifanYang6
Author-email: Nugine <xuyangwang@link.cuhk.edu.cn>, Lincyaw <814750204@qq.com>, rainystevn1 <rainystevn1@gmail.com>, YifanYang6 <yifanyang6@link.cuhk.edu.cn>
Requires-Dist: loguru>=0.7.3
Requires-Dist: tqdm>=4.67.1
Requires-Dist: typer>=0.16.0
Requires-Dist: python-dotenv>=1.1.1
Requires-Dist: pydantic>=2.12.4
Requires-Dist: backports-strenum>=1.3.1 ; python_full_version < '3.11'
Requires-Dist: rcabench-platform[sdk,internal,analysis,llm-eval] ; extra == 'all'
Requires-Dist: altair>=5.5.0 ; extra == 'analysis'
Requires-Dist: graphviz>=0.20.3 ; extra == 'analysis'
Requires-Dist: kaleido>=1.0.0 ; extra == 'analysis'
Requires-Dist: matplotlib>=3.10.3 ; extra == 'analysis'
Requires-Dist: plotly>=6.2.0 ; extra == 'analysis'
Requires-Dist: vega-datasets>=0.9.0 ; extra == 'analysis'
Requires-Dist: vegafusion>=2.0.2 ; extra == 'analysis'
Requires-Dist: statsmodels>=0.14.5 ; extra == 'analysis'
Requires-Dist: streamlit>=1.49.0 ; extra == 'analysis'
Requires-Dist: pyvis>=0.3.2 ; extra == 'analysis'
Requires-Dist: python-dateutil>=2.9.0.post0 ; extra == 'analysis'
Requires-Dist: sqlalchemy>=2.0.43 ; extra == 'analysis'
Requires-Dist: rcabench>=1.1.51 ; extra == 'internal'
Requires-Dist: clickhouse-connect>=0.8.18 ; extra == 'internal'
Requires-Dist: kubernetes>=33.1.0 ; extra == 'internal'
Requires-Dist: neo4j>=5.28.1 ; extra == 'internal'
Requires-Dist: minio>=7.2.15 ; extra == 'internal'
Requires-Dist: huggingface-hub>=0.33.4 ; extra == 'internal'
Requires-Dist: drain3>=0.9.11 ; extra == 'internal'
Requires-Dist: sqlmodel>=0.0.22 ; extra == 'llm-eval'
Requires-Dist: openai>=1.40.0 ; extra == 'llm-eval'
Requires-Dist: pyyaml>=6.0.0 ; extra == 'llm-eval'
Requires-Dist: colorlog>=6.9.0 ; extra == 'llm-eval'
Requires-Dist: jinja2>=3.1.0 ; extra == 'llm-eval'
Requires-Dist: questionary>=2.1.0 ; extra == 'llm-eval'
Requires-Dist: rich>=13.7.0 ; extra == 'llm-eval'
Requires-Dist: requests>=2.32.4 ; extra == 'llm-eval'
Requires-Dist: openpyxl>=3.1.0 ; extra == 'llm-eval'
Requires-Dist: psycopg2-binary>=2.9.0 ; extra == 'llm-eval'
Requires-Dist: types-pyyaml>=6.0.12 ; extra == 'llm-eval'
Requires-Dist: fastapi>=0.135.2 ; extra == 'llm-eval'
Requires-Dist: uvicorn>=0.38.0 ; extra == 'llm-eval'
Requires-Dist: polars>=1.31.0 ; extra == 'sdk'
Requires-Dist: numpy>=2.2.6 ; extra == 'sdk'
Requires-Dist: pandas>=2.3.1 ; extra == 'sdk'
Requires-Dist: duckdb>=1.3.2 ; extra == 'sdk'
Requires-Dist: networkx>=3.4.2 ; extra == 'sdk'
Requires-Dist: scipy>=1.15.0 ; extra == 'sdk'
Requires-Python: >=3.10
Provides-Extra: all
Provides-Extra: analysis
Provides-Extra: internal
Provides-Extra: llm-eval
Provides-Extra: sdk
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 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](./docs/package-restructuring-plan.md) for details.

## Documentation

+ [User Guide](./docs/USER_GUIDE.md): Complete guide for using rcabench-platform as both a console command and SDK.
+ [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.
+ [Package Restructuring Plan](./docs/package-restructuring-plan.md): v3 directory structure, v2→v3 migration guide, and optional dependency groups.

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