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 diff --git a/docs/cluster-management/install.md b/docs/cluster-management/install.md index 21515c4e7b..2c05dbbc5a 100644 --- a/docs/cluster-management/install.md +++ b/docs/cluster-management/install.md @@ -2,37 +2,14 @@ _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. - -## Running at scale on AWS - -[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 - -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. - -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 -cortex cluster up -``` +You must have [Docker](https://docs.docker.com/install) installed to run Cortex locally or to create a cluster on AWS. ## Deploy an example @@ -65,4 +42,26 @@ 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. +## 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/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. 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.