Skip to content

Commit

Permalink
Fix incorrect code blocks in installation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mkandler committed Jul 15, 2024
1 parent 127e81a commit 793f10f
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,21 @@ specific version of Python and installed packages.
For local-only development, the Runhouse base package can be installed with:

.. code-block:: shell
$ pip install runhouse
**Recommended**: To use Runhouse to launch on-demand clusters, please instead run the following command.
This additionally installs SkyPilot, which is used for launching fresh VMs through your cloud provider.

.. code-block:: shell
$ pip install "runhouse[sky]"
Alternatively, if you plan to use Runhouse with a specific cloud provider, you can install the package with
that provider's CLI included - or choose multiple providers. SkyPilot will also be included with these.

.. code-block:: shell
# Cloud-specific installation
$ pip install "runhouse[aws]"
# Include multiple providers
Expand Down Expand Up @@ -64,6 +67,7 @@ or use ``pip install "runhouse[aws]"`` to include it with the Runhouse library.
Next, configure AWS with the following command:

.. code-block:: shell
$ aws configure
You'll be prompted to enter your AWS Access ID. This can be found by logging into
Expand Down Expand Up @@ -180,7 +184,8 @@ Once you've created an account, you'll be able to access your Runhouse token on
Login to Runhouse in your terminal with the following command:

.. code-block:: shell
runhouse login
$ runhouse login
You'll be prompted to enter your token and, after your initial login, you will see the following propmts:

Expand Down

0 comments on commit 793f10f

Please sign in to comment.