Skip to content

Commit 4ff9f09

Browse files
committed
add note to methods that call restricted API CreateArtifact
1 parent 8c2f8cb commit 4ff9f09

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

src/smexperiments/tracker.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,6 @@ def log_output_artifact(self, file_path, name=None, media_type=None):
302302
name (str, optional): The name of the artifact.
303303
media_type (str, optional): The MediaType (MIME type) of the file. If not specified, this library
304304
will attempt to infer the media type from the file extension of ``file_path``.
305-
artifact_prefix (str): Sub path within the bucket to organize the artifact in.
306305
"""
307306
media_type = media_type or _guess_media_type(file_path)
308307
name = name or _resolve_artifact_name(file_path)
@@ -370,6 +369,10 @@ def log_metric(self, metric_name, value, timestamp=None, iteration_number=None):
370369
def log_table(self, title=None, values=None, data_frame=None, output_artifact=True):
371370
"""Record a table of values that will be rendered in Studio.
372371
372+
Note that this method must be run from a SageMaker context such as studio or training job
373+
due to restrictions on the CreateArtifact API.
374+
375+
373376
Examples
374377
.. code-block:: python
375378
@@ -429,6 +432,9 @@ def _log_precision_recall(
429432
"""Log a precision recall graph artifact which will be displayed in studio.
430433
Requires sklearn. Not yet supported by studio.
431434
435+
Note that this method must be run from a SageMaker context such as studio or training job
436+
due to restrictions on the CreateArtifact API.
437+
432438
Examples
433439
.. code-block:: python
434440
@@ -484,6 +490,9 @@ def log_roc_curve(
484490
"""Log a receiver operating characteristic (ROC) artifact which will be displayed in
485491
studio. Requires sklearn.
486492
493+
Note that this method must be run from a SageMaker context such as studio or training job
494+
due to restrictions on the CreateArtifact API.
495+
487496
Examples
488497
.. code-block:: python
489498

0 commit comments

Comments
 (0)