aoa 7.0.1
Python client for Teradata AnalyticOps Accelerator (AOA)
Requires Python: >=3.6

# Teradata AnalyticOps Client

- [Installation](#installation)
- [CLI](#cli)
- [SDK](#sdk)
- [Release Notes](#release-notes)


# Installation

The aoa is available from [pypi](https://pypi.org/project/aoa/)

```bash
pip install aoa
```


# CLI 

## configuration

By default, the CLI looks for configuration stored in `~/.aoa/config.yaml`. Copy the config from ModelOps UI -> Session Details -> CLI Config. This will provide the command to create or update the `config.yaml`. If required, one can override this configuration at runtime by specifying environment variables (see `api_client.py`)

## help

The cli can be used to perform a number of interactions and guides the user to perform those actions.

```bash
> aoa -h
usage: aoa [-h] [--debug] [--version] {list,add,retire,run,init,clone,link,message,connection} ...

AOA CLI

optional arguments:
  -h, --help            show this help message and exit
  --debug               Enable debug logging
  --version             Display the version of this tool

actions:
  valid actions

  {list,add,retire,run,init,clone,link,message,connection}
    list                List projects, models, local models or datasets
    add                 Add model to working dir
    run                 Train and Evaluate model locally
    init                Initialize model directory with basic structure
    clone               Clone Project Repository
    link                Link repo to Project Repository
    connection          Manage local connections
    feature             Manage feature statistics
    doctor              Diagnose configuration issues
```


## clone

The `clone` command provides a convenient way to perform a git clone of the repository associated with a given project. The command can be run interactively and will allow you to select the project you wish to clone. Note that by default it clones to the current working directory so you either need to make sure you create an empty folder and run it from within there or else provide the `--path ` argument.

```bash
> aoa clone -h
usage: aoa clone [-h] [--debug] [-id PROJECT_ID] [-p PATH]

optional arguments:
  -h, --help            show this help message and exit
  --debug               Enable debug logging
  -id PROJECT_ID, --project-id PROJECT_ID
                        Id of Project to clone
  -p PATH, --path PATH  Path to clone repository to
```

### init

When you create a git repository, its empty by default. The `init` command allows you to initialize the repository with the structure required by the AOA. It also adds a default README.md and HOWTO.md.

```bash
> aoa init -h
usage: aoa init [-h] [--debug]

optional arguments:
  -h, --help  show this help message and exit
  --debug     Enable debug logging
```

## list

Allows to list the aoa resources. In the cases of listing models (pushed / committed) and datasets, it will prompt the user to select a project prior showing the results. In the case of local models, it lists both committed and non-committed models.
```bash
> aoa list -h
usage: aoa list [-h] [--debug] [-p] [-m] [-lm] [-t] [-d] [-c]

optional arguments:
  -h, --help           show this help message and exit
  --debug              Enable debug logging
  -p, --projects       List projects
  -m, --models         List registered models (committed / pushed)
  -lm, --local-models  List local models. Includes registered and non-
                       registered (non-committed / non-pushed)
  -t, --templates      List dataset templates
  -d, --datasets       List datasets
  -c, --connections    List local connections
```
All results are shown in the format
```
[index] (id of the resource) name
```
for example:
```
List of models for project Demo:
--------------------------------
[0] (03c9a01f-bd46-4e7c-9a60-4282039094e6) Diabetes Prediction
[1] (74eca506-e967-48f1-92ad-fb217b07e181) IMDB Sentiment Analysis
```

## add

Add a new model to a given repository based on a model template. A model in any other existing ModelOps git repository (specified via the `-t <giturl>`) can be used.

```bash
> aoa add -h
usage: aoa add [-h] [--debug] -t TEMPLATE_URL -b BRANCH

optional arguments:
  -h, --help            show this help message and exit
  --debug               Enable debug logging
  -t TEMPLATE_URL, --template-url TEMPLATE_URL
                        Git URL for template repository
  -b BRANCH, --branch BRANCH
                        Git branch to pull templates
```

Example usage 
```bash
> aoa add -t https://github.com/Teradata/modelops-demo-models -b master
```

## run

The cli can be used to validate the model training and evaluation logic locally before committing to git. This simplifies the development lifecycle and allows you to test and validate many options. It also enables you to avoid creating the dataset definitions in the AOA UI until you are ready and have a finalised version.

```bash
> aoa run -h
usage: aoa run [-h] [--debug] [-id MODEL_ID] [-m MODE] [-d DATASET_ID] [-t DATASET_TEMPLATE_ID] [-ld LOCAL_DATASET]
               [-lt LOCAL_DATASET_TEMPLATE] [-c CONNECTION]

optional arguments:
  -h, --help            show this help message and exit
  --debug               Enable debug logging
  -id MODEL_ID, --model-id MODEL_ID
                        Id of model
  -m MODE, --mode MODE  Mode (train or evaluate)
  -d DATASET_ID, --dataset-id DATASET_ID
                        Remote datasetId
  -t DATASET_TEMPLATE_ID, --dataset-template-id DATASET_TEMPLATE_ID
                        Remote datasetTemplateId
  -ld LOCAL_DATASET, --local-dataset LOCAL_DATASET
                        Path to local dataset metadata file
  -lt LOCAL_DATASET_TEMPLATE, --local-dataset-template LOCAL_DATASET_TEMPLATE
                        Path to local dataset template metadata file
  -c CONNECTION, --connection CONNECTION
                        Local connection id
```

You can run all of this as a single command or interactively by selecting some optional arguments, or none of them.

For example, if you want to run the cli interactively you just select `aoa run` but if you wanted to run it non interactively to train a given model with a given datasetId you would expect
```bash
> aoa run -id <modelId> -m <mode> -d <datasetId>
```


## connection

The connection credentials stored in the ModelOps service cannot be accessed remotely through the CLI for security reasons. Instead, users can manage connection information locally for the CLI. These connections are used by other CLI commands which access Vantage.  


```bash
> aoa connection -h
usage: aoa connection [-h] {list,add,remove,export} ...

optional arguments:
  -h, --help         show this help message and exit

actions:
  valid actions

  {list,add,remove}
    list             List all local connections
    add              Add a local connection
    remove           Remove a local connection
    export           Export a local connection to be used as a shell script
```


## feature 

Manage feature metadata by creating and populating feature metadata table(s). The feature metadata tables contain information required when computing statistics during training, scoring etc. This metadata depends on the feature type (categorical or continuous). 

As this metadata can contain sensitive profiling information (such as categories), it is recommended to treat this metadata in the same manner as you treat the features for a given use case. That is, the feature metadata should live in a project or use case level database. 

```bash
> aoa feature -h
usage: aoa feature [-h] {compute-stats,list-stats,create-stats-table,import-stats} ...

optional arguments:
  -h, --help            show this help message and exit

action:
  valid actions

  {compute-stats,list-stats,create-stats-table,import-stats}
    compute-stats       Compute feature statistics
    list-stats          List available statistics
    create-stats-table  Create statistics table
    import-stats        Import column statistics from local JSON file
```

### aoa feature compute metadata

Compute the feature metadata information required when computing statistics during training, scoring etc. This metadata depends on the feature type (categorical or continuous).

Continuous: the histograms edges
Categorical: the categories

```bash
> aoa feature compute-stats -h
usage: aoa feature compute-stats [-h] [--debug] -s SOURCE_TABLE -m METADATA_TABLE [-t {continuous,categorical}] -c
                                 COLUMNS

optional arguments:
  -h, --help            show this help message and exit
  --debug               Enable debug logging
  -s SOURCE_TABLE, --source-table SOURCE_TABLE
                        Feature source table/view
  -m METADATA_TABLE, --metadata-table METADATA_TABLE
                        Metadata table for feature stats, including database name
  -t {continuous,categorical}, --feature-type {continuous,categorical}
                        Feature type: continuous or categorical
  -c COLUMNS, --columns COLUMNS
                        List of feature columns
```

Example usage

```bash
aoa feature compute-stats \
  -s <feature-db>.<feature-data> \
  -m <feature-metadata-db>.<feature-metadata-table> \
  -t continuous -c numtimesprg,plglcconc,bloodp,skinthick,twohourserins,bmi,dipedfunc,age
```


# Authentication

A number of authentication methods are supported for both the CLI and SDK. 

- device_code (interactive)
- client_credentials (service-service)
- bearer (raw bearer token)

When working interactively, the recommended auth method for the CLI is `device_code`. It will guide you through the auth automatically. For the SDK, use  `bearer` if working interactively. 
For both CLI and SDK, if working in an automated service-service manner, use `client_credentials`. 

# SDK

The SDK for ModelOps allows users to interact with ModelOps APIs from anywhere they can execute python such as notebooks, IDEs etc. It can also be used for devops to automate additional parts of the process and integrate into the wider organization.

## Create Client

By default, creating an instance of the `AoaClient` looks for configuration stored in `~/.aoa/config.yaml`. When working with the SDK, we recommend that you specify (and override) all the necessary configuration as part of the `AoaClient` invocation. 

An example to create a client using a bearer token for a given project is

```python
from aoa import AoaClient

client = AoaClient(
    aoa_url="<modelops-endpoint>",
    auth_mode="bearer",
    auth_bearer="<bearer-token>",
    project_id="23e1df4b-b630-47a1-ab80-7ad5385fcd8d",
)
```

To get the values to use for bearer token and aoa_url, go to the ModelOps UI -> Session Details -> SDK Config. 

## Read Entities

We provide an extensive sdk implementation to interact with the APIs. You can find, create, update, archive, etc any entity that supports it via the SDK. In addition, most if not all search endpoints are also implemented in the sdk. Here are some examples

```python
from aoa import AoaClient, DatasetApi, JobApi
import pprint

client = AoaClient(project_id="23e1df4b-b630-47a1-ab80-7ad5385fcd8d")

dataset_api = DatasetApi(aoa_client=client)

datasets = dataset_api.find_all()
pprint.pprint(datasets)

dataset = dataset_api.find_by_id("11e1df4b-b630-47a1-ab80-7ad5385fcd8c")
pprint.pprint(dataset)

job_api = JobApi(aoa_client=client)
jobs = job_api.find_by_id("21e1df4b-b630-47a1-ab80-7ad5385fcd1c")
pprint.pprint(jobs)
```

## Deploy Model Version

Let's assume we have a model version `4131df4b-b630-47a1-ab80-7ad5385fcd15` which we want to deploy In-Vantage and schedule it to execute once a month at midnight of the first day of the month using dataset connection `11e1df4b-b630-47a1-ab80-7ad5385fcd8c` and dataset template `d8a35d98-21ce-47d0-b9f2-00d355777de1`. We can use the SDK as follows to perform this.

```python
from aoa import AoaClient, TrainedModelApi, JobApi

client = AoaClient(project_id="23e1df4b-b630-47a1-ab80-7ad5385fcd8d")
trained_model_api = TrainedModelApi(aoa_client=client)
job_api = JobApi(aoa_client=client)

trained_model_id = "4131df4b-b630-47a1-ab80-7ad5385fcd15"
deploy_request = {
   "engineType": "IN_VANTAGE",
   "publishOnly": False,
   "language": "PMML",
   "cron": "0 0 1 * *",
   "byomModelLocation": {
     "database": "<db-name>",
     "table": "<table-name>"
    },
    "datasetConnectionId": "11e1df4b-b630-47a1-ab80-7ad5385fcd8c",
    "datasetTemplateId": "d8a35d98-21ce-47d0-b9f2-00d355777de1",
    "engineTypeConfig": {
        "dockerImage": "",
        "engine": "byom",
        "resources": {
            "memory": "1G",
            "cpu": "1"
        }
    }
}

job = trained_model_api.deploy(trained_model_id, deploy_request)

# wait until the job completes (if the job fails it will raise an exception)
job_api.wait(job['id'])
```

## Import Model Version

Let's assume we have a PMML model which we have trained in another data science platform. We want to import the artefacts for this version (model.pmml and data_stats.json) against a BYOM model `f937b5d8-02c6-5150-80c7-1e4ff07fea31`.

```python
from aoa import (
    AoaClient, 
    ModelApi,
    TrainedModelApi, 
    TrainedModelArtefactsApi, 
    JobApi
)
import uuid

client = AoaClient(project_id="23e1df4b-b630-47a1-ab80-7ad5385fcd8d")
model_api = ModelApi(aoa_client=client)
trained_model_api = TrainedModelApi(aoa_client=client)
trained_model_artefacts_api = TrainedModelArtefactsApi(aoa_client=client)
job_api = JobApi(aoa_client=client)

artefacts_import_id = uuid.uuid4()
artefacts = ["model.pmml", "data_stats.json"]

# first, upload the artefacts which we want to associate with the BYOM model version
trained_model_artefacts_api.upload_artefacts(artefacts_import_id, artefacts)

import_request = {
   "artefactImportId": str(artefacts_import_id),
   "externalId": "my-byom-version-id"
}

# update with id of your model 
model_id = "<model-uuid>"

job = model_api.import_byom(model_id, import_request)

# wait until the job completes (if the job fails it will raise an exception)
job_api.wait(job["id"])

# now you can list the artefacts which were uploaded and linked to the model version
trained_model_id = job["metadata"]["trainedModel"]["id"]
artefacts = trained_model_artefacts_api.list_artefacts(trained_model_id)
```


## Release Notes

### 7.0.0.0

- Refactor: Refactor data statistics API / internals to be simpler (breaking changes)
- Feature: Switch CLI authentication to use `device_code` grant flow
- Feature: Add raw Bearer token support for authentication (SDK)


### 6.1.4

- Feature: Document user facing stats functions
- Feature: Improve end user error messaging related to stats
- Bug: Fix `aoa init` and `aoa add` not working due to refactor in 6.1.3

### 6.1.3

- Feature: Improve error messages for statistics calculations and validation
- Feature: Use [aia](https://pypi.org/project/aia/) for AIA chasing for missing intermediate certificates
- Bug: No defaults for set when BYOM and VAL DBs not configured on connections
- Bug: Fixed requirement versions to ensure more stability across python versions
- Bug: Fixed slow CLI for some commands due to repeated server initialization

### 6.1.2

- Bug: Work around problems with special character in passwords for teradataml

### 6.1.0

- Cleanup: Remove all non OAuth2 (JWT) authentication methods
- Cleanup: Remove `aoa configure` 
- Feature: Improve error messages to user on CLI
- Feature: Add `aoa link` for linking project to repo locally
- Bug: Don't show archived datasets
- Bug: Fix issue with `aoa feature create-table`


### 6.0.0

- Feature: Support API changes on ModelOps 06.00
- Feature: CLI DX improvements 
- Feature: Add Telemetry query bands to session
- Feature: `aoa feature` support for managing feature metadata
- Feature: `aoa add` uses reference git repository for model templates
- Feature: Improve DX from Notebooks 


### 5.0.0

- Feature: Add simpler teradataml context creation via aoa_create_context
- Feature: Add database to connections
- Feature: Support for human-readable model folder names
- Feature: Improve UX of aoa run
- Feature: Improved error messages for users related to auth and configure
- Refactor: Package refactor of aoa.sto.util to aoa.util.sto
- Bug: cli listing not filtering archived entities
- Cleanup: Remove pyspark support from CLI
- 

### 4.1.12

- Bug: aoa connection add now hides password symbols
- Bug: sto.util.cleanup_cli() used hardcoded models table
- Feature: sto.util.check_sto_version() checks In-Vantage Python version compatibility
- Feature: sto.util.collect_sto_versions() fetches dict with Python and packages versions

### 4.1.11

- Bug: aoa run (evaluation) for R now uses the correct scoring file

### 4.1.10

- Bug: aoa init templates were out of date
- Bug: aoa run (score) didn't read the dataset template correctly
- Bug: aoa run (score) tried to publish to prometheus 
- Bug: aoa run (score) not passing model_table kwargs

### 4.1.9

- Bug: Histogram buckets incorrectly offset by 1 for scoring metrics

### 4.1.7

- Bug: Quoted and escaped exported connection environmental variables
- Bug: aoa clone with `path` argument didn't create .aoa/config.yaml in correct directory
- Feature: aoa clone without `path` now uses repository name by default
- Feature: update BYOM import to upload artefacts before creating version 

### 4.1.6

- Feature: Added local connections feature with Stored Password Protection
- Feature: Self creation of .aoa/config.yaml file when cloning a repo
- Bug: Fix argparse to use of common arguments
- Feature: Support dataset templates for listing datasets and selecting dataset for train/eval
- Bug: Fix aoa run for batch scoring, prompts for dataset template instead of dataset
- Bug: Fix batch scoring histograms as cumulative

### 4.1.5

- Bug: Fix computing stats
- Feature: Autogenerate category labels and support for overriding them
- Feature: Prompt for confirmation when retiring/archiving

### 4.1.4

- Feature: Retiring deployments and archiving projects support
- Feature: Added support for batch scoring monitoring

### 4.1.2

- Bug: Fix computing stats
- Bug: Fix local SQL model training and evaluation

### 4.1

- Bug: CLI shows archived entities when listing datasets, projects, etc
- Bug: Adapt histogram bins depending on range of integer types.

### 4.0

- Feature: Extract and record dataset statistics for Training, Evaluation

### 3.1.1

- Feature: `aoa clone` respects project branch
- Bug: support Source Model ID from the backend

### 3.1

- Feature: ability to separate evaluation and scoring logic into separate files for Python/R

### 3.0

- Feature: Add support for Batch Scoring in run command
- Feature: Added STO utilities to extract metadata for micro-models

### 2.7.2

- Feature: Add support for OAUTH2 token refresh flows
- Feature: Add dataset connections api support

### 2.7.1

- Feature: Add TrainedModelArtefactsApi
- Bug: pyspark cli only accepted old resources format
- Bug: Auth mode not picked up from environment variables 

### 2.7.0 

- Feature: Add support for dataset templates
- Feature: Add support for listing models (local and remote), datasets, projects
- Feature: Remove pykerberos dependency and update docs
- Bug: Fix tests for new dataset template api structure
- Bug: Unable to view/list more than 20 datasets / entities of any type in the cli 

### 2.6.2
 - Bug: Added list resources command.
 - Bug: Remove all kerberos dependencies from standard installation, as they can be now installed as an optional feature.
 - Feature: Add cli support for new artefact path formats
 
### 2.6.1 
 - Bug: Remove pykerberos as an installation dependency.