Skip to content

Commit 4cdb2f8

Browse files
committed
Update install docs (#1176)
(cherry picked from commit 1f2390e)
1 parent fd2d99c commit 4cdb2f8

File tree

2 files changed

+25
-31
lines changed

2 files changed

+25
-31
lines changed

docs/cluster-management/install.md

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,13 @@
11
# Install
22

3-
## Running on your machine or a single instance
4-
5-
[Docker](https://docs.docker.com/install) is required to run Cortex locally. In addition, your machine (or your Docker Desktop for Mac users) should have at least 8GB of memory if you plan to deploy large deep learning models.
6-
7-
### Install the CLI
3+
## Install the CLI
84

95
<!-- CORTEX_VERSION_MINOR -->
106
```bash
117
bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/0.18/get-cli.sh)"
128
```
139

14-
Continue to [deploy an example](#deploy-an-example) below.
15-
16-
## Running at scale on AWS
17-
18-
[Docker](https://docs.docker.com/install) and valid [AWS credentials](aws-credentials.md) are required to run a Cortex cluster on AWS.
19-
20-
### Spin up a cluster
21-
22-
See [cluster configuration](config.md) to learn how you can customize your cluster with `cluster.yaml` and see [EC2 instances](ec2-instances.md) for an overview of several EC2 instance types.
23-
24-
To use GPU nodes, you may need to subscribe to the [EKS-optimized AMI with GPU Support](https://aws.amazon.com/marketplace/pp/B07GRHFXGM) and [file an AWS support ticket](https://console.aws.amazon.com/support/cases#/create?issueType=service-limit-increase&limitType=ec2-instances) to increase the limit for your desired instance type.
25-
26-
<!-- CORTEX_VERSION_MINOR -->
27-
```bash
28-
# install the CLI on your machine
29-
bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/0.18/get-cli.sh)"
30-
31-
# provision infrastructure on AWS and spin up a cluster
32-
cortex cluster up
33-
```
10+
You must have [Docker](https://docs.docker.com/install) installed to run Cortex locally or to create a cluster on AWS.
3411

3512
## Deploy an example
3613

@@ -63,4 +40,26 @@ curl -X POST -H "Content-Type: application/json" \
6340
cortex delete iris-classifier
6441
```
6542

66-
See [uninstall](uninstall.md) if you'd like to spin down your cluster.
43+
## Running at scale on AWS
44+
45+
Run the command below to create a cluster with basic configuration, or see [cluster configuration](config.md) to learn how you can customize your cluster with `cluster.yaml`.
46+
47+
See [EC2 instances](ec2-instances.md) for an overview of several EC2 instance types. To use GPU nodes, you may need to subscribe to the [EKS-optimized AMI with GPU Support](https://aws.amazon.com/marketplace/pp/B07GRHFXGM) and [file an AWS support ticket](https://console.aws.amazon.com/support/cases#/create?issueType=service-limit-increase&limitType=ec2-instances) to increase the limit for your desired instance type.
48+
49+
```bash
50+
# create a Cortex cluster on your AWS account
51+
cortex cluster up
52+
53+
# set the default CLI environment (optional)
54+
cortex env default aws
55+
```
56+
57+
You can now run the same commands shown above to deploy the iris classifier to AWS (if you didn't set the default CLI environment, add `--env aws` to the `cortex` commands).
58+
59+
## Next steps
60+
61+
<!-- CORTEX_VERSION_MINOR -->
62+
* Try the [tutorial](../../examples/sklearn/iris-classifier/README.md) to learn more about how to use Cortex.
63+
* Deploy one of our [examples](https://github.com/cortexlabs/cortex/tree/0.18/examples).
64+
* See our [exporting docs](../deployments/exporting.md) for how to export your model to use in an API.
65+
* See [uninstall](uninstall.md) if you'd like to spin down your cluster.

docs/cluster-management/update.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,5 @@
11
# Update
22

3-
## Prerequisites
4-
5-
1. [Docker](https://docs.docker.com/install)
6-
2. [AWS credentials](aws-credentials.md)
7-
83
## Updating your cluster configuration
94

105
See [cluster configuration](config.md) to learn how you can customize your cluster.

0 commit comments

Comments
 (0)