 macOS Install

Requirements

The kaos command-line utility is used for all interactions. It is rather lightweight but requires the following (and on your PATH) based on the assumed persona - Data Scientist vs. Superhero. Check kaos personas for more information

Data Scientist
Superhero
Data Scientist
  • jq for processing JSON

    brew install jq
  • coreutils for additional core utilities

    brew install coreutils
  • graphviz for visualization of data provenance

    brew install graphviz
  • python 3.7 for running all kaos commands

    brew install python3
Superhero
  • jq for processing JSON

    brew install jq
  • coreutils for additional core utilities

    brew install coreutils
  • graphviz for visualization of data provenance

    brew install graphviz
  • docker for dynamic linking of docker registry (function of kaos build deploy)

    brew install docker
  • kubectl for interacting with the kaos cluster

    export version=$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)
    curl -LO "https://storage.googleapis.com/kubernetes-release/release/${version}/bin/darwin/amd64/kubectl"
    chmod +x kubectl
    mv kubectl /usr/local/bin/
  • Terraform for building entire infrastructure as IaC (see Deploying Infrastructure)

    brew install terraform
  • python 3.7 for running all kaos commands

    brew install python3
  • awscli for deploying infrastructure on AWS [OPTIONAL]

    pip3 install awscli
  • aws authenticator **for deploying Kubernetes (EKS) in AWS [OPTIONAL]**

    brew install aws-iam-authenticator
  • gcloud for deploying infrastructure on GCP [OPTIONAL]

    export CLOUD_SDK_VERSION=267.0.0
    curl -O https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-sdk-${CLOUD_SDK_VERSION}-darwin-x86_64.tar.gz
    tar zxvf google-cloud-sdk-${CLOUD_SDK_VERSION}-darwin-x86_64.tar.gz google-cloud-sdk
    rm google-cloud-sdk-${CLOUD_SDK_VERSION}-darwin-x86_64.tar.gz
    export PATH=./google-cloud-sdk/bin:$PATH
    gcloud --version

Installation

kaos supports two installation methods based on the desired simplicity and environment.

Methods

Description

Automatic [Recommended]

Isolated dependencies with a virtual environment (requires pipenv)

Manual [Advanced]

Manual installation without a virtual environment

Note that the following installation steps assume the kaos repository is accessed by HTTPS

The recommended installation of kaos is done automatically within a virtual environment using pipenv. The following steps will ensure a successful isolated installation of kaos.

git clone https://github.com/KI-labs/kaos.git
cd ./kaos
pipenv install && pipenv shell

An isolated installation of kaos within a virtual environment is the ideal installation

Manual Installation [Advanced]

The following steps will ensure a successful installation of kaos.

git clone https://github.com/KI-labs/kaos.git
cd ./kaos
cd model && python3 setup.py install
cd ../cli && python3 setup.py install

Successful Installation

Running kaos will greet the user with the following response.

Refer to Quick Start for hands-on experience with training and serving a model within kaos.