-
Notifications
You must be signed in to change notification settings - Fork 551
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] Replace jupyter with interactive dev #3516
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Some suggestions.
For more details of auto stopping, check out: :ref:`auto-stop`. It helps you avoid idle machines from costing you a fortune, when you want a | ||
machine to stop automatically after you go to bed or forget to stop it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For more details of auto stopping, check out: :ref:`auto-stop`. It helps you avoid idle machines from costing you a fortune, when you want a | |
machine to stop automatically after you go to bed or forget to stop it. | |
For more details, see :ref:`auto-stop`. |
I found the second sentence a bit distracting (not sure about its core message?).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was trying to explicitly give some concrete examples for why people want the autostopping, as we have heard a bunch of people talking about letting the VM up for a while after they go to bed.
Reworded it a bit. Wdyt?
SkyPilot makes the interactive development very easy on clouds. It helps you: | ||
|
||
#. Launch: a cluster with GPU or any specific requirement with a single command. | ||
#. Connect: Quickly connect to the cluster with the cluster name. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This ordering is different from sections below?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moved autostop earlier as it might be more like a value add : )
Co-authored-by: Zongheng Yang <[email protected]>
Co-authored-by: Zongheng Yang <[email protected]>
Co-authored-by: Zongheng Yang <[email protected]>
Co-authored-by: Zongheng Yang <[email protected]>
Co-authored-by: Zongheng Yang <[email protected]>
Co-authored-by: Zongheng Yang <[email protected]>
Co-authored-by: Zongheng Yang <[email protected]>
Co-authored-by: Zongheng Yang <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Consider adding a table of contents at top? Since SSH/VSCode/Jupyter are likely to be useful, and currently the right navbar collapses them by default.
Good point! Manually added the TOC, as the built-in |
#. Click on the top bar, type: :code:`> remote-ssh`, and select :code:`Remote-SSH: Connect Current Window to Host...` | ||
#. Select the cluster name (e.g., ``dev``) from the list of hosts. | ||
#. Open folder: :code:`sky_workdir` and find your code. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor suggestion, feel free to ignore - this one-liner code --remote ssh-remote+<cluster_name> '/home/sky/sky_workdir'
may be easier to use than clicking in menus
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point! It seems that we can not easily determine the home path for '/home/sky/sky_workdir' on different clouds. I am going to leave this out for now. Will try to add this later.
Replace the jupyter doc with interactive development.
Tested (run the relevant ones):
bash format.sh
pytest tests/test_smoke.py
pytest tests/test_smoke.py::test_fill_in_the_name
conda deactivate; bash -i tests/backward_compatibility_tests.sh