CREATETRIAL()`¶

About CreateTrial¶

Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.

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 and then use the Search API to search for the tags.

To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_trialname` `TYPE /AWS1/SGMEXPERIMENTENTITYNAME` `/AWS1/SGMEXPERIMENTENTITYNAME`¶

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

`iv_experimentname` `TYPE /AWS1/SGMEXPERIMENTENTITYNAME` `/AWS1/SGMEXPERIMENTENTITYNAME`¶

The name of the experiment to associate the trial with.

Optional arguments:¶

`iv_displayname` `TYPE /AWS1/SGMEXPERIMENTENTITYNAME` `/AWS1/SGMEXPERIMENTENTITYNAME`¶

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

`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 trial. You can use Search API to search on the tags.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_sgmcreatetrialrsp` `/AWS1/CL_SGMCREATETRIALRSP`¶

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->/aws1/if_sgm~createtrial(
  io_metadataproperties = new /aws1/cl_sgmmetadataproperties(
    iv_commitid = |string|
    iv_generatedby = |string|
    iv_projectid = |string|
    iv_repository = |string|
  )
  it_tags = VALUE /aws1/cl_sgmtag=>tt_taglist(
    (
      new /aws1/cl_sgmtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_displayname = |string|
  iv_experimentname = |string|
  iv_trialname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_trialarn = lo_result->get_trialarn( ).
ENDIF.

/AWS1/CL_SGM=>CREATETRIAL()¶