ml training list

Retrieve the list of trainings for a specific space or project.

Syntax

cpd-cli ml training list \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--jmes-query=<jmespath-query>] \
[--limit=<resource-limit>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
[--parent-id=<parent-identifier>] \
--profile=<cpd-profile-name> \
[--project-id=<project-id>] \
[--quiet] \
[--raw-output=true|false] \
[--space-id=<space-identifier>] \
[--start=<token-for-pagination>] \
[--state=<state-filter-value>] \
[--tag-value=<delimited-tag-value-list>] \
[--total-count=<total-count-value>] \
[--type=<training-filter-type>] \
[--verbose]

Arguments

The ml training list 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 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.

--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.
--limit Specify the total number of resources.
Status
Optional.
Syntax
--limit=<resource-limit>
Default value
100
Valid values
An integer value in the range 0 - 200.
--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.
--parent-id Specify the parent identifier. Training jobs that are sub-jobs of the specified 'parent_id' job are returned. The 'parent_id' can be the same as the experiment job identifier.
Status
Optional.
Syntax
--parent-id=<parent-identifier>
Default value
No default.
Valid values
A valid parent identifier.
--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 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.
--space-id Specify a space identifier.
Status
Optional.
Syntax
--space-id=<space-identifier>
Default value
No default.
Valid values
A valid space identifier.
--start Specify a token that is required for token-based pagination. The token cannot be determined by end user and is generated by the service. The token is set in the 'href' value that is available in the 'next' field.
Status
Optional.
Syntax
--start=<token-for-pagination>
Default value
No default.
Valid values
A valid token that is required for token-based pagination.
--state Specify a state filter value that is based on the training job state. For example, 'queued', 'running', 'completed', 'failed', and so on.
Status
Optional.
Syntax
--state=<state-filter-value>
Default value
No default.
Valid values
Specify a state filter value that is based on the training job state. For example, 'queued', 'running', 'completed', 'failed', and so on.
--tag-value Specify a tag value list that is separated by 'or' or 'and'. Only resources that match the specified tag values are returned.
Status
Optional.
Syntax
--tag-value=<delimited-tag-value-list>
Default value
No default.
Valid values
A valid tag value list.
--total-count Specify a value to compute the total count. This setting might have a negative performance impact.
Status
Optional.
Syntax
--total-count=<total-count-value>
Default value
No default.
Valid values
A valid value to compute the total count.
--type Specify a filter type that is based on the 'pipeline' or 'experiment' trainings. For example, 'type=pipeline'. All trainings are returned when the option is not specified.
Status
Optional.
Syntax
--type=<training-filter-type>
Default value
No default.
Valid values
A valid filter type.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.