Skip to content

Commit 15fdb83

Browse files
committed
add description of create Trial Component behavior
1 parent f4e0c9b commit 15fdb83

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/smexperiments/trial_component.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ class TrialComponent(_base_types.Record):
1919
This class represents a SageMaker trial component object.
2020
2121
A trial component is a stage in a trial.
22+
23+
Trial components are created automatically within the SageMaker runtime and may not be created directly.
24+
To automatically associate trial components with a trial and experiment supply an experiment config when creating a
25+
job. For example: https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateTrainingJob.html
2226
"""
2327

2428
trial_component_name = None

0 commit comments

Comments
 (0)