Skip to content

[RFC] RL Insight refactor directory structure #83

Description

@mengchengTang

RFC: Refactor Repository Layout and Add UT Coverage

Background

RL-Insight currently has two parts:

  • Online Monitor was previously under experimental/.
  • Offline analysis already exists as a separate set of parser, data check, pipeline, and visualization utilities.

To make the project structure clearer, Online Monitor should become the main rl_insight/ package, while offline analysis should be released as recipe/.

Proposal

Refactor the repository into the following structure:

rl_insight/        # online monitor, migrated from experimental/
recipe/            # offline analysis
data/recipe/       # sample data for recipe
docs/monitor/
docs/recipe/
examples/monitor/
examples/recipe/
tests/monitor/
tests/recipe/

Principles

Move Online Monitor from experimental/ to rl_insight/.
Package offline analysis as recipe/.
Put recipe sample data under data/recipe/.
Split docs, examples, and tests by domain.
Use file moves when possible to preserve Git history and avoid large rewritten diffs.

UT / CI Updates

Move existing offline tests to tests/recipe/.
Update CI paths and commands for the new recipe test locations.
Ensure recipe tests use sample data from data/recipe/....
Add or expand Online Monitor CI in follow-up work.

Expected Benefit

This makes rl_insight/ the clear entry point for Online Monitor, keeps offline analysis self-contained under recipe/, and prepares the repository for better CI coverage across both domains.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions