From ef9b27df32810d5261038682d2bc6bfd887d13e3 Mon Sep 17 00:00:00 2001 From: David Eliahu Date: Sat, 27 Jun 2020 16:14:00 -0700 Subject: [PATCH 1/5] Update install docs --- docs/cluster-management/install.md | 34 ++++++++++++++---------------- docs/cluster-management/update.md | 5 ----- 2 files changed, 16 insertions(+), 23 deletions(-) diff --git a/docs/cluster-management/install.md b/docs/cluster-management/install.md index 21515c4e7b..6a96abc7de 100644 --- a/docs/cluster-management/install.md +++ b/docs/cluster-management/install.md @@ -2,36 +2,29 @@ _WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_ -## Running on your machine or a single instance - -[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. - -### Install the CLI +## Install the CLI ```bash bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/master/get-cli.sh)" ``` -Continue to [deploy an example](#deploy-an-example) below. +_Note: you must also have [Docker](https://docs.docker.com/install) installed to run Cortex locally or on AWS._ -## Running at scale on AWS +If you are planning to only run Cortex locally, skip to [deploy an example](#deploy-an-example) below. -[Docker](https://docs.docker.com/install) and valid [AWS credentials](aws-credentials.md) are required to run a Cortex cluster on AWS. - -### Spin up a cluster +## Running at scale on AWS -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. +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`. -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. +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. - ```bash -# install the CLI on your machine -bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/master/get-cli.sh)" - -# provision infrastructure on AWS and spin up a cluster +# create a Cortex cluster on your AWS account cortex cluster up + +# set the default CLI environment +cortex env default aws ``` ## Deploy an example @@ -65,4 +58,9 @@ curl -X POST -H "Content-Type: application/json" \ cortex delete iris-classifier ``` -See [uninstall](uninstall.md) if you'd like to spin down your cluster. +## Next steps + +* Try the [tutorial](../../examples/sklearn/iris-classifier/README.md) to learn more about how to use Cortex +* Deploy one of our [examples](https://github.com/cortexlabs/cortex/tree/0.18/examples) +* See our [exporting docs](../deployments/exporting.md) for how to export your model to use in an API +* See [uninstall](uninstall.md) if you'd like to spin down your cluster diff --git a/docs/cluster-management/update.md b/docs/cluster-management/update.md index 915045fabc..657a899840 100644 --- a/docs/cluster-management/update.md +++ b/docs/cluster-management/update.md @@ -2,11 +2,6 @@ _WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_ -## Prerequisites - -1. [Docker](https://docs.docker.com/install) -2. [AWS credentials](aws-credentials.md) - ## Updating your cluster configuration See [cluster configuration](config.md) to learn how you can customize your cluster. From 7165b4a354fb21bbe88e277b15fb1374a527e71e Mon Sep 17 00:00:00 2001 From: David Eliahu Date: Sat, 27 Jun 2020 18:50:27 -0700 Subject: [PATCH 2/5] Update install.md --- docs/cluster-management/install.md | 43 +++++++++++++++--------------- 1 file changed, 22 insertions(+), 21 deletions(-) diff --git a/docs/cluster-management/install.md b/docs/cluster-management/install.md index 6a96abc7de..641c8099ed 100644 --- a/docs/cluster-management/install.md +++ b/docs/cluster-management/install.md @@ -9,23 +9,7 @@ _WARNING: you are on the master branch, please refer to the docs on the branch t bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/master/get-cli.sh)" ``` -_Note: you must also have [Docker](https://docs.docker.com/install) installed to run Cortex locally or on AWS._ - -If you are planning to only run Cortex locally, skip to [deploy an example](#deploy-an-example) below. - -## Running at scale on AWS - -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`. - -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. - -```bash -# create a Cortex cluster on your AWS account -cortex cluster up - -# set the default CLI environment -cortex env default aws -``` +You must also have [Docker](https://docs.docker.com/install) installed to run Cortex locally or to create a cluster on AWS. ## Deploy an example @@ -58,9 +42,26 @@ curl -X POST -H "Content-Type: application/json" \ cortex delete iris-classifier ``` +## Running at scale on AWS + +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`. + +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. + +```bash +# create a Cortex cluster on your AWS account +cortex cluster up + +# set the default CLI environment (optional) +cortex env default aws +``` + +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). + ## Next steps -* Try the [tutorial](../../examples/sklearn/iris-classifier/README.md) to learn more about how to use Cortex -* Deploy one of our [examples](https://github.com/cortexlabs/cortex/tree/0.18/examples) -* See our [exporting docs](../deployments/exporting.md) for how to export your model to use in an API -* See [uninstall](uninstall.md) if you'd like to spin down your cluster + +* Try the [tutorial](../../examples/sklearn/iris-classifier/README.md) to learn more about how to use Cortex. +* Deploy one of our [examples](https://github.com/cortexlabs/cortex/tree/master/examples). +* See our [exporting docs](../deployments/exporting.md) for how to export your model to use in an API. +* See [uninstall](uninstall.md) if you'd like to spin down your cluster. From 655e8db181c674241824808322437a81395419e7 Mon Sep 17 00:00:00 2001 From: David Eliahu Date: Sat, 27 Jun 2020 18:53:39 -0700 Subject: [PATCH 3/5] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 65586a0eb3..c7b98f4881 100644 --- a/README.md +++ b/README.md @@ -43,11 +43,12 @@ Cortex makes deploying, scaling, and managing machine learning systems in produc ### Install - + ```bash bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/0.18/get-cli.sh)" ``` + See our [installation guide](https://docs.cortex.dev/install), then deploy one of our [examples](https://github.com/cortexlabs/cortex/tree/0.18/examples) or bring your own models to build [custom APIs](https://docs.cortex.dev/deployments/exporting). ### Learn more From d7a02e1eeb358fee44a90bbab982a02bf8a755da Mon Sep 17 00:00:00 2001 From: David Eliahu Date: Sat, 27 Jun 2020 18:54:01 -0700 Subject: [PATCH 4/5] Update install.md --- docs/cluster-management/install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cluster-management/install.md b/docs/cluster-management/install.md index 641c8099ed..f580727c75 100644 --- a/docs/cluster-management/install.md +++ b/docs/cluster-management/install.md @@ -56,7 +56,7 @@ cortex cluster up cortex env default aws ``` -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). +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). ## Next steps From cec857cb701970677a335db440d7f5455627c1c9 Mon Sep 17 00:00:00 2001 From: David Eliahu Date: Sat, 27 Jun 2020 18:57:45 -0700 Subject: [PATCH 5/5] Update install.md --- docs/cluster-management/install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cluster-management/install.md b/docs/cluster-management/install.md index f580727c75..2c05dbbc5a 100644 --- a/docs/cluster-management/install.md +++ b/docs/cluster-management/install.md @@ -9,7 +9,7 @@ _WARNING: you are on the master branch, please refer to the docs on the branch t bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/master/get-cli.sh)" ``` -You must also have [Docker](https://docs.docker.com/install) installed to run Cortex locally or to create a cluster on AWS. +You must have [Docker](https://docs.docker.com/install) installed to run Cortex locally or to create a cluster on AWS. ## Deploy an example