Update docs and examples

(cherry picked from commit 0194866)

Author: ospillinger

docs/cluster/config.md

@@ -11,57 +11,57 @@ The Cortex cluster may be configured by providing a configuration file to `corte
 aws_access_key_id: ***
 aws_secret_access_key: ***
 
-# Optional AWS credentials for the Operator which may be used to restrict its AWS access (defaults to the AWS credentials set above)
+# optional AWS credentials for the operator which may be used to restrict its AWS access (defaults to the AWS credentials set above)
 cortex_aws_access_key_id: ***
 cortex_aws_secret_access_key: ***
 
-# Instance type Cortex will use
+# AWS region
+region: us-west-2
+
+# S3 bucket
+bucket: cortex-<RANDOM_ID>
+
+# instance type
 instance_type: m5.large
 
-# Minimum number of worker instances in the cluster (must be >= 0)
+# minimum number of instances (must be >= 0)
 min_instances: 1
 
-# Maximum number of worker instances in the cluster (must be >= 1)
+# maximum number of instances (must be >= 1)
 max_instances: 5
 
-# Volume size in Gi for worker instances in the cluster (default: 50)
+# instance volume size (GB) (default: 50)
 instance_volume_size: 50
 
-# Name of the S3 bucket Cortex will use
-bucket: cortex-<RANDOM_ID>
-
-# Region Cortex will use
-region: us-west-2
-
-# Name of the CloudWatch log group Cortex will use
+# CloudWatch log group for cortex
 log_group: cortex
 
-# Name of the EKS cluster Cortex will create
+# EKS cluster name for cortex (default: cortex)
 cluster_name: cortex
 
-# Flag to enable collection of anonymous usage stats and error reports
+# whether to collect anonymous usage stats and error reports (default: true)
 telemetry: true
 
-# Flag to enable using spot instances in worker cluster (default: true)
+# whether to use spot instances in the cluster (default: true)
 spot: true
 
 spot_config:
-  # List of additional instances with identical or better specs than your primary instance type (defaults to 2 compatible instances sorted by price)
+  # additional instances with identical or better specs than the primary instance type (defaults to 2 instances sorted by price)
   instance_distribution: [t3.large, t3a.large]
 
-  # The minimum number of instances in your cluster that should be on demand (default: 0)
+  # minimum number of on demand instances (default: 0)
   on_demand_base_capacity: 0
 
-  # The percentage of on demand instances to use after the on demand base capacity has been met [0, 100] (default: 0)
+  # percentage of on demand instances to use after the on demand base capacity has been met [0, 100] (default: 0)
   on_demand_percentage_above_base_capacity: 0
 
-  # The max price for instances (defaults to the on demand price of the primary instance type)
+  # max price for instances (defaults to the on demand price of the primary instance type)
   max_price: 0.096
 
-  # The number of Spot Instance pools across which to allocate Spot instances [1, 20] (default: 2)
+  # number of spot instance pools across which to allocate spot instances [1, 20] (default: 2)
   spot_instance_pools: 2
 
-# Image paths
+# docker image paths
 image_predictor_serve: cortexlabs/predictor-serve:0.11.0
 image_predictor_serve_gpu: cortexlabs/predictor-serve-gpu:0.11.0
 image_tf_serve: cortexlabs/tf-serve:0.11.0

docs/cluster/install.md

@@ -11,10 +11,10 @@ See [cluster configuration](config.md) to learn how you can customize your clust
 
 <!-- CORTEX_VERSION_MINOR -->
 ```bash
-# Install the Cortex CLI on your machine
+# install the Cortex CLI on your machine
 bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/0.11/get-cli.sh)"
 
-# Provision infrastructure on AWS and install Cortex
+# provision infrastructure on AWS and install Cortex
 cortex cluster up
 ```
 
@@ -25,22 +25,22 @@ Note: This will create resources in your AWS account which aren't included in th
 <!-- CORTEX_VERSION_MINOR -->
 
 ```bash
-# Clone the Cortex repository
+# clone the Cortex repository
 git clone -b 0.11 https://github.com/cortexlabs/cortex.git
 
-# Navigate to the iris classifier example
+# navigate to the iris classifier example
 cd cortex/examples/sklearn/iris-classifier
 
-# Deploy the model to the cluster
+# deploy the model to the cluster
 cortex deploy
 
-# View the status of the deployment
+# view the status of the deployment
 cortex get --watch
 
-# Get the API's endpoint
+# get the API's endpoint
 cortex get classifier
 
-# Classify a sample
+# classify a sample
 curl -X POST -H "Content-Type: application/json" \
      -d '{ "sepal_length": 5.2, "sepal_width": 3.6, "petal_length": 1.4, "petal_width": 0.3 }' \
      <API endpoint>
@@ -49,7 +49,7 @@ curl -X POST -H "Content-Type: application/json" \
 ## Cleanup
 
 ```bash
-# Delete the deployment
+# delete the deployment
 cortex delete iris
 ```
 

docs/cluster/uninstall.md

@@ -10,10 +10,10 @@
 ## Uninstalling Cortex
 
 ```bash
-# Spin down the cluster
+# spin down the cluster
 cortex cluster down
 
-# Uninstall the CLI
+# uninstall the CLI
 sudo rm /usr/local/bin/cortex
 rm -rf ~/.cortex
 ```
@@ -23,14 +23,14 @@ If you modified your bash profile, you may wish to remove `source <(cortex compl
 ## Cleaning up AWS
 
 ```bash
-# Set AWS credentials
+# set AWS credentials
 export AWS_ACCESS_KEY_ID=***
 export AWS_SECRET_ACCESS_KEY=***
 
-# Delete the S3 bucket
+# delete the S3 bucket
 aws s3 ls
 aws s3 rb --force s3://<bucket-name>
 
-# Delete the log group
+# delete the log group
 aws logs describe-log-groups --log-group-name-prefix=<log_group_name> --query logGroups[*].[logGroupName] --output text | xargs -I {} aws logs delete-log-group --log-group-name {}
 ```

docs/cluster/update.md

@@ -18,15 +18,15 @@ cortex cluster update
 <!-- CORTEX_VERSION_MINOR -->
 
 ```bash
-# Spin down your cluster
+# spin down your cluster
 cortex cluster down
 
-# Update your CLI
+# update your CLI
 bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/0.11/get-cli.sh)"
 
-# Confirm version
+# confirm version
 cortex version
 
-# Spin up your cluster
+# spin up your cluster
 cortex cluster up
 ```

examples/tensorflow/image-classifier/cortex.yaml

@@ -8,3 +8,6 @@
     request_handler: handler.py
   tracker:
     model_type: classification
+  compute:
+    cpu: 1
+    gpu: 1

examples/tensorflow/sentiment-analyzer/cortex.yaml

@@ -8,3 +8,6 @@
     request_handler: handler.py
   tracker:
     model_type: classification
+  compute:
+    cpu: 1
+    gpu: 1