Skip to content

docs(examples): fix DHL argparse help copy-pasted from meta-learning - #85

Open
SAY-5 wants to merge 1 commit into
callous-youth:mainfrom
SAY-5:fix/dhl-argparse-help-text
Open

docs(examples): fix DHL argparse help copy-pasted from meta-learning#85
SAY-5 wants to merge 1 commit into
callous-youth:mainfrom
SAY-5:fix/dhl-argparse-help-text

Conversation

@SAY-5

@SAY-5 SAY-5 commented May 12, 2026

Copy link
Copy Markdown

Description

The --gm_op, --na_op, and --fo_op flags in examples/data_hyper_cleaning/data_hyper_cleaning.py (lines 58-75) advertised omniglot or miniimagenet or tieredImagenet and convnet for 4 convs or resnet for Residual blocks. Those values belong to the meta-learning example: data hyper-cleaning does not consume datasets or backbones, it composes GM/NA/FO operators.

The result was that a new user running python data_hyper_cleaning.py --help to learn the legal values for these flags was directed to incorrect names. Reported in #24.

This PR replaces the help strings with the operator names actually accepted by each flag, derived from the modules under boat_torch/gm_ol/, boat_torch/na_ol/, and boat_torch/fo_ol/, and points readers at those directories for the authoritative list. No runtime behaviour changes.

Closes #24

Types of Changes

  • Fix / Optimization (performance improvement or bug fix)
  • New Feature (e.g., adding a new atomic operation for GM, NA, or FO)
  • Documentation / Example Update
  • Breaking Change (causes changes to existing functionality)

Pre-Submission Checklist

  • I have read the CONTRIBUTING guide.
  • The code has been formatted using black (only the touched hunks; pre-existing whitespace nits in unrelated lines were left untouched to keep the diff scoped).
  • (If applicable) I have updated the relevant Sphinx documentation.

…ning

The --gm_op/--na_op/--fo_op flags in
examples/data_hyper_cleaning/data_hyper_cleaning.py described
omniglot/miniimagenet/tieredImagenet and convnet/resnet, which are
meta-learning datasets and architectures unrelated to data
hyper-cleaning. Reported in callous-youth#24.

Replace the help strings with the operator names actually accepted
for each flag (Gradient Mapping / Numerical Approximation /
First-Order) and point readers at boat_torch/{gm_ol,na_ol,fo_ol}/
for the authoritative list.

Closes callous-youth#24

Signed-off-by: SAY-5 <say.apm35@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] data_hyper_cleaning example: argparse --help text mistakenly describes meta-learning datasets/models (copy-paste from another example)

1 participant