Metadata-Version: 2.4
Name: rl-insight
Version: 0.1.0
Summary: Performance insight tools for reinforcement learning frameworks.
Author: rl-insight contributors
Project-URL: Homepage, https://github.com/verl-project/rl-insight
Project-URL: Source, https://github.com/verl-project/rl-insight
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy<2.0.0
Requires-Dist: pandas
Requires-Dist: plotly
Requires-Dist: pytest
Requires-Dist: loguru
Dynamic: license-file

# RL-Insight: Provide performance insight capabilities for RL frameworks.
<div align="center">

<a href="https://deepwiki.com/verl-project/rl-insight"><img src="https://devin.ai/assets/deepwiki-badge.png" alt="Ask DeepWiki.com WIP" style="height:20px;"></a>
[![GitHub Repo stars](https://img.shields.io/github/stars/verl-project/rl-insight)](https://github.com/verl-project/rl-insight/stargazers)
[![Twitter](https://img.shields.io/twitter/follow/verl_project)](https://twitter.com/verl_project)
[![Documentation WIP](https://img.shields.io/badge/documentation-blue)](https://rl-insight.readthedocs.io/en/latest/)

</div>

In RL-Insight, we define [a general pipeline](https://github.com/verl-project/rl-insight/blob/main/docs/overview/architecture.md) for performance insights. A series of capabilities will be built based on this framework. With a well-defined data protocol, these capabilities can generalize across training frameworks.

<div align="center">
 <img src="https://github.com/verl-project/rl-insight/blob/main/assets/rl_insight_framework.svg" width="600" alt="rl-insight-arch.png">
</div>

## Key Features

- Offline analysis of cluster scheduling timeline based on **MSTX**,**torch profile** data collected from verl.


## Upcoming Features and Changes

- Q1 Roadmap https://github.com/verl-project/rl-insight/issues/6
- Q2 Roadmap https://github.com/verl-project/rl-insight/issues/49

## Getting Started

<a href="https://rl-insight.readthedocs.io/en/latest/"><b>Documentation</b></a>

**Quickstart:**

- [Offline Cluster Analysis Quickstart](https://github.com/verl-project/rl-insight/blob/main/docs/overview/RL_Timeline_quickstart.md)

## Contribution Guide

See [contributions guide](https://github.com/verl-project/rl-insight/blob/main/CONTRIBUTING.md) and [architecture & guideline](https://github.com/verl-project/rl-insight/blob/main/docs/overview/architecture.md)
