Docs revamp: polishing landing docs. #3797
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -2,52 +2,53 @@ Welcome to SkyPilot! | |||||
| ==================== | ||||||
|
|
||||||
| .. image:: /_static/SkyPilot_wide_dark.svg | ||||||
| :width: 50% | ||||||
| :align: center | ||||||
| :alt: SkyPilot | ||||||
| :class: no-scaled-link, only-dark | ||||||
| .. image:: /_static/SkyPilot_wide_light.svg | ||||||
| :width: 50% | ||||||
| :align: center | ||||||
| :alt: SkyPilot | ||||||
| :class: no-scaled-link, only-light | ||||||
|
|
||||||
|
|
||||||
| .. raw:: html | ||||||
|
|
||||||
| <p></p> | ||||||
| <p style="text-align:center"> | ||||||
| <strong>Run AI on Any Infra</strong> — Unified, Faster, Cheaper | ||||||
| </p> | ||||||
| <p style="text-align:center"> | ||||||
| <a class="github-button" href="https://github.com/skypilot-org/skypilot" data-show-count="true" data-size="large" aria-label="Star skypilot-org/skypilot on GitHub">Star</a> | ||||||
| <a class="github-button" href="https://github.com/skypilot-org/skypilot/subscription" data-icon="octicon-eye" data-size="large" aria-label="Watch skypilot-org/skypilot on GitHub">Watch</a> | ||||||
| <a class="github-button" href="https://github.com/skypilot-org/skypilot/fork" data-icon="octicon-repo-forked" data-size="large" aria-label="Fork skypilot-org/skypilot on GitHub">Fork</a> | ||||||
| <a class="reference external image-reference" style="vertical-align:9.5px" href="http://slack.skypilot.co"><img src="https://img.shields.io/badge/SkyPilot-Join%20Slack-blue?logo=slack" style="height:27px"></a> | ||||||
| <script async defer src="https://buttons.github.io/buttons.js"></script> | ||||||
| </p> | ||||||
|
|
||||||
|
|
||||||
| SkyPilot is a framework for running AI and batch workloads on any infra, offering unified execution, high cost savings, and high GPU availability. | ||||||
|
|
||||||
| SkyPilot **abstracts away infra burdens**: | ||||||
|
|
||||||
| - Launch :ref:`dev clusters <dev-cluster>`, :ref:`jobs <managed-jobs>`, and :ref:`serving <sky-serve>` on any infra | ||||||
| - Easy job management: queue, run, and auto-recover many jobs | ||||||
|
|
||||||
| SkyPilot **supports multiple clusters, clouds, and hardware** (`the Sky <https://arxiv.org/abs/2205.07147>`_): | ||||||
|
|
||||||
| - Bring your reserved GPUs, Kubernetes clusters, or 12+ clouds | ||||||
| - :ref:`Flexible provisioning <auto-failover>` of GPUs, TPUs, CPUs, with auto-retry | ||||||
|
|
||||||
| SkyPilot **cuts your cloud costs & maximizes GPU availability**: | ||||||
|
|
||||||
| * :ref:`Autostop <auto-stop>`: automatic cleanup of idle resources | ||||||
| * :ref:`Managed Spot <managed-jobs>`: 3-6x cost savings using spot instances, with preemption auto-recovery | ||||||
| * :ref:`Optimizer <auto-failover>`: 2x cost savings by auto-picking the cheapest & most available infra | ||||||
|
|
||||||
| SkyPilot supports your existing GPU, TPU, and CPU workloads, with no code changes. | ||||||
|
|
||||||
| :ref:`Current supported infra <installation>` (Kubernetes; AWS, GCP, Azure, OCI, Lambda Cloud, Fluidstack, RunPod, Cudo, Paperspace, Cloudflare, Samsung, IBM, VMware vSphere): | ||||||
|
|
||||||
| .. raw:: html | ||||||
|
|
||||||
|
|
@@ -58,10 +59,20 @@ Current supported providers (AWS, GCP, Azure, OCI, Lambda Cloud, RunPod, Fluidst | |||||
| </picture> | ||||||
| </p> | ||||||
|
|
||||||
| Ready to get started? | ||||||
|
There was a problem hiding this comment. Reducing words:
Suggested change
Also it might be ok to remove this section altogether. Not feeling strongly There was a problem hiding this comment. Kind of feeling the question form is more attractive. There was a problem hiding this comment. Slightly leaning towards There was a problem hiding this comment. Want to experiment with this question tone. |
||||||
| ---------------------- | ||||||
|
|
||||||
| :ref:`Install SkyPilot <installation>` in ~1 minute. Then, launch your first dev cluster in ~5 minutes in :ref:`Quickstart <quickstart>`. | ||||||
|
|
||||||
| Everything is launched within your cloud accounts, VPCs, and cluster(s). | ||||||
|
|
||||||
| Contact the SkyPilot team | ||||||
| --------------------------------- | ||||||
|
|
||||||
| You can chat with the SkyPilot team and community on the `SkyPilot Slack <http://slack.skypilot.co>`_. | ||||||
|
|
||||||
| Learn more | ||||||
| -------------------------- | ||||||
|
|
||||||
| Runnable examples: | ||||||
|
|
||||||
|
|
@@ -93,6 +104,10 @@ Runnable examples: | |||||
|
|
||||||
| * Framework examples: `PyTorch DDP <https://github.com/skypilot-org/skypilot/blob/master/examples/resnet_distributed_torch.yaml>`_, `DeepSpeed <https://github.com/skypilot-org/skypilot/blob/master/examples/deepspeed-multinode/sky.yaml>`_, `JAX/Flax on TPU <https://github.com/skypilot-org/skypilot/blob/master/examples/tpu/tpuvm_mnist.yaml>`_, `Stable Diffusion <https://github.com/skypilot-org/skypilot/tree/master/examples/stable_diffusion>`_, `Detectron2 <https://github.com/skypilot-org/skypilot/blob/master/examples/detectron2_docker.yaml>`_, `Distributed <https://github.com/skypilot-org/skypilot/blob/master/examples/resnet_distributed_tf_app.py>`_ `TensorFlow <https://github.com/skypilot-org/skypilot/blob/master/examples/resnet_app_storage.yaml>`_, `NeMo <https://github.com/skypilot-org/skypilot/blob/master/examples/nemo/nemo_gpt_train.yaml>`_, `programmatic grid search <https://github.com/skypilot-org/skypilot/blob/master/examples/huggingface_glue_imdb_grid_search_app.py>`_, `Docker <https://github.com/skypilot-org/skypilot/blob/master/examples/docker/echo_app.yaml>`_, `Cog <https://github.com/skypilot-org/skypilot/blob/master/examples/cog/>`_, `Unsloth <https://github.com/skypilot-org/skypilot/blob/master/examples/unsloth/unsloth.yaml>`_, `Ollama <https://github.com/skypilot-org/skypilot/blob/master/llm/ollama>`_, `llm.c <https://github.com/skypilot-org/skypilot/tree/master/llm/gpt-2>`__ and `many more <https://github.com/skypilot-org/skypilot/tree/master/examples>`_. | ||||||
|
|
||||||
| Case Studies and Integrations: `Community Spotlights <https://blog.skypilot.co/community/>`_ | ||||||
|
|
||||||
| Tutorials: `SkyPilot Tutorials <https://github.com/skypilot-org/skypilot-tutorial>`_ | ||||||
|
|
||||||
| Follow updates: | ||||||
|
|
||||||
| * `Twitter <https://twitter.com/skypilot_org>`_ | ||||||
|
|
@@ -106,10 +121,9 @@ Read the research: | |||||
| * `Sky Computing vision paper <https://sigops.org/s/conferences/hotos/2021/papers/hotos21-s02-stoica.pdf>`_ (HotOS 2021) | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| .. toctree:: | ||||||
| :hidden: | ||||||
| :maxdepth: 1 | ||||||
| :caption: Getting Started | ||||||
|
|
||||||
|
|
@@ -120,6 +134,7 @@ Contents | |||||
|
|
||||||
|
|
||||||
| .. toctree:: | ||||||
| :hidden: | ||||||
| :maxdepth: 1 | ||||||
| :caption: Running Jobs | ||||||
|
|
||||||
|
|
@@ -130,6 +145,7 @@ Contents | |||||
| ../running-jobs/distributed-jobs | ||||||
|
|
||||||
| .. toctree:: | ||||||
| :hidden: | ||||||
| :maxdepth: 1 | ||||||
| :caption: SkyServe: Model Serving | ||||||
|
|
||||||
|
|
@@ -138,6 +154,7 @@ Contents | |||||
| ../serving/service-yaml-spec | ||||||
|
|
||||||
| .. toctree:: | ||||||
| :hidden: | ||||||
| :maxdepth: 1 | ||||||
| :caption: Cutting Cloud Costs | ||||||
|
|
||||||
|
|
@@ -146,13 +163,15 @@ Contents | |||||
| ../reference/benchmark/index | ||||||
|
|
||||||
| .. toctree:: | ||||||
| :hidden: | ||||||
| :maxdepth: 1 | ||||||
| :caption: Using Data | ||||||
|
|
||||||
| ../examples/syncing-code-artifacts | ||||||
| ../reference/storage | ||||||
|
|
||||||
| .. toctree:: | ||||||
| :hidden: | ||||||
| :maxdepth: 1 | ||||||
| :caption: User Guides | ||||||
|
|
||||||
|
|
@@ -165,13 +184,15 @@ Contents | |||||
|
|
||||||
|
|
||||||
| .. toctree:: | ||||||
| :hidden: | ||||||
| :maxdepth: 1 | ||||||
| :caption: Developer Guides | ||||||
|
|
||||||
| ../developers/CONTRIBUTING | ||||||
| Guide: Adding a New Cloud <https://docs.google.com/document/d/1oWox3qb3Kz3wXXSGg9ZJWwijoa99a3PIQUHBR8UgEGs/edit?usp=sharing> | ||||||
|
|
||||||
| .. toctree:: | ||||||
| :hidden: | ||||||
| :maxdepth: 1 | ||||||
| :caption: Cloud Admin and Usage | ||||||
|
|
||||||
|
|
@@ -180,6 +201,7 @@ Contents | |||||
| ../cloud-setup/quota | ||||||
|
|
||||||
| .. toctree:: | ||||||
| :hidden: | ||||||
| :maxdepth: 1 | ||||||
| :caption: References | ||||||
|
|
||||||
|
|
||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| .. _dev-cluster: | ||
|
|
||
| Start a Development Cluster | ||
| =========================== | ||
|
|
||
|
|
@@ -90,7 +92,7 @@ SSH | |
| SkyPilot will automatically configure the SSH setting for a cluster, so that users can connect to the cluster with the cluster name: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| ssh dev | ||
|
|
||
|
|
||
|
|
@@ -99,7 +101,7 @@ SkyPilot will automatically configure the SSH setting for a cluster, so that use | |
| VSCode | ||
| ~~~~~~ | ||
|
|
||
| A common use case for interactive development is to connect a local IDE to a remote cluster and directly edit code that lives on the cluster. | ||
| This is supported by simply connecting VSCode to the cluster with the cluster name: | ||
|
|
||
| #. Click on the top bar, type: :code:`> remote-ssh`, and select :code:`Remote-SSH: Connect Current Window to Host...` | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Do we want to keep this chronological order?
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 catch, done.