docs: move dataset generation guide to introduction#263
Open
xarthurx wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR relocates the Airfoil dataset-generation Slurm submission guide from the Slurm utilities page into the Introduction section, improving discoverability and aligning wording with cluster policy guidance.
Changes:
- Add a new Introduction page documenting the end-to-end “Dataset Generation via Slurm” workflow (Airfoil example).
- Link to the new guide from the Slurm utilities documentation and update the sidebar label.
- Update Slurm utility docstring wording to replace informal HPC-team phrasing; fix the
fake_sbatchtest tool shebang.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
tests/tools/fake_sbatch.py |
Fix shebang to the standard /usr/bin/env python3. |
engibench/utils/slurm/__init__.py |
Update reduce() docstring wording around login-node size limits / cluster policy. |
docs/utils/slurm.md |
Add link to the new dataset-generation guide and remove the embedded Airfoil example script. |
docs/introduction/dataset_generation_slurm.md |
New end-to-end dataset-generation submission guide (Airfoil example). |
docs/index.md |
Add the new guide to the Introduction toctree with the requested sidebar label. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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
Screenshot
Validation
Addresses #261