New project name: SkyPilot (skypilot-org#1005)

* First pass through top level files under sky/

* WIP working through sky/spot/ & other files

* README: name change

* Name change in docs/source/.

* env var rename: 'SKYPILOT_DISABLE_USAGE_COLLECTION'

* env var rename to SKYPILOT_DEV

* setup.py

* Fix wheel update problem: specify <pkg>-*.whl in many places.

* pylint, constants.py, format, fix tests

* Remove debug remnants

* Markdown changes: ag -w sky **/*.md

* More renaming, mostly examples/.

Author: concretevitamin

README.md

@@ -1,27 +1,27 @@
-# Sky
+# SkyPilot
 
 ![pytest](https://github.com/sky-proj/sky/actions/workflows/pytest.yml/badge.svg)
 
-Sky is a framework to run any workload seamlessly across different cloud providers through a unified interface. No knowledge of cloud offerings is required or expected – you simply define the workload and its resource requirements, and Sky will automatically execute it on AWS, Google Cloud Platform or Microsoft Azure.
+SkyPilot is a framework to run any workload seamlessly across different cloud providers through a unified interface. No knowledge of cloud offerings is required or expected – you simply define the workload and its resource requirements, and SkyPilot will automatically execute it on AWS, Google Cloud Platform or Microsoft Azure.
 
 <!-- TODO: We need a logo here -->
 ## Getting Started
 Please refer to our [documentation](https://sky-proj-sky.readthedocs-hosted.com/en/latest/).
 - [Installation](https://sky-proj-sky.readthedocs-hosted.com/en/latest/getting-started/installation.html)
 - [Quickstart](https://sky-proj-sky.readthedocs-hosted.com/en/latest/getting-started/quickstart.html)
-- [Sky CLI](https://sky-proj-sky.readthedocs-hosted.com/en/latest/reference/cli.html)
+- [CLI](https://sky-proj-sky.readthedocs-hosted.com/en/latest/reference/cli.html)
 
 ## Developer Guide
 ### Setup
 Use editable mode (`-e`) when installing:
 ```bash
-# Sky requires python >= 3.6 and < 3.10.
+# SkyPilot requires python >= 3.6 and < 3.10.
 # You can just install the dependencies for
 # certain clouds, e.g., ".[aws,azure,gcp]"
 pip install -e ".[all]"
 pip install -r requirements-dev.txt
 ```
-IMPORTANT: Please `export SKY_DEV=1` before running the sky commands in the terminal, so that the developing log will not pollute the actual user logs.
+IMPORTANT: Please `export SKYPILOT_DEV=1` before running the CLI commands in the terminal, so that developers' usage logs do not pollute the actual user logs.
 
 
 ### Submitting pull requests
@@ -31,15 +31,15 @@ IMPORTANT: Please `export SKY_DEV=1` before running the sky commands in the term
 - Follow the [Google style guide](https://google.github.io/styleguide/pyguide.html).
 
 
-### Environment Variable Options
-- `export SKY_DEV=1` to send the logs to dev space.
-- `export SKY_DEBUG=1` to show debugging logs (logging.DEBUG).
-- `export SKY_DISABLE_USAGE_COLLECTION=1` to disable usage logging.
-- `export SKY_MINIMIZE_LOGGING=1` to minimize the sky outputs for demo purpose.
+### Environment variables for developers
+- `export SKYPILOT_DEV=1` to send usage logs to dev space.
+- `export SKYPILOT_DISABLE_USAGE_COLLECTION=1` to disable usage logging.
+- `export SKYPILOT_DEBUG=1` to show debugging logs (use logging.DEBUG level).
+- `export SKYPILOT_MINIMIZE_LOGGING=1` to minimize the logging for demo purpose.
 
 ### Dump timeline
 
-Timeline is useful for performance analysis and debugging in Sky.
+Timeline is useful for performance analysis and debugging in SkyPilot.
 
 Here are the APIs:
 
@@ -67,12 +67,12 @@ with timeline.FileLockEvent(lockpath):
   pass
 ```
 
-To dump the timeline, set environment variable `SKY_TIMELINE_FILE_PATH` to a file path.
+To dump the timeline, set environment variable `SKYPILOT_TIMELINE_FILE_PATH` to a file path.
 
 View the dumped timeline file using `Chrome` (chrome://tracing) or [Perfetto](https://ui.perfetto.dev/).
 
-### Updating the sky docker image
-1. Authenticate with sky ECR repository. Contact [email protected] for access:
+### Updating the SkyPilot docker image
+1. Authenticate with SkyPilot ECR repository. Contact [email protected] for access:
    ```
    aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws/a9w6z7w5
    ```

docs/README.md

@@ -1,5 +1,5 @@
-# Sky Document
-Sky sphinx docs based on RTD.
+# Documentation
+Sphinx docs based on ReadTheDocs.
 
 ## Build
 ```bash

docs/source/conf.py

@@ -9,9 +9,9 @@
 
 # -- Project information
 
-project = 'Sky'
-copyright = '2022, Sky Team'
-author = 'the Sky authors'
+project = 'SkyPilot'
+copyright = '2022, SkyPilot Team'
+author = 'the SkyPilot authors'
 
 release = '0.1'
 version = '0.1.0'

docs/source/examples/auto-failover.rst

@@ -3,7 +3,7 @@
 Auto-provisioning GPUs
 ==========================
 
-Sky comes with an *auto-failover provisioner*, which
+SkyPilot comes with an *auto-failover provisioner*, which
 **automatically retries provisioning a cluster in different regions (or
 clouds)** if the requested resources cannot be provisioned.
 Such provisioning failures can happen for a variety of reasons:
@@ -29,7 +29,7 @@ Cross-region failover
 The provisioner first retries across all regions within a task's chosen cloud.
 
 A common high-end GPU to use in deep learning is a NVIDIA V100 GPU.  These GPUs
-are often in high demand and hard to get.  Let's see how Sky's auto-failover
+are often in high demand and hard to get.  Let's see how SkyPilot's auto-failover
 provisioner handles such a request:
 
 .. code-block::

docs/source/examples/distributed-jobs.rst

@@ -3,7 +3,7 @@
 Distributed Jobs on Many VMs
 ================================================
 
-Sky supports multi-node cluster
+SkyPilot supports multi-node cluster
 provisioning and distributed execution on many VMs.
 
 For example, here is a simple PyTorch Distributed training example:
@@ -37,7 +37,7 @@ For example, here is a simple PyTorch Distributed training example:
 In the above, :code:`num_nodes: 2` specifies that this task is to be run on 2
 nodes. The :code:`setup` and :code:`run` commands are executed on both nodes.
 
-Sky exposes two environment variables to distinguish per-node commands:
+SkyPilot exposes two environment variables to distinguish per-node commands:
 
 - :code:`SKY_NODE_RANK`: rank (an integer ID from 0 to :code:`num_nodes-1`) of
   the node executing the task

docs/source/examples/gpu-jupyter.rst

@@ -2,7 +2,7 @@ GPU-backed Jupyter Notebooks
 ============================
 
 Jupyter notebooks are a useful tool for interactive development, debugging, and
-visualization. Sky makes the process of running a GPU-backed Jupyter notebook
+visualization. SkyPilot makes the process of running a GPU-backed Jupyter notebook
 simple by automatically managing provisioning and port forwarding.
 
 To get a machine with a GPU attached, we recommend using an interactive **GPU node**.
@@ -45,13 +45,13 @@ You can verify that this notebook is running on the GPU-backed instance using :c
   :width: 100%
   :alt: nvidia-smi in notebook
 
-Notebooks in Sky tasks
------------------------
-Jupyter notebooks can also be used in Sky tasks, allowing access to the full
-range of Sky's features including :ref:`mounted storage <sky-storage>` and
+Notebooks in SkyPilot tasks
+---------------------------
+Jupyter notebooks can also be used in SkyPilot tasks, allowing access to the full
+range of SkyPilot's features including :ref:`mounted storage <sky-storage>` and
 :ref:`autostop <auto-stop>`.
 
-The following :code:`jupyter.yaml` is an example of a task specification that can launch notebooks with Sky.
+The following :code:`jupyter.yaml` is an example of a task specification that can launch notebooks with SkyPilot.
 
 .. code:: yaml
 

docs/source/examples/grid-search.rst

@@ -18,10 +18,10 @@ Options used:
 - :code:`--gpus`: specify the resource requirement for each job.
 - :code:`-d` / :code:`--detach`: detach the run and logging from the terminal, allowing multiple trials to run concurrently.
 
-If there are only 4 V100 GPUs on the cluster, Sky will queue 1 job while the
+If there are only 4 V100 GPUs on the cluster, SkyPilot will queue 1 job while the
 other 4 run in parallel. Once a job finishes, the next job will begin executing
 immediately.
-Refer to :ref:`Job Queue <job-queue>` for more details on Sky's scheduling behavior.
+Refer to :ref:`Job Queue <job-queue>` for more details on SkyPilot's scheduling behavior.
 
 
 Multiple trials per GPU

docs/source/examples/iterative-dev-project.rst

@@ -4,7 +4,7 @@ Iteratively Developing a Project
 ====================================
 
 This page shows a typical workflow for iteratively developing and running a
-project on Sky.
+project on SkyPilot.
 
 Getting an interactive node
 ----------------------------
@@ -45,7 +45,7 @@ Alternatively, the user can directly :code:`ssh` into the cluster's nodes and ru
   $ ssh dev-worker1
   $ ssh dev-worker2
 
-Sky provides easy password-less SSH access by automatically creating entries for each cluster in :code:`~/.ssh/config`.
+SkyPilot provides easy password-less SSH access by automatically creating entries for each cluster in :code:`~/.ssh/config`.
 Referring to clusters by names also allows for seamless integration with common tools
 such as :code:`scp`, :code:`rsync`, and `Visual Studio Code Remote
 <https://code.visualstudio.com/docs/remote/remote-overview>`_.

docs/source/examples/spot-jobs.rst

@@ -3,10 +3,10 @@
 Managed Spot Jobs
 ================================================
 
-Sky supports managed spot jobs that can **automatically recover from preemptions**.
+SkyPilot supports managed spot jobs that can **automatically recover from preemptions**.
 This feature **saves significant cost** (e.g., up to 70\% for GPU VMs) by making preemptible spot instances practical for long-running jobs.
 
-To maximize availability, Sky automatically finds available spot resources across regions and clouds.
+To maximize availability, SkyPilot automatically finds available spot resources across regions and clouds.
 Here is an example of BERT training job failing over different regions across AWS and GCP.
 
 .. image:: ../images/spot-training.png
@@ -15,17 +15,17 @@ Here is an example of BERT training job failing over different regions across AW
 
 Below are requirements for using managed spot jobs:
 
-(1) **Mounting code and datasets**: Local file mounts/workdir are not supported. Cloud buckets should be used to hold code and datasets, which can be satisfied by using :ref:`Sky Storage <sky-storage>`.
+(1) **Mounting code and datasets**: Local file mounts/workdir are not supported. Cloud buckets should be used to hold code and datasets, which can be satisfied by using :ref:`SkyPilot Storage <sky-storage>`.
 
-(2) **Saving and loading checkpoints**: (For ML jobs) Application code should save checkpoints periodically to a :ref:`Sky Storage <sky-storage>`-mounted cloud bucket. For job recovery,  the program should try to reload a latest checkpoint from that path when it starts.
+(2) **Saving and loading checkpoints**: (For ML jobs) Application code should save checkpoints periodically to a :ref:`SkyPilot Storage <sky-storage>`-mounted cloud bucket. For job recovery,  the program should try to reload a latest checkpoint from that path when it starts.
 
 We explain them in detail below.
 
 
 Mounting code and datasets
 --------------------------------
 
-To launch a spot job, users should upload their codebase and data to cloud buckets through :ref:`Sky Storage <sky-storage>`.
+To launch a spot job, users should upload their codebase and data to cloud buckets through :ref:`SkyPilot Storage <sky-storage>`.
 Note that the cloud buckets can be mounted to VMs in different regions/clouds and thus enable enables transparent job relaunching without user's intervention.
 The YAML below shows an example.
 
@@ -51,7 +51,7 @@ The YAML below shows an example.
 .. note::
 
   Currently :ref:`workdir <sync-code-artifacts>` and :ref:`file mounts with local files <sync-code-artifacts>` are not
-  supported for spot jobs. You can convert them to :ref:`Sky Storage <sky-storage>`.
+  supported for spot jobs. You can convert them to :ref:`SkyPilot Storage <sky-storage>`.
 
 Saving and loading checkpoints
 --------------------------------
@@ -66,7 +66,7 @@ Below is an example of mounting a bucket to :code:`/checkpoint`.
       name: # NOTE: Fill in your bucket name
       mode: MOUNT
 
-The :code:`MOUNT` mode in :ref:`Sky Storage <sky-storage>` ensures the checkpoints outputted to :code:`/checkpoint` are automatically synced to a persistent bucket.
+The :code:`MOUNT` mode in :ref:`SkyPilot Storage <sky-storage>` ensures the checkpoints outputted to :code:`/checkpoint` are automatically synced to a persistent bucket.
 Note that the application code should save program checkpoints periodically and reload those states when the job is restarted.
 This is typically achieved by reloading the latest checkpoint at the beginning of your program.
 
@@ -146,7 +146,7 @@ With the above changes, you are ready to launch a spot job with ``sky spot launc
 
     $ sky spot launch -n bert-qa bert_qa.yaml
 
-Sky will launch and start monitoring the spot job. When a preemption happens, Sky will automatically
+SkyPilot will launch and start monitoring the spot job. When a preemption happens, SkyPilot will automatically
 search for resources across regions and clouds to re-launch the job.
 
 

docs/source/examples/syncing-code-artifacts.rst

@@ -3,24 +3,24 @@
 Syncing Code and Artifacts
 ====================================
 
-Sky simplifies transferring code, data, and artifacts to and
+SkyPilot simplifies transferring code, data, and artifacts to and
 from cloud clusters:
 
 - To :ref:`upload code and project files<Uploading code and project files>` - use :code:`workdir`
 
 - To :ref:`upload files outside of workdir<Uploading files outside of workdir>` (e.g., dotfiles) - use :code:`file_mounts`
 
-- To :ref:`upload/reuse large files<Uploading or reusing large files>` (e.g., datasets) - use :ref:`Sky Storage <sky-storage>`
+- To :ref:`upload/reuse large files<Uploading or reusing large files>` (e.g., datasets) - use :ref:`SkyPilot Storage <sky-storage>`
 
-- To :ref:`download files and artifacts from a cluster<Downloading files and artifacts>` - use :ref:`Sky Storage <sky-storage>` or :code:`rsync`
+- To :ref:`download files and artifacts from a cluster<Downloading files and artifacts>` - use :ref:`SkyPilot Storage <sky-storage>` or :code:`rsync`
 
 Here, "upload" means uploading files from your local machine (or a cloud object
-store) to a Sky cluster, while "download" means the reverse direction.  The same
+store) to a SkyPilot cluster, while "download" means the reverse direction.  The same
 mechanisms work for both files and directories.
 
 Uploading code and project files
 --------------------------------------
-Sky **automatically syncs a local working directory to a cluster** on every
+SkyPilot **automatically syncs a local working directory to a cluster** on every
 :code:`sky launch` and :code:`sky exec`.  The workdir contains a project's
 code and other files, and is typically a Git folder.
 
@@ -71,7 +71,7 @@ Uploading files outside of workdir
 Use the :code:`file_mounts` field in a :ref:`task YAML <yaml-spec>` to upload to a cluster
 
 - local files outside of the working directory (e.g., dotfiles)
-- cloud object store URIs (currently, Sky supports AWS S3 and GCP GCS)
+- cloud object store URIs (currently, SkyPilot supports AWS S3 and GCP GCS)
 
 Every :code:`sky launch` invocation reruns the sync up of these files.
 
@@ -104,7 +104,7 @@ Uploading or reusing large files
 
 For large files (e.g., 10s or 100s of GBs), putting them into the workdir or a
 file_mount may be slow because they are processed by ``rsync``.  Use
-:ref:`Sky Storage <sky-storage>` (cloud object stores) to efficiently handle
+:ref:`SkyPilot Storage <sky-storage>` (cloud object stores) to efficiently handle
 large files.
 
 
@@ -119,7 +119,7 @@ Writing artifacts to object stores
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 In addition to handling datasets and other task inputs,
-:ref:`Sky Storage <sky-storage>` can also be used to directly upload artifacts
+:ref:`SkyPilot Storage <sky-storage>` can also be used to directly upload artifacts
 generated by tasks. This is achieved by creating a :code:`MOUNT` mode Storage
 mount like so in your task YAML:
 

docs/source/getting-started/installation.rst

@@ -1,11 +1,11 @@
 Installation
 ============
 
-Install Sky using pip:
+Install SkyPilot using pip:
 
 .. code-block:: console
 
-  $ # Sky requires python >= 3.6 and < 3.10.
+  $ # SkyPilot requires python >= 3.6 and < 3.10.
   $ git clone ssh://[email protected]/sky-proj/sky.git
   $ cd sky
 
@@ -17,18 +17,18 @@ Install Sky using pip:
   $ # To install AWS dependencies only:
   $ # pip install ".[aws]"
 
-Sky currently supports three major cloud providers: AWS, GCP, and Azure.  If you
+SkyPilot currently supports three major cloud providers: AWS, GCP, and Azure.  If you
 only have access to certain clouds, use any combination of
 :code:`".[aws,azure,gcp]"` (e.g., :code:`".[aws,gcp]"`) to reduce the
 dependencies installed.
 
 .. note::
 
-    For Macs, macOS >= 10.15 is required to install Sky. Apple Silicon-based devices (e.g. Apple M1) must run :code:`conda install grpcio` prior to installing Sky.
+    For Macs, macOS >= 10.15 is required to install SkyPilot. Apple Silicon-based devices (e.g. Apple M1) must run :code:`conda install grpcio` prior to installing SkyPilot.
 
 .. note::
 
-    As an alternative to installing Sky on your laptop, we also provide a Docker image as a quick way to try out Sky. See instructions below on running Sky :ref:`in a container <docker-image>`.
+    As an alternative to installing SkyPilot on your laptop, we also provide a Docker image as a quick way to try out SkyPilot. See instructions below on running SkyPilot :ref:`in a container <docker-image>`.
 
 .. _cloud-account-setup:
 
@@ -89,12 +89,12 @@ This will produce a summary like:
 
 .. code-block:: text
 
-  Checking credentials to enable clouds for Sky.
+  Checking credentials to enable clouds for SkyPilot.
     AWS: enabled
     GCP: enabled
     Azure: enabled
 
-  Sky will use only the enabled clouds to run tasks. To change this, configure cloud credentials, and run sky check.
+  SkyPilot will use only the enabled clouds to run tasks. To change this, configure cloud credentials, and run sky check.
 
 Requesting quotas for first time users
 --------------------------------------
@@ -111,8 +111,8 @@ increases before proceeding.
 Quick alternative: trying in Docker
 ------------------------------------------------------
 
-As a **quick alternative to installing Sky on your laptop**, we also provide a Docker image with Sky and
-its dependencies installed for users to quickly try out Sky. You can simply run:
+As a **quick alternative to installing SkyPilot on your laptop**, we also provide a Docker image with SkyPilot and
+its dependencies installed for users to quickly try out SkyPilot. You can simply run:
 
 .. code-block:: console