rio-chopt 1.0.2.1

This utility helps you deploy your code as an API locally on your machine

rio-cli

This utility helps you deploy your code as an API locally on your machine. It is a python based package that can be installed via pip.

Pre-requisites

1. Install Docker for desktop on your machine and make sure it is running. - Download here!
2. Install git - Download here!
3. Install python - Download here!
4. Request github and docker hub credentials by sending an email titled "Requesting access to RIO github and dockerhub" to [e-mail] with your Full Name and relevant context(client/student/DS Masterclass Practitioner etc.)

Installation From PyPI directly:

1. Start Docker

2. Create the virtual enviroment

pip install virtualenv
virtualenv venv
. venv/bin/activate

or on Windows:

pip install virtualenv
virtualenv venv
. venv\Scripts\activate

3. Install rio

pip install rio-chopt

You may now go directly to Begin

Alternatively you may choose to install From source:

1. Start Docker
2. Download the repository using the command below. You will be prompted to enter the github username and email.

git clone https://github.com/chainopt/rio-cli.git

3. Navigate to the repository folder from the command line

cd rio-cli

4. Create the virtual enviroment

pip install virtualenv
virtualenv venv
. venv/bin/activate

or on Windows:

pip install virtualenv
virtualenv venv
. venv\Scripts\activate

5. Install the rio-cli

pip install .

Begin RIO

1. Initialize RIO. Now you will be prompted to enter the docker hub username, password, and email provided to you by ChainOpt.

rio begin -l
Enter your Docker Username: ***********  
Enter your Docker Password: ***********
Enter your Docker email: ***********

You can also point to a yaml file like this:

rio begin -l -f /Users/myUser/Documents/docker-creds.yaml

Download a sample credential file here.

Note: Running rio begin -l at any time will restart the API, but packages/model APIs will not be affected.

You're now ready to deploy your first package!

Deploy a package

You can find a sample project here.

rio deploy -l path/to/package/folder

---example---
rio deploy -l /Users/[e-mail]/Documents/git/myProject

Here,

• -l (required) is for local deployment(only local is available for now)
• -n (not required) is for specifying a package name. If left out, the folder name is chosen as package name.
• -p (not required) is a port you specify for it to be spun up on(The valid range is 1024-65535). If left out, a port will be assigned.

To list Packages Uploaded and APIs Running

rio list -l

To re-deploy a package.

rio deploy -l path/to/package/folder

>Note: If you used a custom name for your package, you will have to specify it with the package name (-n) flag just like you did in rio deploy.

---example---
e.g. rio deploy -l /Users/[e-mail]/Documents/git/myUpdatedProject
or
rio deploy -l -n myCustomName /Users/[e-mail]/Documents/git/myUpdatedProject

Note: It will re-use the same port from the first deployment.

To stop a running package.

rio stop -l myProject

To stop all running packages.

rio stop -l --all

To start a stopped package.

rio start -l myProject

To start all stopped packages.

rio start -l --all

To undeploy a package.

rio undeploy -l myProject

Note: If a model API associated with this package is running, you will be asked to enter 'Y' to stop it and proceed with deleting the package.

To undeploy all packages.

rio undeploy -l --all

To end RIO

rio end -l

All background processes will be closed. rio begin -l will be required to restart.