QUICKSTART

VAI Toolkit is the API for interacting with the Virtuous AI cloud platform. 



    
    

  
pip install -i https://test.pypi.org/simple/ vai-toolkit



    
    

  
from vai_toolkit import (client, pipeline, data, model)


Common Commands

These following are the most common commands, to keep in your pocket.

  1. Upload data: 

    
    
    
    
  
    data.upload_data(user_secret, pipeline_key, data, date, time,  new_columns=False, duplicates=False, new_categories=False, table_name='')

  2. Interact: 

    
    
    
    
  
    model.predict(user_secret, pipeline_key, model_key, from_date, to_date, config, option)


Definitions

Understanding the terminology below that will make development much easier.

  1. Owner: the billing account which creates the initial account

  2. Organization: an entity with resources that are isolated from other organizations

  3. Pipeline: a project with all of the pooled resources need to perform a business objective 

       - Location: Isolate data groups with their own permissions that widgets bid to and models span.

  4. Model: a model trained on data to perform on or numerous tasks (e.g. classification, prediction, or other inference)

  5. Widget: Objects used to interact with our platform in numerous ways to easily integrate with your application needs.


(See the next section for an introduction)