Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

sagemaker_create_trial_component

Creates a trial component, which is a stage of a machine learning trial


Description

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.

create_trial_component 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 create_trial_component from outside one of these environments results in an error.

Usage

sagemaker_create_trial_component(TrialComponentName, DisplayName,
  Status, StartTime, EndTime, Parameters, InputArtifacts, OutputArtifacts,
  MetadataProperties, Tags)

Arguments

TrialComponentName

[required] The name of the component. The name must be unique in your AWS account and is not case-sensitive.

DisplayName

The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

Status

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

StartTime

When the component started.

EndTime

When the component ended.

Parameters

The hyperparameters for the component.

InputArtifacts

The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

OutputArtifacts

The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

MetadataProperties
Tags

A list of tags to associate with the component. You can use search API to search on the tags.

Value

A list with the following syntax:

list(
  TrialComponentArn = "string"
)

Request syntax

svc$create_trial_component(
  TrialComponentName = "string",
  DisplayName = "string",
  Status = list(
    PrimaryStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped",
    Message = "string"
  ),
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  Parameters = list(
    list(
      StringValue = "string",
      NumberValue = 123.0
    )
  ),
  InputArtifacts = list(
    list(
      MediaType = "string",
      Value = "string"
    )
  ),
  OutputArtifacts = list(
    list(
      MediaType = "string",
      Value = "string"
    )
  ),
  MetadataProperties = list(
    CommitId = "string",
    Repository = "string",
    GeneratedBy = "string",
    ProjectId = "string"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

paws.machine.learning

Amazon Web Services Machine Learning Services

v0.1.11
Apache License (>= 2.0)
Authors
David Kretch [aut, cre], Adam Banker [aut], Amazon.com, Inc. [cph]
Initial release

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.