Skip to content

Commit 204934a

Browse files
committed
add additional notes on log_metric behavior to avoid confusion
1 parent 7ad1b97 commit 204934a

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/smexperiments/tracker.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ class Tracker(object):
4343
end times are automatically set when using the with statement and the trial component is saved to
4444
SageMaker at the end of the block.
4545
46+
Note that only parameters, input artifacts, and output artifacts are saved to SageMaker. Metrics are saved to file.
47+
4648
Attributes:
4749
trial_component (TrialComponent): The trial component tracked.
4850
"""
@@ -267,7 +269,7 @@ def log_artifact(self, file_path, name=None, media_type=None):
267269
)
268270

269271
def log_metric(self, metric_name, value, timestamp=None, iteration_number=None):
270-
"""Record a scalar metric value for this TrialComponent.
272+
"""Record a scalar metric value for this TrialComponent to file, not SageMaker.
271273
272274
Examples
273275
.. code-block:: python

0 commit comments

Comments
 (0)