docs: align benchmark guide and template with dataloader.py naming#43
Open
imshunsuke wants to merge 1 commit into
Open
docs: align benchmark guide and template with dataloader.py naming#43imshunsuke wants to merge 1 commit into
imshunsuke wants to merge 1 commit into
Conversation
The new-benchmark guide and the env template README referred to the data loader file as loader.py, but all six built-in benchmarks name it dataloader.py (skillopt/envs/<name>/dataloader.py). Update the docs and the template rename step to match the actual convention. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Author
|
@microsoft-github-policy-service agree |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The "Add a New Benchmark" guide (
docs/guide/new-benchmark.md) and the envtemplate README (
skillopt/envs/_template/README.md) refer to the data-loaderfile as
loader.py, but all six built-in benchmarks name itdataloader.py(
skillopt/envs/<name>/dataloader.py). This aligns the docs with the actualconvention so a new contributor following the guide produces a filename
consistent with the existing benchmarks.
Note the template was even internally inconsistent: the docstring in
skillopt/envs/_template/loader_template.pyalready points toskillopt/envs/officeqa/dataloader.py, while_template/README.mdtold you torename the file to
loader.py.Changes (docs only, no code changes)
docs/guide/new-benchmark.md: Step 2 file path and the adapter import now usedataloader.py.skillopt/envs/_template/README.md: the rename step (mv loader_template.py dataloader.py) and the TODO reference now usedataloader.py.