Skip to content

Commit

Permalink
Update version comments
Browse files Browse the repository at this point in the history
  • Loading branch information
deliahu committed Mar 25, 2020
1 parent 20b4638 commit ea94a5c
Show file tree
Hide file tree
Showing 78 changed files with 57 additions and 99 deletions.
2 changes: 0 additions & 2 deletions docs/cluster-management/aws-credentials.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# AWS credentials

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

As of now, Cortex only runs on AWS. We plan to support other cloud providers in the future. If you don't have an AWS account you can get started with one [here](https://portal.aws.amazon.com/billing/signup#/start).

Follow this [tutorial](https://aws.amazon.com/premiumsupport/knowledge-center/create-access-key) to create an access key. Enable programmatic access for the IAM user, and attach the built-in `AdministratorAccess` policy to your IAM user (or see [security](security.md) for a minimal access configuration).
2 changes: 0 additions & 2 deletions docs/cluster-management/cli.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# CLI commands

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

## deploy

```text
Expand Down
2 changes: 0 additions & 2 deletions docs/cluster-management/config.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Cluster configuration

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

The Cortex cluster may be configured by providing a configuration file to `cortex cluster up` or `cortex cluster update` via the `--config` flag (e.g. `cortex cluster up --config=cluster.yaml`). Below is the schema for the cluster configuration file, with default values shown (unless otherwise specified):

<!-- CORTEX_VERSION_MINOR -->
Expand Down
2 changes: 0 additions & 2 deletions docs/cluster-management/ec2-instances.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# EC2 instances

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

You can spin up a Cortex cluster on a variety of AWS instance types. If you are unsure about which instance to pick, review these options as a starting point. This is not a comprehensive guide so please refer to the [full documentation](https://aws.amazon.com/ec2/instance-types/) on AWS for more information.

## T3 instances
Expand Down
2 changes: 0 additions & 2 deletions docs/cluster-management/install.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Install

_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)
Expand Down
2 changes: 0 additions & 2 deletions docs/cluster-management/security.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Security

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

## IAM permissions

If you are not using a sensitive AWS account and do not have a lot of experience with IAM configuration, attaching the built-in `AdministratorAccess` policy to your IAM user will make getting started much easier. If you would like to limit IAM permissions, continue reading.
Expand Down
2 changes: 0 additions & 2 deletions docs/cluster-management/spot-instances.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Spot instances

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

[Spot instances](https://aws.amazon.com/ec2/spot/) are spare capacity that AWS sells at a discount (up to 90%). The caveat is that spot instances may not always be available, and can be recalled by AWS at anytime. Cortex allows you to use spot instances in your cluster to take advantage of the discount while ensuring uptime and reliability of APIs. You can configure your cluster to use spot instances using the configuration below:

```yaml
Expand Down
2 changes: 0 additions & 2 deletions docs/cluster-management/telemetry.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Telemetry

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

By default, the Cortex CLI sends anonymous usage data to Cortex Labs.

## What data is collected?
Expand Down
2 changes: 0 additions & 2 deletions docs/cluster-management/uninstall.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Uninstall

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

## Prerequisites

1. [AWS credentials](aws-credentials.md)
Expand Down
2 changes: 0 additions & 2 deletions docs/cluster-management/update.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Update

_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)
Expand Down
2 changes: 0 additions & 2 deletions docs/deployments/api-configuration.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# API configuration

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

Once your model is [exported](exporting.md) and you've implemented a [Predictor](predictors.md), you can configure your API via a yaml file (typically named `cortex.yaml`).

Reference the section below which corresponds to your Predictor type: [Python](#python-predictor), [TensorFlow](#tensorflow-predictor), or [ONNX](#onnx-predictor).
Expand Down
2 changes: 0 additions & 2 deletions docs/deployments/autoscaling.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Autoscaling

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

Cortex autoscales your web services based on your configuration.

## Replica Parallelism
Expand Down
2 changes: 0 additions & 2 deletions docs/deployments/compute.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Compute

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

Compute resource requests in Cortex follow the syntax and meaning of [compute resources in Kubernetes](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container).

For example:
Expand Down
2 changes: 0 additions & 2 deletions docs/deployments/deployment.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# API deployment

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

Once your model is [exported](exporting.md), you've implemented a [Predictor](predictors.md), and you've [configured your API](api-configuration.md), you're ready to deploy!

## `cortex deploy`
Expand Down
2 changes: 0 additions & 2 deletions docs/deployments/exporting.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Exporting models

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

Cortex can deploy models that are exported in a variety of formats. Therefore, it is best practice to export your model by following the recommendations of your machine learning library.

Here are examples for some common ML libraries:
Expand Down
2 changes: 0 additions & 2 deletions docs/deployments/gpus.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Using GPUs

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

To use GPUs:

1. Make sure your AWS account is subscribed to the [EKS-optimized AMI with GPU Support](https://aws.amazon.com/marketplace/pp/B07GRHFXGM).
Expand Down
2 changes: 0 additions & 2 deletions docs/deployments/prediction-monitoring.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Prediction monitoring

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

`tracker` can be configured to collect API prediction metrics and display real-time stats in `cortex get <api_name>`. The tracker looks for scalar values in the response payload. If the response payload is a JSON object, `key` can be set to extract the desired scalar value.

```yaml
Expand Down
2 changes: 0 additions & 2 deletions docs/deployments/predictors.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Predictor implementation

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

Once your model is [exported](exporting.md), you can implement one of Cortex's Predictor classes to deploy your model. A Predictor is a Python class that describes how to initialize your model and use it to make predictions.

Which Predictor you use depends on how your model is exported:
Expand Down
2 changes: 0 additions & 2 deletions docs/deployments/python-packages.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Python packages

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

## PyPI packages

You can install your required PyPI packages and import them in your Python files. Cortex looks for a `requirements.txt` file in the top level Cortex project directory (i.e. the directory which contains `cortex.yaml`):
Expand Down
2 changes: 0 additions & 2 deletions docs/deployments/statuses.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# API statuses

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

| Status | Meaning |
| :--- | :--- |
| live | API is deployed and ready to serve prediction requests (at least one replica is running) |
Expand Down
2 changes: 0 additions & 2 deletions docs/deployments/system-packages.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# System packages

_WARNING: you are on the master branch, please refer to the docs on the branch that matches your `cortex version`_

Cortex uses Docker images to deploy your models. These images can be replaced with custom images that you can augment with your system packages and libraries. You will need to push your custom images to a container registry that your cluster has access to (e.g. [Docker Hub](https://hub.docker.com) or [AWS ECR](https://aws.amazon.com/ecr)).

## Create a custom image
Expand Down
2 changes: 1 addition & 1 deletion examples/keras/document-denoiser/cortex.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

- name: document-denoiser
predictor:
Expand Down
2 changes: 1 addition & 1 deletion examples/keras/document-denoiser/predictor.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

import boto3, base64, cv2, re, os, requests
import numpy as np
Expand Down
2 changes: 1 addition & 1 deletion examples/keras/document-denoiser/trainer.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"metadata": {},
"outputs": [],
"source": [
"# _WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`_\n",
"# _this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex_\n",
"\n",
"\n",
"import keras\n",
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/answer-generator/cortex.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

- name: answer-generator
predictor:
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/answer-generator/generator.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

# This file includes code which was modified from https://colab.research.google.com/drive/1KTLqiAOdKM_3RnBWfqgrvOQLqumUyOdA

Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/answer-generator/predictor.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

import wget
import torch
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/image-classifier/cortex.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

- name: image-classifier
predictor:
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/image-classifier/predictor.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

import requests
import torch
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/iris-classifier/cortex.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

- name: iris-classifier
predictor:
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/iris-classifier/model.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

import torch
import torch.nn as nn
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/iris-classifier/predictor.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

import re
import torch
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/language-identifier/cortex.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

- name: language-identifier
predictor:
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/language-identifier/predictor.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

import wget
import fasttext
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/object-detector/cortex.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

- name: object-detector
predictor:
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/object-detector/predictor.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

from io import BytesIO

Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/reading-comprehender/cortex.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

- name: reading-comprehender
predictor:
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/reading-comprehender/predictor.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

from allennlp.predictors.predictor import Predictor as AllenNLPPredictor

Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/search-completer/cortex.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

- name: search-completer
predictor:
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/search-completer/predictor.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

import torch
import regex
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/sentiment-analyzer/cortex.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

- name: sentiment-analyzer
predictor:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
},
"source": [
"# Exporting ULMFiT with fastai\n",
"WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`\n",
"this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex\n",
"\n",
"This file includes code which was modified from https://docs.fast.ai/text.html\n"
]
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/sentiment-analyzer/predictor.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

from fastai.text import *
import requests
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/text-generator/cortex.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

- name: text-generator
predictor:
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/text-generator/predictor.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

# This file includes code which was modified from https://github.com/huggingface/transformers/blob/master/examples/run_generation.py

Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/text-summarizer/cortex.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

- name: text-summarizer
predictor:
Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/text-summarizer/predictor.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

from summarizer import Summarizer

Expand Down
2 changes: 1 addition & 1 deletion examples/sklearn/iris-classifier/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Deploy a model as a web service

_WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`_
_this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex_

This example shows how to deploy a classifier trained on the famous [iris data set](https://archive.ics.uci.edu/ml/datasets/iris) using scikit-learn.

Expand Down
2 changes: 1 addition & 1 deletion examples/sklearn/iris-classifier/batch-predictor.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

import boto3
import pickle
Expand Down
2 changes: 1 addition & 1 deletion examples/sklearn/iris-classifier/cortex.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

- name: iris-classifier
predictor:
Expand Down
2 changes: 1 addition & 1 deletion examples/sklearn/iris-classifier/predictor.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

import boto3
import pickle
Expand Down
2 changes: 1 addition & 1 deletion examples/sklearn/iris-classifier/trainer.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

import boto3
import pickle
Expand Down
2 changes: 1 addition & 1 deletion examples/sklearn/mpg-estimator/cortex.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

- name: mpg-estimator
predictor:
Expand Down
2 changes: 1 addition & 1 deletion examples/sklearn/mpg-estimator/predictor.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

import mlflow.sklearn
import numpy as np
Expand Down
2 changes: 1 addition & 1 deletion examples/sklearn/mpg-estimator/trainer.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

import mlflow.sklearn
import pandas as pd
Expand Down
2 changes: 1 addition & 1 deletion examples/tensorflow/image-classifier/cortex.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`
# this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex

- name: image-classifier
predictor:
Expand Down
2 changes: 1 addition & 1 deletion examples/tensorflow/image-classifier/inception.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"source": [
"# Exporting ImageNet Inception\n",
"\n",
"_WARNING: you are on the master branch, please refer to the examples on the branch that matches your `cortex version`_\n",
"_this is an example for cortex release 0.15 and may not deploy correctly on other releases of cortex_\n",
"\n",
"In this notebook, we'll show how to export the [pre-trained Imagenet Inception model](https://tfhub.dev/google/imagenet/inception_v3/classification/3) for serving."
]
Expand Down
Loading

0 comments on commit ea94a5c

Please sign in to comment.