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] Replace jupyter with interactive dev #3516

Merged
merged 21 commits into from
May 9, 2024
Merged

Conversation

Michaelvll
Copy link
Collaborator

Replace the jupyter doc with interactive development.

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

@Michaelvll Michaelvll changed the title [Docs] Replace jupyter with iteractive dev [Docs] Replace jupyter with interactive dev May 7, 2024
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.

Looks good! Some suggestions.

docs/source/examples/interactive-development.rst Outdated Show resolved Hide resolved
docs/source/examples/interactive-development.rst Outdated Show resolved Hide resolved
docs/source/examples/interactive-development.rst Outdated Show resolved Hide resolved
docs/source/examples/interactive-development.rst Outdated Show resolved Hide resolved
Comment on lines 44 to 45
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.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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?).

Copy link
Collaborator Author

@Michaelvll Michaelvll May 8, 2024

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?

docs/source/examples/interactive-development.rst Outdated Show resolved Hide resolved
docs/source/examples/interactive-development.rst Outdated Show resolved Hide resolved
docs/source/examples/interactive-development.rst Outdated Show resolved Hide resolved
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.
Copy link
Member

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?

Copy link
Collaborator Author

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 : )

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

@Michaelvll
Copy link
Collaborator Author

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 .. contents:: will have a background color which does not look good

Comment on lines +88 to +90
#. 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.
Copy link
Collaborator

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

Copy link
Collaborator Author

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.

@Michaelvll Michaelvll merged commit 07da93b into master May 9, 2024
20 checks passed
@Michaelvll Michaelvll deleted the interactive-dev-docs branch May 9, 2024 07:33
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.

3 participants