Skip to content

[Feature Request] Add a beginner-friendly cheatsheet for data hyper-cleaning operator combinations #80

Description

@pipi-183

Required prerequisites

Motivation

I am learning BOAT through the examples/data_hyper_cleaning/test_data_hyper_cleaning.py example. The example is useful because it includes many bilevel optimization operator combinations, such as NGD, GDA, DI, DM, CG, RAD, FD, NS, IGA, VSO, VFO, MESO, and PGDO.

However, as a new user, I found it difficult to quickly understand which combinations belong to GM-OL, NA-OL, and FO-OL, and which combinations are recommended for beginners to run first.

This is related to the data hyper-cleaning use case. Since BOAT is configuration-heavy, a beginner-friendly cheatsheet would reduce confusion and help new users run the examples more smoothly.

Proposed solution

I suggest adding a short cheatsheet to the documentation or to the examples/data_hyper_cleaning README.

The cheatsheet could include:

  1. Recommended beginner combinations, such as NGD + CG, GDA + CG, and NGD + RAD.
  2. A table explaining which operators belong to GM-OL, NA-OL, and FO-OL.
  3. Common invalid or confusing combinations that users should avoid.
  4. A short explanation of what each operator combination is intended to test.
  5. A minimal command for running one stable data hyper-cleaning example.

This would make the data hyper-cleaning example easier to understand and reduce trial-and-error configuration mistakes.

Alternatives considered

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions