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] Add docs for run many jobs #3847

Merged
merged 49 commits into from
Aug 29, 2024
Merged

[Docs] Add docs for run many jobs #3847

merged 49 commits into from
Aug 29, 2024

Conversation

Michaelvll
Copy link
Collaborator

Tested (run the relevant ones):

  • Code formatting: bash format.sh
  • Any manual or new tests for this PR (please specify below)
  • All smoke tests: pytest tests/test_smoke.py
  • Relevant individual smoke tests: pytest tests/test_smoke.py::test_fill_in_the_name
  • Backward compatibility tests: conda deactivate; bash -i tests/backward_compatibility_tests.sh

Copy link
Member

@concretevitamin concretevitamin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make a pass, thanks @Michaelvll.

docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved

.. code-block:: bash

for config_file in configs/*.env; do
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One question in mind was "how to write out a config file for each param combo". Is it better to show a representative python program to iterate over params, then either (1) write out the env files, or (2) directly call jobs launch Python API / CLI from within Python script?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a python script for generating the configs.

Michaelvll and others added 24 commits August 28, 2024 11:51
@Michaelvll
Copy link
Collaborator Author

Here is the preview of the latest doc: https://skypilot.readthedocs.io/en/docs-scale-up-jobs/running-jobs/many-jobs.html

Copy link
Member

@concretevitamin concretevitamin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Michaelvll, this looks great. Some comments.

docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
docs/source/docs/index.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
Copy link
Member

@concretevitamin concretevitamin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/many-jobs.rst Outdated Show resolved Hide resolved
@concretevitamin
Copy link
Member

Minor nav bar discussion

  • k8s: Maybe fine to remove 'new' since it's been marked so for a while. Also convey it's more mature.
  • Nav bar is becoming long. Maybe can collapse Developer Guides into References as a dropdown.

@Michaelvll Michaelvll enabled auto-merge August 29, 2024 18:06
@Michaelvll Michaelvll added this pull request to the merge queue Aug 29, 2024
Merged via the queue into master with commit 95b52c0 Aug 29, 2024
20 checks passed
@Michaelvll Michaelvll deleted the docs-scale-up-jobs branch August 29, 2024 18:17
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.

2 participants