Skip to content

docs: add new quickstart for job launching #404

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

Closed
wants to merge 1 commit into from
Closed

Conversation

d4l3k
Copy link
Member

@d4l3k d4l3k commented Mar 3, 2022

This updates the README/index/quickstart to highlight the job launching as the main user entrypoint as per https://docs.google.com/document/d/14icG0GJG1nPHF3DW7yMreZpe3S8FwYdrI_XYIzDTSbI/edit

Changes:

  • update README/index w/ new job launcher descriptions emphasized
  • move existing quickstart to custom_compents.md
  • update utils.python to have --script to match dist.ddp
  • update the pipelines/scheduler doc pages to list all child schedulers via glob
  • make pipeline doc structure match scheduler doc (piplines/, schedulers/)
  • docker_workspace
    • use Dockerfile.torchx to avoid unexpected collisions with Dockerfile.
    • docker_workspace pull images explicitly to avoid error from newer docker daemon during build
  • docker_scheduler: skip pulling sha256: images to avoid logspam

Test plan:

cd docs; make clean html
pyre

CI

Screenshot 2022-03-03 at 15-44-05 Quickstart — 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 Mar 3, 2022
@d4l3k d4l3k force-pushed the quickstartlaunch branch from 4d5c598 to 56a05a9 Compare March 3, 2022 23:47
@d4l3k d4l3k requested a review from kiukchung March 3, 2022 23:47
@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.

@d4l3k d4l3k force-pushed the quickstartlaunch branch from 56a05a9 to 5abe9f4 Compare March 3, 2022 23:49
@facebook-github-bot
Copy link
Contributor

@d4l3k has updated the pull request. You must reimport the pull request before landing.

@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.

@d4l3k d4l3k force-pushed the quickstartlaunch branch from 5abe9f4 to bddc9e7 Compare March 4, 2022 02:23
@facebook-github-bot
Copy link
Contributor

@d4l3k has updated the pull request. You must reimport the pull request before landing.

@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 Mar 4, 2022

Codecov Report

Merging #404 (bddc9e7) into main (571fd78) will decrease coverage by 0.32%.
The diff coverage is 35.29%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #404      +/-   ##
==========================================
- Coverage   94.54%   94.21%   -0.33%     
==========================================
  Files          66       66              
  Lines        3664     3681      +17     
==========================================
+ Hits         3464     3468       +4     
- Misses        200      213      +13     
Impacted Files Coverage Δ
torchx/components/utils.py 51.72% <0.00%> (-8.28%) ⬇️
torchx/workspace/docker_workspace.py 93.57% <66.66%> (-1.62%) ⬇️
torchx/schedulers/docker_scheduler.py 96.13% <100.00%> (-1.08%) ⬇️
torchx/schedulers/aws_batch_scheduler.py 82.79% <0.00%> (-2.60%) ⬇️
torchx/schedulers/kubernetes_scheduler.py 92.67% <0.00%> (ø)
torchx/components/dist.py 79.06% <0.00%> (+1.29%) ⬆️

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 571fd78...bddc9e7. Read the comment docs.

@d4l3k d4l3k deleted the quickstartlaunch branch April 13, 2022 22:28
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.

2 participants