Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mileszim committed Oct 27, 2023
1 parent a4caed8 commit 0463a2f
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 6 deletions.
1 change: 1 addition & 0 deletions ci/scripts/test_imports.sh
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ test_import "aws" "import dask_cloudprovider.aws"
test_import "azure" "import dask_cloudprovider.azure"
test_import "digitalocean" "import dask_cloudprovider.digitalocean"
test_import "gcp" "import dask_cloudprovider.gcp"
test_import "fly" "import dask_cloudprovider.fly"
2 changes: 1 addition & 1 deletion dask_cloudprovider/cloudprovider.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ cloudprovider:
token: null # API token for interacting with the Fly API
region: "lax" # Region to launch Droplets in
vm_size: "shared-cpu-1x" # Droplet size to launch, default is 1GB RAM, 1 vCPU
image: "daskdev/dask:latest-py3.10" # Operating System image to use
image: "daskdev/dask:latest" # Operating System image to use
memory_mb: 1024 # Memory in MB to use for the scheduler and workers
cpus: 1 # Number of CPUs to use for the scheduler and workers
app_name: null # Name of Fly app to use. If it is blank, a random name will be generated.
Expand Down
7 changes: 4 additions & 3 deletions dask_cloudprovider/fly/machine.py
Original file line number Diff line number Diff line change
Expand Up @@ -281,9 +281,10 @@ class FlyMachineCluster(VMCluster):
VMs in Fly.io (FLY) are referred to as machines. This cluster manager constructs a Dask cluster
running on VMs.
_Note: By default, the cluster will instantiate a new Fly.io app. The app will be deleted when
the cluster is closed. If you want to use an existing app, you can pass the app name to the
``app_name`` parameter._
.. note::
By default, the cluster will instantiate a new Fly.io app. The app will be deleted when
the cluster is closed. If you want to use an existing app, you can pass the app name to the
``app_name`` parameter.
When configuring your cluster you may find it useful to install the ``flyctl`` tool for querying the
CLY API for available options.
Expand Down
4 changes: 2 additions & 2 deletions doc/source/fly.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Fly.io
============
======

.. currentmodule:: dask_cloudprovider.fly

Expand Down Expand Up @@ -34,4 +34,4 @@ FlyMachine
----------

.. autoclass:: FlyMachineCluster
:members:
:members:

0 comments on commit 0463a2f

Please sign in to comment.