Improve evaluation api (#5256)

* init Signed-off-by: Weichen Xu <weichen.xu@databricks.com> * update Signed-off-by: Weichen Xu <weichen.xu@databricks.com> * update Signed-off-by: Weichen Xu <weichen.xu@databricks.com> * update doc Signed-off-by: Weichen Xu <weichen.xu@databricks.com> * update doc Signed-off-by: Weichen Xu <weichen.xu@databricks.com> * address comments Signed-off-by: Weichen Xu <weichen.xu@databricks.com> * update doc Signed-off-by: Weichen Xu <weichen.xu@databricks.com> * add shap limitation on value type Signed-off-by: Weichen Xu <weichen.xu@databricks.com> * fix format Signed-off-by: Weichen Xu <weichen.xu@databricks.com> * update Signed-off-by: Weichen Xu <weichen.xu@databricks.com> * update Signed-off-by: Weichen Xu <weichen.xu@databricks.com> * update Signed-off-by: Weichen Xu <weichen.xu@databricks.com> * update Signed-off-by: Weichen Xu <weichen.xu@databricks.com> * update Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
mlflow · Jan 14, 2022 · 4c58179 · 4c58179
1 parent dab955c
commit 4c58179
Show file tree

Hide file tree

Showing 10 changed files with 333 additions and 281 deletions.
diff --git a/docs/source/python_api/mlflow.models.evaluation.base.rst b/docs/source/python_api/mlflow.models.evaluation.base.rst
diff --git a/docs/source/python_api/mlflow.models.evaluation.rst b/docs/source/python_api/mlflow.models.evaluation.rst
diff --git a/mlflow/models/__init__.py b/mlflow/models/__init__.py
@@ -24,14 +24,16 @@
 from .model import Model
 from .flavor_backend import FlavorBackend
 from ..utils.environment import infer_pip_requirements
-from .evaluation import evaluate, EvaluationDataset
+from .evaluation import evaluate, EvaluationArtifact, EvaluationResult, list_evaluators
 
 __all__ = [
     "Model",
     "FlavorBackend",
     "infer_pip_requirements",
     "evaluate",
-    "EvaluationDataset",
+    "EvaluationArtifact",
+    "EvaluationResult",
+    "list_evaluators",
 ]
 
 

diff --git a/mlflow/models/evaluation/__init__.py b/mlflow/models/evaluation/__init__.py
@@ -2,7 +2,6 @@
     ModelEvaluator,
     EvaluationDataset,
     EvaluationResult,
-    EvaluationMetrics,
     EvaluationArtifact,
     evaluate,
     list_evaluators,
@@ -12,7 +11,6 @@
     "ModelEvaluator",
     "EvaluationDataset",
     "EvaluationResult",
-    "EvaluationMetrics",
     "EvaluationArtifact",
     "evaluate",
     "list_evaluators",

diff --git a/mlflow/models/evaluation/artifacts.py b/mlflow/models/evaluation/artifacts.py
@@ -4,7 +4,7 @@
 
 
 class ImageEvaluationArtifact(EvaluationArtifact):
-    def save(self, output_artifact_path):
+    def _save(self, output_artifact_path):
         self._content.save(output_artifact_path)
 
     def _load_content_from_file(self, local_artifact_path):
@@ -15,7 +15,7 @@ def _load_content_from_file(self, local_artifact_path):
 
 
 class CsvEvaluationArtifact(EvaluationArtifact):
-    def save(self, output_artifact_path):
+    def _save(self, output_artifact_path):
         self._content.to_csv(output_artifact_path, index=False)
 
     def _load_content_from_file(self, local_artifact_path):