Skip to content

Commit 391045c

Browse files
committed
fix doc generation
1 parent 0396f10 commit 391045c

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

src/smexperiments/experiment.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ class Experiment(_base_types.Record):
4040
4141
my_experiment.delete_all(action="--force")
4242
43-
Attributes:
43+
Parameters:
4444
experiment_name (str): The name of the experiment. The name must be unique within an account.
4545
description (str): A description of the experiment.
4646
tags (List[dict[str, str]]): A list of tags to associate with the experiment.

src/smexperiments/tracker.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,10 @@ class Tracker(object):
5050
5151
Note that parameters and input/output artifacts are saved to SageMaker directly via the
5252
UpdateTrialComponent operation. In contrast metrics (via `log_metric` method) are saved to a file, which is
53-
then ingested into SageMaker via a metrics agent _which only runs on training job hosts_. As a result any metrics
53+
then ingested into SageMaker via a metrics agent _which only runs on training job hosts. As a result any metrics
5454
logged in non-training job host environments will not be ingested into SageMaker.
5555
56-
Attributes:
56+
Parameters:
5757
trial_component (TrialComponent): The trial component tracked.
5858
"""
5959

src/smexperiments/trial.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ class Trial(_base_types.Record):
4141
my_trial.remove_trial_component(my_tracker)
4242
my_trial.delete()
4343
44-
Attributes:
44+
Parameters:
4545
trial_name (str): The name of the trial.
4646
experiment_name (str): The name of the trial's experiment.
4747
tags (List[dict[str, str]]): A list of tags to associate with the trial.

src/smexperiments/trial_component.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class TrialComponent(_base_types.Record):
2424
To automatically associate trial components with a trial and experiment supply an experiment config when creating a
2525
job. For example: https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateTrainingJob.html
2626
27-
Attributes:
27+
Parameters:
2828
trial_component_name (str): The name of the trial component. Generated by SageMaker from the name of the
2929
source job with a suffix specific to the type of source job.
3030
trial_component_arn (str): The ARN of the trial component.

0 commit comments

Comments
 (0)