Skip to content

Commit 943a0fe

Browse files
[docs] Change urls to docs.skypilot.co, add 404 page (#4413)
* Add 404 page, change to docs.skypilot.co * lint
1 parent f0ebf13 commit 943a0fe

File tree

55 files changed

+118
-119
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+118
-119
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
</p>
77

88
<p align="center">
9-
<a href="https://skypilot.readthedocs.io/en/latest/">
9+
<a href="https://docs.skypilot.co/">
1010
<img alt="Documentation" src="https://readthedocs.org/projects/skypilot/badge/?version=latest">
1111
</a>
1212

@@ -43,7 +43,7 @@
4343
<summary>Archived</summary>
4444

4545
- [Jul 2024] [**Finetune**](./llm/llama-3_1-finetuning/) and [**serve**](./llm/llama-3_1/) **Llama 3.1** on your infra
46-
- [Apr 2024] Serve and finetune [**Llama 3**](https://skypilot.readthedocs.io/en/latest/gallery/llms/llama-3.html) on any cloud or Kubernetes: [**example**](./llm/llama-3/)
46+
- [Apr 2024] Serve and finetune [**Llama 3**](https://docs.skypilot.co/en/latest/gallery/llms/llama-3.html) on any cloud or Kubernetes: [**example**](./llm/llama-3/)
4747
- [Mar 2024] Serve and deploy [**Databricks DBRX**](https://www.databricks.com/blog/introducing-dbrx-new-state-art-open-llm) on your infra: [**example**](./llm/dbrx/)
4848
- [Feb 2024] Speed up your LLM deployments with [**SGLang**](https://github.com/sgl-project/sglang) for 5x throughput on SkyServe: [**example**](./llm/sglang/)
4949
- [Dec 2023] Using [**LoRAX**](https://github.com/predibase/lorax) to serve 1000s of finetuned LLMs on a single instance in the cloud: [**example**](./llm/lorax/)
@@ -60,17 +60,17 @@
6060
SkyPilot is a framework for running AI and batch workloads on any infra, offering unified execution, high cost savings, and high GPU availability.
6161

6262
SkyPilot **abstracts away infra burdens**:
63-
- Launch [dev clusters](https://skypilot.readthedocs.io/en/latest/examples/interactive-development.html), [jobs](https://skypilot.readthedocs.io/en/latest/examples/managed-jobs.html), and [serving](https://skypilot.readthedocs.io/en/latest/serving/sky-serve.html) on any infra
63+
- Launch [dev clusters](https://docs.skypilot.co/en/latest/examples/interactive-development.html), [jobs](https://docs.skypilot.co/en/latest/examples/managed-jobs.html), and [serving](https://docs.skypilot.co/en/latest/serving/sky-serve.html) on any infra
6464
- Easy job management: queue, run, and auto-recover many jobs
6565

6666
SkyPilot **supports multiple clusters, clouds, and hardware** ([the Sky](https://arxiv.org/abs/2205.07147)):
6767
- Bring your reserved GPUs, Kubernetes clusters, or 12+ clouds
68-
- [Flexible provisioning](https://skypilot.readthedocs.io/en/latest/examples/auto-failover.html) of GPUs, TPUs, CPUs, with auto-retry
68+
- [Flexible provisioning](https://docs.skypilot.co/en/latest/examples/auto-failover.html) of GPUs, TPUs, CPUs, with auto-retry
6969

7070
SkyPilot **cuts your cloud costs & maximizes GPU availability**:
71-
* [Autostop](https://skypilot.readthedocs.io/en/latest/reference/auto-stop.html): automatic cleanup of idle resources
72-
* [Managed Spot](https://skypilot.readthedocs.io/en/latest/examples/managed-jobs.html): 3-6x cost savings using spot instances, with preemption auto-recovery
73-
* [Optimizer](https://skypilot.readthedocs.io/en/latest/examples/auto-failover.html): 2x cost savings by auto-picking the cheapest & most available infra
71+
* [Autostop](https://docs.skypilot.co/en/latest/reference/auto-stop.html): automatic cleanup of idle resources
72+
* [Managed Spot](https://docs.skypilot.co/en/latest/examples/managed-jobs.html): 3-6x cost savings using spot instances, with preemption auto-recovery
73+
* [Optimizer](https://docs.skypilot.co/en/latest/examples/auto-failover.html): 2x cost savings by auto-picking the cheapest & most available infra
7474

7575
SkyPilot supports your existing GPU, TPU, and CPU workloads, with no code changes.
7676

@@ -79,13 +79,13 @@ Install with pip:
7979
# Choose your clouds:
8080
pip install -U "skypilot[kubernetes,aws,gcp,azure,oci,lambda,runpod,fluidstack,paperspace,cudo,ibm,scp]"
8181
```
82-
To get the latest features and fixes, use the nightly build or [install from source](https://skypilot.readthedocs.io/en/latest/getting-started/installation.html):
82+
To get the latest features and fixes, use the nightly build or [install from source](https://docs.skypilot.co/en/latest/getting-started/installation.html):
8383
```bash
8484
# Choose your clouds:
8585
pip install "skypilot-nightly[kubernetes,aws,gcp,azure,oci,lambda,runpod,fluidstack,paperspace,cudo,ibm,scp]"
8686
```
8787

88-
[Current supported infra](https://skypilot.readthedocs.io/en/latest/getting-started/installation.html) (Kubernetes; AWS, GCP, Azure, OCI, Lambda Cloud, Fluidstack, RunPod, Cudo, Paperspace, Cloudflare, Samsung, IBM, VMware vSphere):
88+
[Current supported infra](https://docs.skypilot.co/en/latest/getting-started/installation.html) (Kubernetes; AWS, GCP, Azure, OCI, Lambda Cloud, Fluidstack, RunPod, Cudo, Paperspace, Cloudflare, Samsung, IBM, VMware vSphere):
8989
<p align="center">
9090
<picture>
9191
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/skypilot-org/skypilot/master/docs/source/images/cloud-logos-dark.png">
@@ -95,16 +95,16 @@ pip install "skypilot-nightly[kubernetes,aws,gcp,azure,oci,lambda,runpod,fluidst
9595

9696

9797
## Getting Started
98-
You can find our documentation [here](https://skypilot.readthedocs.io/en/latest/).
99-
- [Installation](https://skypilot.readthedocs.io/en/latest/getting-started/installation.html)
100-
- [Quickstart](https://skypilot.readthedocs.io/en/latest/getting-started/quickstart.html)
101-
- [CLI reference](https://skypilot.readthedocs.io/en/latest/reference/cli.html)
98+
You can find our documentation [here](https://docs.skypilot.co/).
99+
- [Installation](https://docs.skypilot.co/en/latest/getting-started/installation.html)
100+
- [Quickstart](https://docs.skypilot.co/en/latest/getting-started/quickstart.html)
101+
- [CLI reference](https://docs.skypilot.co/en/latest/reference/cli.html)
102102

103103
## SkyPilot in 1 Minute
104104

105105
A SkyPilot task specifies: resource requirements, data to be synced, setup commands, and the task commands.
106106

107-
Once written in this [**unified interface**](https://skypilot.readthedocs.io/en/latest/reference/yaml-spec.html) (YAML or Python API), the task can be launched on any available cloud. This avoids vendor lock-in, and allows easily moving jobs to a different provider.
107+
Once written in this [**unified interface**](https://docs.skypilot.co/en/latest/reference/yaml-spec.html) (YAML or Python API), the task can be launched on any available cloud. This avoids vendor lock-in, and allows easily moving jobs to a different provider.
108108

109109
Paste the following into a file `my_task.yaml`:
110110

@@ -135,7 +135,7 @@ Prepare the workdir by cloning:
135135
git clone https://github.com/pytorch/examples.git ~/torch_examples
136136
```
137137

138-
Launch with `sky launch` (note: [access to GPU instances](https://skypilot.readthedocs.io/en/latest/cloud-setup/quota.html) is needed for this example):
138+
Launch with `sky launch` (note: [access to GPU instances](https://docs.skypilot.co/en/latest/cloud-setup/quota.html) is needed for this example):
139139
```bash
140140
sky launch my_task.yaml
141141
```
@@ -152,10 +152,10 @@ SkyPilot then performs the heavy-lifting for you, including:
152152
</p>
153153

154154

155-
Refer to [Quickstart](https://skypilot.readthedocs.io/en/latest/getting-started/quickstart.html) to get started with SkyPilot.
155+
Refer to [Quickstart](https://docs.skypilot.co/en/latest/getting-started/quickstart.html) to get started with SkyPilot.
156156

157157
## More Information
158-
To learn more, see [Concept: Sky Computing](https://docs.skypilot.co/en/latest/sky-computing.html), [SkyPilot docs](https://skypilot.readthedocs.io/en/latest/), and [SkyPilot blog](https://blog.skypilot.co/).
158+
To learn more, see [Concept: Sky Computing](https://docs.skypilot.co/en/latest/sky-computing.html), [SkyPilot docs](https://docs.skypilot.co/en/latest/), and [SkyPilot blog](https://blog.skypilot.co/).
159159

160160
<!-- Keep this section in sync with index.rst in SkyPilot Docs -->
161161
Runnable examples:

docs/requirements-docs.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ myst-parser==2.0.0
1010
sphinx-autodoc-typehints==1.25.2
1111
sphinx-book-theme==1.1.0
1212
sphinx-togglebutton==0.3.2
13+
sphinx-notfound-page==1.0.4
1314
sphinxcontrib-applehelp==1.0.7
1415
sphinxcontrib-devhelp==1.0.5
1516
sphinxcontrib-googleanalytics==0.4

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
'sphinxemoji.sphinxemoji',
4242
'sphinx_design',
4343
'myst_parser',
44+
'notfound.extension',
4445
]
4546

4647
intersphinx_mapping = {

docs/source/examples/managed-jobs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -499,7 +499,7 @@ To achieve the above, you can specify custom configs in :code:`~/.sky/config.yam
499499
# Specify the disk_size in GB of the jobs controller.
500500
disk_size: 100
501501
502-
The :code:`resources` field has the same spec as a normal SkyPilot job; see `here <https://skypilot.readthedocs.io/en/latest/reference/yaml-spec.html>`__.
502+
The :code:`resources` field has the same spec as a normal SkyPilot job; see `here <https://docs.skypilot.co/en/latest/reference/yaml-spec.html>`__.
503503

504504
.. note::
505505
These settings will not take effect if you have an existing controller (either

docs/source/reference/config.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Available fields and semantics:
2222
#
2323
# These take effects only when a managed jobs controller does not already exist.
2424
#
25-
# Ref: https://skypilot.readthedocs.io/en/latest/examples/managed-jobs.html#customizing-job-controller-resources
25+
# Ref: https://docs.skypilot.co/en/latest/examples/managed-jobs.html#customizing-job-controller-resources
2626
jobs:
2727
controller:
2828
resources: # same spec as 'resources' in a task YAML
@@ -478,13 +478,13 @@ Available fields and semantics:
478478
# This must be either: 'loadbalancer', 'ingress' or 'podip'.
479479
#
480480
# loadbalancer: Creates services of type `LoadBalancer` to expose ports.
481-
# See https://skypilot.readthedocs.io/en/latest/reference/kubernetes/kubernetes-setup.html#loadbalancer-service.
481+
# See https://docs.skypilot.co/en/latest/reference/kubernetes/kubernetes-setup.html#loadbalancer-service.
482482
# This mode is supported out of the box on most cloud managed Kubernetes
483483
# environments (e.g., GKE, EKS).
484484
#
485485
# ingress: Creates an ingress and a ClusterIP service for each port opened.
486486
# Requires an Nginx ingress controller to be configured on the Kubernetes cluster.
487-
# Refer to https://skypilot.readthedocs.io/en/latest/reference/kubernetes/kubernetes-setup.html#nginx-ingress
487+
# Refer to https://docs.skypilot.co/en/latest/reference/kubernetes/kubernetes-setup.html#nginx-ingress
488488
# for details on deploying the NGINX ingress controller.
489489
#
490490
# podip: Directly returns the IP address of the pod. This mode does not
@@ -513,7 +513,7 @@ Available fields and semantics:
513513
#
514514
# <string>: The name of a service account to use for all Kubernetes pods.
515515
# This service account must exist in the user's namespace and have all
516-
# necessary permissions. Refer to https://skypilot.readthedocs.io/en/latest/cloud-setup/cloud-permissions/kubernetes.html
516+
# necessary permissions. Refer to https://docs.skypilot.co/en/latest/cloud-setup/cloud-permissions/kubernetes.html
517517
# for details on the roles required by the service account.
518518
#
519519
# Using SERVICE_ACCOUNT or a custom service account only affects Kubernetes
@@ -581,7 +581,7 @@ Available fields and semantics:
581581
# gke: uses cloud.google.com/gke-accelerator label to identify GPUs on nodes
582582
# karpenter: uses karpenter.k8s.aws/instance-gpu-name label to identify GPUs on nodes
583583
# generic: uses skypilot.co/accelerator labels to identify GPUs on nodes
584-
# Refer to https://skypilot.readthedocs.io/en/latest/reference/kubernetes/kubernetes-setup.html#setting-up-gpu-support
584+
# Refer to https://docs.skypilot.co/en/latest/reference/kubernetes/kubernetes-setup.html#setting-up-gpu-support
585585
# for more details on setting up labels for GPU support.
586586
#
587587
# Default: null (no autoscaler, autodetect label format for GPU nodes)

docs/source/reference/kubernetes/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Why use SkyPilot on Kubernetes?
3939
.. grid-item-card:: 🖼 Run popular models on Kubernetes
4040
:text-align: center
4141

42-
Train and serve `Llama-3 <https://skypilot.readthedocs.io/en/latest/gallery/llms/llama-3.html>`_, `Mixtral <https://skypilot.readthedocs.io/en/latest/gallery/llms/mixtral.html>`_, and more on your Kubernetes with ready-to-use recipes from the :ref:`AI gallery <ai-gallery>`.
42+
Train and serve `Llama-3 <https://docs.skypilot.co/en/latest/gallery/llms/llama-3.html>`_, `Mixtral <https://docs.skypilot.co/en/latest/gallery/llms/mixtral.html>`_, and more on your Kubernetes with ready-to-use recipes from the :ref:`AI gallery <ai-gallery>`.
4343

4444

4545
.. tab-item:: For Infrastructure Admins

docs/source/reference/yaml-spec.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Available fields:
2323
# which `sky` is called.
2424
#
2525
# To exclude files from syncing, see
26-
# https://skypilot.readthedocs.io/en/latest/examples/syncing-code-artifacts.html#exclude-uploading-files
26+
# https://docs.skypilot.co/en/latest/examples/syncing-code-artifacts.html#exclude-uploading-files
2727
workdir: ~/my-task-code
2828
2929
# Number of nodes (optional; defaults to 1) to launch including the head node.
@@ -357,7 +357,7 @@ In additional to the above fields, SkyPilot also supports the following experime
357357
#
358358
# The following fields can be overridden. Please refer to docs of Advanced
359359
# Configuration for more details of those fields:
360-
# https://skypilot.readthedocs.io/en/latest/reference/config.html
360+
# https://docs.skypilot.co/en/latest/reference/config.html
361361
config_overrides:
362362
docker:
363363
run_options: ...

docs/source/reservations/existing-machines.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Prerequisites
4242
**Local machine (typically your laptop):**
4343

4444
* `kubectl <https://kubernetes.io/docs/tasks/tools/install-kubectl/>`_
45-
* `SkyPilot <https://skypilot.readthedocs.io/en/latest/getting-started/installation.html>`_
45+
* `SkyPilot <https://docs.skypilot.co/en/latest/getting-started/installation.html>`_
4646

4747
**Remote machines (your cluster, optionally with GPUs):**
4848

docs/source/serving/sky-serve.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -515,7 +515,7 @@ To achieve the above, you can specify custom configs in :code:`~/.sky/config.yam
515515
# Specify the disk_size in GB of the SkyServe controller.
516516
disk_size: 1024
517517
518-
The :code:`resources` field has the same spec as a normal SkyPilot job; see `here <https://skypilot.readthedocs.io/en/latest/reference/yaml-spec.html>`__.
518+
The :code:`resources` field has the same spec as a normal SkyPilot job; see `here <https://docs.skypilot.co/en/latest/reference/yaml-spec.html>`__.
519519

520520
.. note::
521521
These settings will not take effect if you have an existing controller (either

examples/airflow/shared_state/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ In this guide, we demonstrate how some simple SkyPilot operations, such as launc
1212

1313
* Airflow installed on a [Kubernetes cluster](https://airflow.apache.org/docs/helm-chart/stable/index.html) or [locally](https://airflow.apache.org/docs/apache-airflow/stable/start.html) (`SequentialExecutor`)
1414
* A Kubernetes cluster to run tasks on. We'll use GKE in this example.
15-
* You can use our guide on [setting up a Kubernetes cluster](https://skypilot.readthedocs.io/en/latest/reference/kubernetes/kubernetes-setup.html).
15+
* You can use our guide on [setting up a Kubernetes cluster](https://docs.skypilot.co/en/latest/reference/kubernetes/kubernetes-setup.html).
1616
* A persistent volume storage class should be available that supports at least `ReadWriteOnce` access mode. GKE has this supported by default.
1717

1818
## Preparing the Kubernetes Cluster
@@ -39,7 +39,7 @@ In this guide, we demonstrate how some simple SkyPilot operations, such as launc
3939
name: sky-airflow-sa
4040
namespace: default
4141
roleRef:
42-
# For minimal permissions, refer to https://skypilot.readthedocs.io/en/latest/cloud-setup/cloud-permissions/kubernetes.html
42+
# For minimal permissions, refer to https://docs.skypilot.co/en/latest/cloud-setup/cloud-permissions/kubernetes.html
4343
kind: ClusterRole
4444
name: cluster-admin
4545
apiGroup: rbac.authorization.k8s.io
@@ -163,7 +163,7 @@ with DAG(dag_id='sky_k8s_example',
163163
## Tips
164164

165165
1. **Persistent Volume**: If you have many concurrent tasks, you may want to use a storage class that supports [`ReadWriteMany`](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes) access mode.
166-
2. **Cloud credentials**: If you wish to run tasks on different clouds, you can configure cloud credentials in Kubernetes secrets and mount them in the Sky pod defined in the DAG. See [SkyPilot docs on setting up cloud credentials](https://skypilot.readthedocs.io/en/latest/getting-started/installation.html#cloud-account-setup) for more on how to configure credentials in the pod.
166+
2. **Cloud credentials**: If you wish to run tasks on different clouds, you can configure cloud credentials in Kubernetes secrets and mount them in the Sky pod defined in the DAG. See [SkyPilot docs on setting up cloud credentials](https://docs.skypilot.co/en/latest/getting-started/installation.html#cloud-account-setup) for more on how to configure credentials in the pod.
167167
3. **Logging**: All SkyPilot logs are written to container stdout, which is captured as task logs in Airflow and displayed in the UI. You can also write logs to a file and read them in subsequent tasks.
168168
4. **XComs for shared state**: Airflow also provides [XComs](https://airflow.apache.org/docs/apache-airflow/stable/concepts/xcoms.html) for cross-task communication. [`sky_k8s_example_xcoms.py`](sky_k8s_example_xcoms.py) demonstrates how to use XComs to share state between tasks.
169169

0 commit comments

Comments
 (0)