Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/schedulers: add runopts to documentation #374

Closed
wants to merge 1 commit into from
Closed

Conversation

d4l3k
Copy link
Contributor

@d4l3k d4l3k commented Jan 25, 2022

This adds the runopts to the documentation for the schedulers. It uses a sphinx plugin to load the scheduler and generate the CLI help text which it places in a code block.

Test plan:

make clean html

Screenshot 2022-01-25 at 14-57-50 Slurm — PyTorch TorchX main documentation
Screenshot 2022-01-25 at 14-57-43 Kubernetes — PyTorch TorchX main documentation
Screenshot 2022-01-25 at 14-57-31 Local — PyTorch TorchX main documentation

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jan 25, 2022
@facebook-github-bot
Copy link
Contributor

@d4l3k has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

@codecov
Copy link

codecov bot commented Jan 25, 2022

Codecov Report

Merging #374 (45d0e70) into main (92e6897) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #374   +/-   ##
=======================================
  Coverage   94.66%   94.66%           
=======================================
  Files          61       61           
  Lines        3208     3208           
=======================================
  Hits         3037     3037           
  Misses        171      171           
Impacted Files Coverage Δ
torchx/schedulers/kubernetes_scheduler.py 94.41% <ø> (ø)
torchx/schedulers/local_scheduler.py 93.25% <ø> (ø)
torchx/schedulers/slurm_scheduler.py 96.94% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 92e6897...45d0e70. Read the comment docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants