Skip to content

Commit 404c121

Browse files
committed
doc: add note regarding enable_sagemaker_metrics
1 parent 801f86c commit 404c121

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
@@ -371,7 +371,10 @@ def log_input_artifact(self, file_path, name=None, media_type=None):
371371
self._lineage_artifact_tracker.add_input_artifact(name, s3_uri, etag, media_type)
372372

373373
def log_metric(self, metric_name, value, timestamp=None, iteration_number=None):
374-
"""Record a scalar metric value for this TrialComponent.
374+
"""Record a custom scalar metric value for this TrialComponent.
375+
376+
Note that this method is for manual custom metrics, for automatic metrics see the
377+
`enable_sagemaker_metrics` parameter on the `estimator` class in the main SageMaker SDK.
375378
376379
Note that metrics logged with this method will only appear in SageMaker when this method
377380
is called from a training job host.

0 commit comments

Comments
 (0)