ml model create

Create a model with the defined payload. A model represents a machine learning model asset.

Syntax

cpd-cli ml model create \
[--async] \
[--content-location=<attachment-details>] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--custom=<map<key,value>>] \
[--description=<resource-description>] \
[--domain=<model-domain-name>] \
[--hyper-parameters=<model-training-hyper-parameters>] \
[--jmes-query=<jmespath-query>] \
[--label-column=<label-column>] \
[--metrics=<operation-metrics>] \
[--model-definition=<model-definition>] \
--name=<resource-name> \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
[--pipeline=<resource-reference>] \
--profile=<profile-name> \
[--project-id=<project-id>] \
[--quiet] \
[--raw-output=true|false] \
[--schemas=<expected-data-schemas>] \
[--size=<model-size>] \
--software-spec=<software-specification> \
[--space-id=<space-identifier>] \
[--tags=<tag1,tag2,...>] \
[--test-data-references=<holdout-or-test-data-set>] \
[--training-data-references=<model-training-data>] \
[--transformed-label-column=<transformed-label-column-name>] \
--type=<model-type> \
[--user-defined-objects=<objects-defined-by-model>] \
[--verbose]

Arguments

The ml model create command has no arguments.

Options

Table 1: Command options
Option Description
--async Run the command asynchronously. By default, processing finishes before the command runs.
Status
Optional.
Syntax
--async
Default value
Not applicable.
Valid values
Not
 applicable.
--content-location Specify details about the attachments that are uploaded with the model.
Status
Optional.
Syntax
--content-location=<attachment-details>
Default value
No default.
Valid values
Model attachment details.
--context Specify the configuration context
 name.
Status
Optional.
Syntax
--context=<catalog-project-or-space-id>
Default value
Not applicable.
Valid values
A valid configuration context name.
--cpd-config The IBM Software Hub
 configuration location. For example, $HOME/.cpd-cli/config.
Status
Optional.
Syntax
--cpd-config=<cpd-config-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid IBM® Software Hub configuration location.
--cpd-scope The IBM Software Hub space, project, or catalog scope. For example, cpd://default-context/spaces/7bccdda4-9752-4f37-868e-891de6c48135.
Status
Optional.
Syntax
--cpd-scope=<cpd-scope>
Default value
No default.
Valid values
A valid IBM Software Hub space, project, or catalog scope.
--custom Specify user-defined properties as key-value pairs.
Status
Optional.
Syntax
--custom=<map<key,value>>
Default value
No default.
Valid values
Valid key-value pairs.
--description Specify a resource
 description.
Status
Optional.
Syntax
--description=<resource-description>
Default value
No default.
Valid values
A valid resource description.
--domain Provide a domain name for the model. For example, sentiment, entity, visual-recognition, finance, retail, real estate.
Status
Optional.
Syntax
--domain=<model-domain-name>
Default value
No default.
Valid values
A valid model domain name.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--hyper-parameters Specify the hyper parameters that are used for training the model.
Status
Optional.
Syntax
--hyper-parameters=<model-training-hyper-parameters>
Default value
No default.
Valid values
A valid list of model hyper parameters.
--jmes-query Provide a JMESPath query to customize the output.
Status
Optional.
Syntax
--jmes-query=<jmespath-query>
Default value
No default.
Valid values
A valid JMESPath query.
--label-column Specify the label column.
Status
Optional.
Syntax
--label-column=<label-column>
Default value
No default.
Valid values
A valid label column.
--metrics Specify metrics that can be returned by an operation.
Status
Optional.
Syntax
--metrics=<operation-metrics>
Default value
No default.
Valid values
A valid list of operation metrics.
--model-definition Specify the model definition. The 'software_spec' is a reference to a software specification. The 'hardware_spec' is a reference to a hardware specification.
Status
Optional.
Syntax
--model-definition=<model-definition>
Default value
No default.
Valid values
A valid list of model references.
--name Specify a resource name.
Status
Required.
Syntax
--name=<resource-name>
Default value
No default.
Valid values
A valid resource name.
--output Specify an output format.
Status
Optional.
Syntax
--output=json|yaml|text
Default value
text
Valid values
Valid formats include JSON, YAML, or text (the default format).
--output-file Specify a file path where all output is redirected.
Status
Optional.
Syntax
--output-file=<output-file-location>
Default value
No default.
Valid values
A valid output file path location.
--pipeline Specify a reference to a resource. The 'hardware_spec' is a reference to the hardware specification. The 'hybrid_pipeline_hardware_specs' reference is used only when training a hybrid pipeline. A hybrid pipeline is used to specify the compute requirements for each pipeline node.
Status
Optional.
Syntax
--pipeline=<resource-reference>
Default value
No default.
Valid values
A valid resource reference.
--profile The name of the profile that you created to store information about an instance of IBM Software Hub and your credentials for the instance.
Status
Required.
Syntax
--profile=<profile-name>
Default value
No default.
Valid values

The name of the profile that you created.
--project-id Specify an IBM Software Hub project instance that contains the resource.
Status
Optional.
Syntax
--project-id=<project-id>
Default value
No default.
Valid values
Any valid project ID.
--quiet Suppress verbose messages.
Status
Optional.
Syntax
--quiet
Default value
No default.
Valid values
Not applicable.
--raw-output When set to true, single values are not surrounded by quotation marks in
 JSON output mode.
Status
Optional.
Syntax
--raw-output=true|false
Default value
false
Valid values
false
Single values in JSON output mode are surrounded by quotation marks.
true
Single values in JSON output mode are not surrounded by quotation marks.
--schemas Specify the expected data schemas. Schemas that are defined here take precedence over any schemas that are provided in the data references.
Status
Optional.
Syntax
--schemas=<expected-data-schemas>
Default value
No default.
Valid values
A valid array of expected data schemas.
--size Specify the model size. This setting is used by scoring to record the model size.
Status
Optional.
Syntax
--size=<model-size>
Default value
No default.
Valid values
A valid model size.
--software-spec Specify a software specification (SoftwareSpecRel object).
Status
Required.
Syntax
--software-spec=<software-specification>
Default value
No default.
Valid values
A valid software specification (SoftwareSpecRel object).
--space-id Specify a space identifier.
Status
Optional.
Syntax
--space-id=<space-identifier>
Default value
No default.
Valid values
A valid space identifier.
--tags Specify tags that can be used when searching for resources.
Status
Optional.
Syntax
--tags=<tag1,tag2,...>
Default value
No default.
Valid values
A valid list of comma-separated resource tags.
--test-data-references Specify the holdout or test data sets.
Status
Optional.
Syntax
--test-data-references=<holdout-or-test-data-set>
Default value
No default.
Valid values
A valid holdout or test data set.
--training-data-references Specify the training data that was used to create the model.
Status
Optional.
Syntax
--training-data-references=<model-training-data>
Default value
No default.
Valid values
Specify the training data that was used to create the model.
--transformed-label-column Specify the name of the label column (as seen by the estimator), which might be transformed by the previous pipeline transformers. The name is not necessarily the same column as the 'label_column' in the initial data set.
Status
Optional.
Syntax
--transformed-label-column=<transformed-label-column-name>
Default value
No default.
Valid values
A valid label column name.
--type Specify the model type.
Status
Optional.
Syntax
--type=<model-type>
Default value
No default.
Valid values
A valid model type.
--user-defined-objects Specify defined objects that are referenced by the model. For any defined model class or function, the name (as referenced in the model) must be specified as the 'key' and a fully qualified class or function name must be specified as the 'value'. This is applicable for 'Tensorflow 2.X' models serialized in 'H5' format that uses the 'tf.keras' API.
Status
Optional.
Syntax
--user-defined-objects=<objects-defined-by-model>
Default value
No default.
Valid values
Valid objects that are referenced by the model.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.