Update docs (#1904)

Author: ospillinger

README.md

@@ -2,29 +2,25 @@
 
 <br>
 
-# Run inference at scale
-
-Cortex is an open source platform for large-scale machine learning inference workloads.
+[Website](https://www.cortex.dev) • [Slack](https://community.cortex.dev) • [Docs](https://docs.cortex.dev)
 
 <br>
 
-## Workloads
+# Model serving at scale
 
-### Realtime APIs - respond to prediction requests in real-time
+Cortex is a platform for deploying, managing, and scaling machine learning in production.
 
-* Deploy TensorFlow, PyTorch, and other models.
-* Scale to handle production workloads with server-side batching and request-based autoscaling.
-* Configure rolling updates and live model reloading to update APIs without downtime.
-* Serve many models efficiently with multi-model caching.
-* Perform A/B tests with configurable traffic splitting.
-* Stream performance metrics and structured logs to any monitoring tool.
+<br>
 
-### Batch APIs - run distributed inference on large datasets
+## Key features
 
-* Deploy TensorFlow, PyTorch, and other models.
-* Configure the number of workers and the compute resources for each worker.
-* Recover from failures with automatic retries and dead letter queues.
+* Run realtime inference, batch inference, and training workloads.
+* Deploy TensorFlow, PyTorch, ONNX, and other models to production.
+* Scale to handle production workloads with server-side batching and request-based autoscaling.
+* Configure rolling updates and live model reloading to update APIs without downtime.
+* Serve models efficiently with multi-model caching and spot / preemptible instances.
 * Stream performance metrics and structured logs to any monitoring tool.
+* Perform A/B tests with configurable traffic splitting.
 
 <br>
 
@@ -77,10 +73,3 @@ $ cortex deploy text_generator.yaml
 ```bash
 $ curl http://example.com/text-generator -X POST -H "Content-Type: application/json" -d '{"text": "hello world"}'
 ```
-
-<br>
-
-## Get started
-
-* [Install Cortex](https://docs.cortex.dev)
-* [Join our community](https://join.slack.com/t/cortex-dot-dev/shared_invite/zt-lf58axgy-0QkLZzFSSku5_Jybd9yiZQ)

cli/cmd/root.go

@@ -148,7 +148,7 @@ func initTelemetry() {
 var _rootCmd = &cobra.Command{
 	Use:     "cortex",
 	Aliases: []string{"cx"},
-	Short:   "run inference at scale",
+	Short:   "model serving at scale",
 }
 
 func Execute() {

docs/clients/install.md

@@ -26,7 +26,7 @@ pip install --upgrade cortex
 <!-- CORTEX_VERSION_README x2 -->
 ```bash
 # For example to download CLI version 0.29.0 (Note the "v"):
-$ bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/v0.29.0/get-cli.sh)"
+bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/v0.29.0/get-cli.sh)"
 ```
 
 By default, the Cortex CLI is installed at `/usr/local/bin/cortex`. To install the executable elsewhere, export the `CORTEX_INSTALL_PATH` environment variable to your desired location before running the command above.

docs/clusters/aws/networking/custom-domain.md

@@ -79,7 +79,7 @@ ssl_certificate_arn: <ARN of your certificate>
 Create a Cortex cluster:
 
 ```bash
-$ cortex cluster up --config cluster.yaml
+cortex cluster up --config cluster.yaml
 ```
 
 ## Add DNS record

docs/clusters/kubernetes/install.md

@@ -7,23 +7,23 @@ Follow the instructions for [AWS](aws/kubectl.md) or [GCP](gcp/kubectl.md).
 ## Setting credentials
 
 ```bash
-$ DOCKER_USERNAME=***
-$ DOCKER_PASSWORD=***
+DOCKER_USERNAME=***
+DOCKER_PASSWORD=***
 
-$ kubectl create secret docker-registry registry-credentials \
+kubectl create secret docker-registry registry-credentials \
     --namespace default \
     --docker-username=$DOCKER_USERNAME \
     --docker-password=$DOCKER_PASSWORD
 
-$ kubectl patch serviceaccount default --namespace default \
+kubectl patch serviceaccount default --namespace default \
     -p "{\"imagePullSecrets\": [{\"name\": \"registry-credentials\"}]}"
 ```
 
 ## Deleting credentials
 
 ```bash
-$ kubectl delete secret --namespace default registry-credentials
+kubectl delete secret --namespace default registry-credentials
 
-$ kubectl patch serviceaccount default --namespace default \
+kubectl patch serviceaccount default --namespace default \
     -p "{\"imagePullSecrets\": []}"
 ```

docs/clusters/kubernetes/uninstall.md

@@ -3,7 +3,7 @@
 ## Install the CLI
 
 ```bash
-$ pip install cortex
+pip install cortex
 ```
 
 See [here](clients/install.md) for alternative installation options.
@@ -12,9 +12,8 @@ See [here](clients/install.md) for alternative installation options.
 
 * [Launch a Cortex cluster on your AWS account](clusters/aws/install.md)
 * [Launch a Cortex cluster on your GCP account](clusters/gcp/install.md)
-* [Install Cortex on your Kubernetes cluster](clusters/kubernetes/install.md)
 
-## Run inference workloads
+## Run machine learning workloads
 
 * [Realtime API](workloads/realtime/example.md)
 * [Batch API](workloads/batch/example.md)

docs/clusters/registry.md

@@ -51,7 +51,7 @@
 
 ## Clusters
 
-* Cortex Cloud on AWS
+* AWS
   * [Install](clusters/aws/install.md)
   * [Update](clusters/aws/update.md)
   * [Security](clusters/aws/security.md)
@@ -63,13 +63,10 @@
     * [VPC peering](clusters/aws/networking/vpc-peering.md)
   * [Setting up kubectl](clusters/aws/kubectl.md)
   * [Uninstall](clusters/aws/uninstall.md)
-* Cortex Cloud on GCP
+* GCP
   * [Install](clusters/gcp/install.md)
   * [Logging](clusters/gcp/logging.md)
   * [Credentials](clusters/gcp/credentials.md)
   * [Setting up kubectl](clusters/gcp/kubectl.md)
   * [Uninstall](clusters/gcp/uninstall.md)
-* Cortex Core on Kubernetes
-  * [Install](clusters/kubernetes/install.md)
-  * [Uninstall](clusters/kubernetes/uninstall.md)
 * [Private Docker registry](clusters/registry.md)