aws sagemaker create-trial-component
Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials. Trial components include pre-processing jobs, training jobs, and batch transform jobs. When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK. You can add tags to a trial component and then use the Search API to search for the tags. CreateTrialComponent can only be invoked from within an Amazon SageMaker managed environment. This includes Amazon SageMaker training jobs, processing jobs, transform jobs, and Amazon SageMaker notebooks. A call to CreateTrialComponent from outside one of these environments results in an error
Options
| Name | Description |
|---|---|
--trial-component-name <string> | The name of the component. The name must be unique in your AWS account and is not case-sensitive |
--display-name <string> | The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed |
--status <structure> | The status of the component. States include: InProgress Completed Failed |
--start-time <timestamp> | When the component started |
--end-time <timestamp> | When the component ended |
--parameters <map> | The hyperparameters for the component |
--input-artifacts <map> | The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types |
--output-artifacts <map> | The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images |
--metadata-properties <structure> | Metadata properties of the tracking entity, trial, or trial component |
--tags <list> | A list of tags to associate with the component. You can use Search API to search on the tags |
--cli-input-json <string> | Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally |
--generate-cli-skeleton <string> | Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command |