ml training-definition create

Create a training definition with the defined payload. A training definition represents the training metadata that is necessary to start a training job.

Syntax

cpd-cli ml training-definition create \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--custom=<map<key,value>>] \
[--description=<training-description>] \
[--experiment=<resource-reference>] \
[--federated-learning=<technical-preview>] \
[--jmes-query=<jmespath-query>] \
[--model-definition=<model-definition>] \
--name=<training-name> \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
[--pipeline=<resource-reference>] \
--profile=<cpd-profile-name> \
[--project-id=<cpd-project-id>] \
[--quiet] \
[--raw-output=true|false] \
--results-reference=<training-results> \
[--space-id=<space-identifier>] \
[--tags=<tag1,tag2,...>] \
[--test-data-references=<holdout-or-test-data-set>] \
[--training-data-references=<model-training-data>]\
[--verbose]

Arguments

The ml training-definition create command has no arguments.

Options

Table 1: Command options
Option Description
--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 Cloud Pak for Data
 configuration location. For example, $HOME/.cpd-cli/config.
Status
Required.
Syntax
--cpd-config=<cpd-config-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid Cloud Pak for Data configuration location.
--cpd-scope The Cloud Pak for Data 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 Cloud Pak for Data 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 training
 description.
Status
Optional.
Syntax
--description=<training-description>
Default value
No default.
Valid values
A valid training description.
--experiment Specify a reference to a resource.
Status
Optional.
Syntax
--experiment=<resource-reference>
Default value
No default.
Valid values
Specify a reference to a resource.
--federated-learning Specify the Federated Learning. The Federated Learning is a technical preview.
Status
Optional.
Syntax
--federated-learning=<technical-preview>
Default value
No default.
Valid values
A valid technical preview.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--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.
--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 training name.
Status
Optional.
Syntax
--name=<training-name>
Default value
No default.
Valid values
A valid training 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 Cloud Pak for Data and your credentials for the instance.
Status
Required.
Syntax
--profile=<cpd-profile-name>
Default value
No default.
Valid values

The name of the profile that you created.
--project-id Specify a Cloud Pak for Data project instance that contains the resource.
Status
Optional.
Syntax
--project-id=<cpd-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.
--results-reference Specify the training results.
Status
Required.
Syntax
--results-reference=<training-results>
Default value
No default.
Valid values
Specify the training results.
--space-id Specify a space identifier.
Status
Required.
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.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.