/AWS1/IF_SGM=>CREATETRIALCOMPONENT()

About CreateTrialComponent

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 SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services 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.

Method Signature

METHODS /AWS1/IF_SGM~CREATETRIALCOMPONENT
  IMPORTING
    !IV_TRIALCOMPONENTNAME TYPE /AWS1/SGMEXPERIMENTENTITYNAME OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/SGMEXPERIMENTENTITYNAME OPTIONAL
    !IO_STATUS TYPE REF TO /AWS1/CL_SGMTRIALCOMPONENTSTAT OPTIONAL
    !IV_STARTTIME TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_ENDTIME TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IT_PARAMETERS TYPE /AWS1/CL_SGMTRIALCOMPONENTPR00=>TT_TRIALCOMPONENTPARAMETERS OPTIONAL
    !IT_INPUTARTIFACTS TYPE /AWS1/CL_SGMTRIALCOMPONENTAR00=>TT_TRIALCOMPONENTARTIFACTS OPTIONAL
    !IT_OUTPUTARTIFACTS TYPE /AWS1/CL_SGMTRIALCOMPONENTAR00=>TT_TRIALCOMPONENTARTIFACTS OPTIONAL
    !IO_METADATAPROPERTIES TYPE REF TO /AWS1/CL_SGMMETADATAPROPERTIES OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmcretrialcomponen01
  RAISING
    /AWS1/CX_SGMRESOURCELIMITEXCD
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_trialcomponentname TYPE /AWS1/SGMEXPERIMENTENTITYNAME /AWS1/SGMEXPERIMENTENTITYNAME

The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.

Optional arguments:

iv_displayname TYPE /AWS1/SGMEXPERIMENTENTITYNAME /AWS1/SGMEXPERIMENTENTITYNAME

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

io_status TYPE REF TO /AWS1/CL_SGMTRIALCOMPONENTSTAT /AWS1/CL_SGMTRIALCOMPONENTSTAT

The status of the component. States include:

• InProgress

• Completed

• Failed

iv_starttime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

When the component started.

iv_endtime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

When the component ended.

it_parameters TYPE /AWS1/CL_SGMTRIALCOMPONENTPR00=>TT_TRIALCOMPONENTPARAMETERS TT_TRIALCOMPONENTPARAMETERS

The hyperparameters for the component.

it_inputartifacts TYPE /AWS1/CL_SGMTRIALCOMPONENTAR00=>TT_TRIALCOMPONENTARTIFACTS TT_TRIALCOMPONENTARTIFACTS

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

it_outputartifacts TYPE /AWS1/CL_SGMTRIALCOMPONENTAR00=>TT_TRIALCOMPONENTARTIFACTS TT_TRIALCOMPONENTARTIFACTS

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

io_metadataproperties TYPE REF TO /AWS1/CL_SGMMETADATAPROPERTIES /AWS1/CL_SGMMETADATAPROPERTIES

MetadataProperties

it_tags TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST TT_TAGLIST

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

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmcretrialcomponen01 /AWS1/CL_SGMCRETRIALCOMPONEN01

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createtrialcomponent(
  io_metadataproperties = new /aws1/cl_sgmmetadataproperties(
    iv_commitid = |string|
    iv_generatedby = |string|
    iv_projectid = |string|
    iv_repository = |string|
  )
  io_status = new /aws1/cl_sgmtrialcomponentstat(
    iv_message = |string|
    iv_primarystatus = |string|
  )
  it_inputartifacts = VALUE /aws1/cl_sgmtrialcomponentar00=>tt_trialcomponentartifacts(
    (
      VALUE /aws1/cl_sgmtrialcomponentar00=>ts_trialcomponentarti00_maprow(
        key = |string|
        value = new /aws1/cl_sgmtrialcomponentar00(
          iv_mediatype = |string|
          iv_value = |string|
        )
      )
    )
  )
  it_outputartifacts = VALUE /aws1/cl_sgmtrialcomponentar00=>tt_trialcomponentartifacts(
    (
      VALUE /aws1/cl_sgmtrialcomponentar00=>ts_trialcomponentarti00_maprow(
        key = |string|
        value = new /aws1/cl_sgmtrialcomponentar00(
          iv_mediatype = |string|
          iv_value = |string|
        )
      )
    )
  )
  it_parameters = VALUE /aws1/cl_sgmtrialcomponentpr00=>tt_trialcomponentparameters(
    (
      VALUE /aws1/cl_sgmtrialcomponentpr00=>ts_trialcomponentparams_maprow(
        key = |string|
        value = new /aws1/cl_sgmtrialcomponentpr00(
          iv_numbervalue = '0.1'
          iv_stringvalue = |string|
        )
      )
    )
  )
  it_tags = VALUE /aws1/cl_sgmtag=>tt_taglist(
    (
      new /aws1/cl_sgmtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_displayname = |string|
  iv_endtime = '20150101000000.0000000'
  iv_starttime = '20150101000000.0000000'
  iv_trialcomponentname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_trialcomponentarn = lo_result->get_trialcomponentarn( ).
ENDIF.