Skip to content

Commit

Permalink
add additional notes on log_metric behavior to avoid confusion
Browse files Browse the repository at this point in the history
  • Loading branch information
danabens committed Jun 17, 2020
1 parent 7ad1b97 commit 204934a
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/smexperiments/tracker.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ 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.
Attributes:
trial_component (TrialComponent): The trial component tracked.
"""
Expand Down Expand Up @@ -267,7 +269,7 @@ def log_artifact(self, file_path, name=None, media_type=None):
)

def log_metric(self, metric_name, value, timestamp=None, iteration_number=None):
"""Record a scalar metric value for this TrialComponent.
"""Record a scalar metric value for this TrialComponent to file, not SageMaker.
Examples
.. code-block:: python
Expand Down

0 comments on commit 204934a

Please sign in to comment.