README.md

Run jobs on any cloud, easily and cost effectively

---

🔥 🐪 News (March, 2023) 🐪 🔥

• Vicuna LLM chatbot trained using SkyPilot for $300 on spot instances!
• Serve your own LLaMA LLM chatbot (not finetuned) on any cloud: example, repo

---

SkyPilot is a framework for easily and cost effectively running ML workloads¹ on any cloud.

SkyPilot abstracts away the cloud infra burden:

• Launch jobs & clusters on any cloud (AWS, Azure, GCP, Lambda Cloud)
• Find scarce resources across zones/regions/clouds
• Queue jobs & use cloud object stores

SkyPilot cuts your cloud costs:

• Managed Spot: 3x cost savings using spot VMs, with auto-recovery from preemptions
• Autostop: hands-free cleanup of idle clusters
• Benchmark: find best VM types for your jobs
• Optimizer: 2x cost savings by auto-picking best prices across zones/regions/clouds

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

Install with pip (choose your clouds) or from source:

pip install "skypilot[aws,gcp,azure,lambda]"

Getting Started

You can find our documentation here.

• Installation
• Quickstart
• CLI reference

SkyPilot in 1 minute

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

Once written in this unified interface (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.

Paste the following into a file my_task.yaml:

resources:
  accelerators: V100:1  # 1x NVIDIA V100 GPU

num_nodes: 1  # Number of VMs to launch

# Working directory (optional) containing the project codebase.
# Its contents are synced to ~/sky_workdir/ on the cluster.
workdir: ~/torch_examples

# Commands to be run before executing the job.
# Typical use: pip install -r requirements.txt, git clone, etc.
setup: |
  pip install torch torchvision

# Commands to run as a job.
# Typical use: launch the main program.
run: |
  cd mnist
  python main.py --epochs 1

Prepare the workdir by cloning:

git clone https://github.com/pytorch/examples.git ~/torch_examples

Launch with sky launch (note: access to GPU instances is needed for this example):

sky launch my_task.yaml

SkyPilot then performs the heavy-lifting for you, including:

1. Find the lowest priced VM instance type across different clouds
2. Provision the VM, with auto-failover if the cloud returned capacity errors
3. Sync the local workdir to the VM
4. Run the task's setup commands to prepare the VM for running the task
5. Run the task's run commands

Refer to Quickstart to get started with SkyPilot.

Learn more

• Documentation
• Example: HuggingFace
• Tutorials
• YAML reference
• Framework examples: PyTorch DDP, Distributed TensorFlow, JAX/Flax on TPU, Stable Diffusion, Detectron2, programmatic grid search, Docker, and many more.

More information:

• Project blog
• Introductory blog post

Issues, feature requests, and questions

We are excited to hear your feedback!

• For issues and feature requests, please open a GitHub issue.
• For questions, please use GitHub Discussions.

For general discussions, join us on the SkyPilot Slack.

Contributing

We welcome and value all contributions to the project! Please refer to CONTRIBUTING for how to get involved.

Footnotes

1. While SkyPilot is currently targeted at machine learning workloads, it supports and has been used for other general batch workloads. We're excited to hear about your use case and how we can better support your requirements; please join us in this discussion! ↩