A command line app for management and maintenance of the Machine Learning (ML) Pipeline of the Auto ML Platform.
Table of Contents
Characteristics
Beta Version
The app is a component of the Auto ML Platform. This platform is not included in yuuvis® Momentum installations and is available as a beta version only on request.
Function
The management of the Machine Learning (ML) Pipeline is done via the command line application Kairos CLI. The following commands are available.
| Command | Sub-Command | Description | Authorization required |
|---|---|---|---|
kairos help | Lists all available commands and how to use them. | no | |
kairos --help [COMMAND] | List the help page for the specific command. | no | |
kairos login -t [TENANT] -u [USERNAME] -p [PASSWORD] | Login to Kairos CLI app to get further access to commands. The login requires TENANT, USERNAME and PASSWORD in any order. If you don't specify values for all options, a dialog will be started. You will stay logged in until you enter the | - | |
| Logout from the Kairos CLI app. | yes | |
kairos pipeline | Manage local AI pipelines. | yes | |
list | Returns console output with list of pipelines. | ||
create -n [NAME] -l [ARTIFACT LOCATION] | Adds a new pipeline to the list. Requires a NAME for the new pipeline and a path to the new pipeline's ARTIFACT LOCATION. | ||
delete -id [PIPELINEID] | Removes a pipeline from the list. Requires the ID of the pipeline you want to delete. | ||
kairos experiment | Run and manage MLFlow experiments. | yes | |
list | Returns console output with list of available experiments | ||
create -n [NAME] -l [ARTIFACT LOCATION] | Adds a new experiment to the list. Requires a NAME for the new experiment and a path to the new experiment's ARTIFACT LOCATION. | ||
delete -id [EXPERIMENTID] | Removes an experiment and its configurations. Requires the ID of the experiment (NOT the pipeline!) you want to delete. | ||
kairos model | Manage models. | yes | |
list -n [MODEL NAME] -v [MODEL VERSION] | Returns console output with list of all available registered models. Optionally, a MODEL NAME can be specified via the option | ||
metrics -runID [RUN ID] | Returns model metrics. Requires the RUN ID of for which all metrics should be returned. | ||
kairos schema | Manage inference schema. | yes | |
view -appName [APP NAME] | Returns console output of specified inference schema. Optionally, an APP NAME can be specified via the option | ||
store -fp [FILE PATH] -appName [APP NAME] | Uploads and overwrites existing inference schema to config api. Requires the FILE PATH to the inference schema to be uploaded. Optionally, an APP NAME can be specified via the option | ||
download -rp [RETURN PATH] -appName [APP NAME] | Downloads inference schema to specified location. Requires a RETURN PATH where the inference schema will be saved. Optionally, an APP NAME can be specified via the option | ||
Requirements
The Kairos CLI app is a part of the Auto ML platform and can run only in combination with the other included components.
Kairos CLI furthermore requires:
- java 13+
The current beta version of Kairos CLI can be operated only on Windows systems.
Installation and Configuration
Use the terminal in administrator mode to have access to all system directories.
- If you were already using Kairos CLI app before, uninstall the old version.
- Run the installation file for the current version of Kairos CLI.
- Finish the installation.
The path of the Kairos CLI installation directory. Set this path as value for your system environment path variable.
Now, configure the custom properties for the Kairos CLI app:
- Create a file
application.propertiesin the directory<installationDirectoryPath>\app\configon your system drive. - Fill in your custom properties and save the file.
File path should be separated with / and not \ (e.g.,C:/Program Files/kairos/app/config/pipelines.jsoninstead ofC:\Program Files\kairos\app\config\pipelines.json).
Note: May differ for Linux operating system.