Skip to content

Commit

Permalink
clarify log_metric behavior in Tracker documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
danabens committed Jul 29, 2021
1 parent 404c121 commit 061305a
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/smexperiments/tracker.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,10 @@ class Tracker(object):
end times are automatically set when using the with statement and the trial component is saved to
SageMaker at the end of the block.
Note that only parameters, input artifacts, and output artifacts are saved to SageMaker. Metrics are saved to file.
Note that parameters and input/output artifacts are saved to SageMaker directly via the
UpdateTrialComponent operation. In contrast metrics (via `log_metric` method) are saved to a file, which is
then ingested into SageMaker via a metrics agent _which only runs on training job hosts_. As a result any metrics
logged in non-training job host environments will not be ingested into SageMaker.
Attributes:
trial_component (TrialComponent): The trial component tracked.
Expand Down

0 comments on commit 061305a

Please sign in to comment.