Skip to content

Commit 061305a

Browse files
committed
clarify log_metric behavior in Tracker documentation
1 parent 404c121 commit 061305a

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/smexperiments/tracker.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,10 @@ class Tracker(object):
4848
end times are automatically set when using the with statement and the trial component is saved to
4949
SageMaker at the end of the block.
5050
51-
Note that only parameters, input artifacts, and output artifacts are saved to SageMaker. Metrics are saved to file.
51+
Note that parameters and input/output artifacts are saved to SageMaker directly via the
52+
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
54+
logged in non-training job host environments will not be ingested into SageMaker.
5255
5356
Attributes:
5457
trial_component (TrialComponent): The trial component tracked.

0 commit comments

Comments
 (0)