Merge pull request #158 from jkasiraj/tracker

doc: view ROC, PR, and confusion matrix in Trial Component UI
aws · May 7, 2022 · 5825d81 · 5825d81
2 parents d5df045 + 5609786
commit 5825d81
Showing 1 changed file with 9 additions and 9 deletions.
diff --git a/src/smexperiments/tracker.py b/src/smexperiments/tracker.py
@@ -478,9 +478,9 @@ def log_precision_recall(
         output_artifact=True,
         no_skill=None,
     ):
-        """Log a precision recall graph artifact. If your job is created by a pipeline
-        execution you can view the artifact by selecting the corresponding step in the pipelines UI.
-        The Trial Component UI currently does not support rendering of the artifact.
+        """Log a precision recall graph artifact. You can view the artifact in the charts tab of the
+        Trial Component UI. If your job is created by a pipeline execution you can view the artifact
+        by selecting the corresponding step in the pipelines UI.
         See also `SageMaker Pipelines <https://aws.amazon.com/sagemaker/pipelines/>`_
 
         Requires sklearn.
@@ -542,9 +542,9 @@ def log_roc_curve(
         title=None,
         output_artifact=True,
     ):
-        """Log a receiver operating characteristic (ROC curve) artifact. If your job is created by a pipeline
-        execution you can view the artifact by selecting the corresponding step in the pipelines UI.
-        The Trial Component UI currently does not support rendering of the artifact.
+        """Log a receiver operating characteristic (ROC curve) artifact. You can view the artifact
+        in the charts tab of the Trial Component UI. If your job is created by a pipeline execution
+        you can view the artifact by selecting the corresponding step in the pipelines UI.
         See also `SageMaker Pipelines <https://aws.amazon.com/sagemaker/pipelines/>`_
 
         Requires sklearn.
@@ -595,9 +595,9 @@ def log_confusion_matrix(
         title=None,
         output_artifact=True,
     ):
-        """Log a confusion matrix artifact. If your job is created by a pipeline execution you can view the
-        artifact by selecting the corresponding step in the pipelines UI. The Trial Component UI
-        currently does not support rendering of the artifact.
+        """Log a confusion matrix artifact. You can view the artifact in the charts tab of the
+        Trial Component UI. If your job is created by a pipeline execution you can view the
+        artifact by selecting the corresponding step in the pipelines UI.
         See also `SageMaker Pipelines <https://aws.amazon.com/sagemaker/pipelines/>`_
 
         Requires sklearn.