MLM CLI Command Reference¶
Overview¶
MLM CLI simplifies the authoring and validation of the configuration file used in the ML Monitoring Application and ML Insights SDK .
Set up MLM CLI tool¶
To use the MLM CLI follow the setup and installation steps as follows:
Installing the oracle-ml-insights base package
ML Insights library Installation
Test the CLI tool Installation
Run the following command after installing the oracle-ml-insights base package to ensure the mlm cli is working in your system
mlm --help
Available Commands¶
Create Configuration File¶
Description
Use the CLI tool to author new configuration files for the following:
ML Monitoring Application
ML Insights SDK.
The CLI tool provides the following features :
Automatically infer the approximate input data schema based on the specified data location.
Enable users to choose monitoring metrics based on predefined metric groups.
Automatically configure the data reader and post_processors based on the user-provided input data format and location.
Persist the configuration file to the user-defined location (local system).
Usage
mlm config create
Manage Configuration File¶
Description
Use the CLI tool to modify the configuration file. You can customize (add or delete) key configuration components such as input schema, feature metrics, dataset metrics, transformers, data readers, post-processors, tests, and tags to tailor the configuration based on specific needs.
Usage
mlm config manage
Validate Configuration File¶
Description
Use the CLI tool to validate the ML Monitoring Application and ML Insights SDK configuration file . It checks the syntax and structure of components such as input schema, feature metrics, dataset metrics, transformers, data readers, post-processors, tests, and tags.
Usage
mlm config validate