Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

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.

CommandSub-CommandDescriptionAuthorization required
kairos helpLists 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 kairos logout command. Even if you close the terminal and enter again, you are still logged in and will be able to run all commands.

-
kairos logoutLogout from the Kairos CLI app.yes
kairos pipelineManage local AI pipelines.yes

listReturns 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 experimentRun and manage MLFlow experiments.yes

listReturns 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 modelManage 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 -n. The output will be a list of all available versions of the corresponding model.
In addition to the option -n, the option -v can be used to specify a MODEL VERSION. The output will be a list containing specific model version information.

metrics -runID [RUN ID]Returns model metrics. Requires the RUN ID of for which all metrics should be returned.
kairos schemaManage inference schema.yes

view -appName [APP NAME]

Returns console output of specified inference schema.

Optionally, an APP NAME can be specified via the option -appName in order to get the inference schema of the indicated app.

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 -appName in order to upload the inference schema for the indicated app.

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 -appName in order to get the inference schema of the indicated app.

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.properties in the directory <installationDirectoryPath>\app\config on 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.json instead of C:\Program Files\kairos\app\config\pipelines.json).
    Note: May differ for Linux operating system.
  • No labels