Docs revamp: polishing landing docs. #3797
Conversation
| @@ -58,10 +59,18 @@ Current supported providers (AWS, GCP, Azure, OCI, Lambda Cloud, RunPod, Fluidst | |||
| </picture> | |||
| </p> | |||
|
|
|||
| More Information | |||
| -------------------------- | |||
| Ready to get started? | |||
There was a problem hiding this comment.
Reducing words:
| Ready to get started? | |
| Getting started |
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 Getting started as well, as it is more standard in other library's docs.
There was a problem hiding this comment.
Want to experiment with this question tone.
| @@ -177,6 +179,8 @@ Runnable examples: | |||
| - Add yours here & see more in [`llm/`](./llm)! | |||
| - Framework examples: [PyTorch DDP](https://github.com/skypilot-org/skypilot/blob/master/examples/resnet_distributed_torch.yaml), [DeepSpeed](./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), [Ray Train](examples/distributed_ray_train/ray_train.yaml), [NeMo](https://github.com/skypilot-org/skypilot/blob/master/examples/nemo/nemo.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 (`examples/`)](./examples). | |||
|
|
|||
| Case Studies and Integrations: [Community Spotlights](https://blog.skypilot.co/community/) | |||
There was a problem hiding this comment.
nit: We can perhaps sublist the ([Introductory blog post](https://blog.skypilot.co/introducing-skypilot/)) at L187 under the bullet point [SkyPilot Blog](https://blog.skypilot.co/) just like how it's done for the bulletpoint for LLMs on Skypilot and its sublist.
There was a problem hiding this comment.
Intention was to keep it that page shorter
| @@ -177,6 +179,8 @@ Runnable examples: | |||
| - Add yours here & see more in [`llm/`](./llm)! | |||
There was a problem hiding this comment.
| - Add yours here & see more in [`llm/`](./llm)! | |
| - Add yours here & see more in [`llm/`](./llm) |
nit: '/!' doesn't look clean.
README.md
Outdated
|
|
||
| <details> | ||
| <summary>Archived</summary> | ||
|
|
||
| - [June, 2023] Serving LLM 24x Faster On the Cloud [**with vLLM**](https://vllm.ai/) and SkyPilot: [**example**](./llm/vllm/), [**blog post**](https://blog.skypilot.co/serving-llm-24x-faster-on-the-cloud-with-vllm-and-skypilot/) |
There was a problem hiding this comment.
Do we want to keep this chronological order?
There was a problem hiding this comment.
Good catch, done.
| @@ -58,10 +59,18 @@ Current supported providers (AWS, GCP, Azure, OCI, Lambda Cloud, RunPod, Fluidst | |||
| </picture> | |||
| </p> | |||
|
|
|||
| More Information | |||
| -------------------------- | |||
| Ready to get started? | |||
There was a problem hiding this comment.
Slightly leaning towards Getting started as well, as it is more standard in other library's docs.
Preview: https://skypilot.readthedocs.io/en/docs-revamp-tmp2/docs/index.html
Tested (run the relevant ones):
bash format.shpytest tests/test_smoke.pypytest tests/test_smoke.py::test_fill_in_the_nameconda deactivate; bash -i tests/backward_compatibility_tests.sh