PyPI - mlrun - Versions diffs - 1.7.0rc13__py3-none-any.whl → 1.7.0rc21__py3-none-any.whl - Mend

mlrun 1.7.0rc13py3-none-any.whl → 1.7.0rc21py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of mlrun might be problematic. Click here for more details.

Files changed (156) hide show

mlrun/__init__.py +10 -1
mlrun/__main__.py +23 -111
mlrun/alerts/__init__.py +15 -0
mlrun/alerts/alert.py +144 -0
mlrun/api/schemas/__init__.py +4 -3
mlrun/artifacts/__init__.py +8 -3
mlrun/artifacts/base.py +36 -253
mlrun/artifacts/dataset.py +9 -190
mlrun/artifacts/manager.py +46 -42
mlrun/artifacts/model.py +9 -141
mlrun/artifacts/plots.py +14 -375
mlrun/common/constants.py +65 -3
mlrun/common/formatters/__init__.py +19 -0
mlrun/{runtimes/mpijob/v1alpha1.py → common/formatters/artifact.py} +6 -14
mlrun/common/formatters/base.py +113 -0
mlrun/common/formatters/function.py +46 -0
mlrun/common/formatters/pipeline.py +53 -0
mlrun/common/formatters/project.py +51 -0
mlrun/{runtimes → common/runtimes}/constants.py +32 -4
mlrun/common/schemas/__init__.py +10 -5
mlrun/common/schemas/alert.py +92 -11
mlrun/common/schemas/api_gateway.py +56 -0
mlrun/common/schemas/artifact.py +15 -5
mlrun/common/schemas/auth.py +2 -0
mlrun/common/schemas/client_spec.py +1 -0
mlrun/common/schemas/frontend_spec.py +1 -0
mlrun/common/schemas/function.py +4 -0
mlrun/common/schemas/model_monitoring/__init__.py +15 -3
mlrun/common/schemas/model_monitoring/constants.py +58 -7
mlrun/common/schemas/model_monitoring/grafana.py +9 -5
mlrun/common/schemas/model_monitoring/model_endpoints.py +86 -2
mlrun/common/schemas/pipeline.py +0 -9
mlrun/common/schemas/project.py +6 -11
mlrun/common/types.py +1 -0
mlrun/config.py +36 -8
mlrun/data_types/to_pandas.py +9 -9
mlrun/datastore/base.py +41 -9
mlrun/datastore/datastore.py +6 -2
mlrun/datastore/datastore_profile.py +56 -4
mlrun/datastore/hdfs.py +5 -0
mlrun/datastore/inmem.py +2 -2
mlrun/datastore/redis.py +2 -2
mlrun/datastore/s3.py +5 -0
mlrun/datastore/sources.py +147 -7
mlrun/datastore/store_resources.py +7 -7
mlrun/datastore/targets.py +129 -9
mlrun/datastore/utils.py +42 -0
mlrun/datastore/v3io.py +1 -1
mlrun/db/auth_utils.py +152 -0
mlrun/db/base.py +55 -11
mlrun/db/httpdb.py +346 -107
mlrun/db/nopdb.py +52 -10
mlrun/errors.py +11 -0
mlrun/execution.py +24 -9
mlrun/feature_store/__init__.py +0 -2
mlrun/feature_store/api.py +12 -47
mlrun/feature_store/feature_set.py +9 -0
mlrun/feature_store/feature_vector.py +8 -0
mlrun/feature_store/ingestion.py +7 -6
mlrun/feature_store/retrieval/base.py +9 -4
mlrun/feature_store/retrieval/conversion.py +9 -9
mlrun/feature_store/retrieval/dask_merger.py +2 -0
mlrun/feature_store/retrieval/job.py +9 -3
mlrun/feature_store/retrieval/local_merger.py +2 -0
mlrun/feature_store/retrieval/spark_merger.py +16 -0
mlrun/frameworks/_dl_common/loggers/tensorboard_logger.py +7 -12
mlrun/frameworks/parallel_coordinates.py +2 -1
mlrun/frameworks/tf_keras/__init__.py +4 -1
mlrun/k8s_utils.py +10 -11
mlrun/launcher/base.py +4 -3
mlrun/launcher/client.py +5 -3
mlrun/launcher/local.py +8 -2
mlrun/launcher/remote.py +8 -2
mlrun/lists.py +6 -2
mlrun/model.py +62 -20
mlrun/model_monitoring/__init__.py +1 -1
mlrun/model_monitoring/api.py +41 -18
mlrun/model_monitoring/application.py +5 -305
mlrun/model_monitoring/applications/__init__.py +11 -0
mlrun/model_monitoring/applications/_application_steps.py +157 -0
mlrun/model_monitoring/applications/base.py +280 -0
mlrun/model_monitoring/applications/context.py +214 -0
mlrun/model_monitoring/applications/evidently_base.py +211 -0
mlrun/model_monitoring/applications/histogram_data_drift.py +132 -91
mlrun/model_monitoring/applications/results.py +99 -0
mlrun/model_monitoring/controller.py +3 -1
mlrun/model_monitoring/db/__init__.py +2 -0
mlrun/model_monitoring/db/stores/__init__.py +0 -2
mlrun/model_monitoring/db/stores/base/store.py +22 -37
mlrun/model_monitoring/db/stores/sqldb/models/__init__.py +43 -21
mlrun/model_monitoring/db/stores/sqldb/models/base.py +39 -8
mlrun/model_monitoring/db/stores/sqldb/models/mysql.py +27 -7
mlrun/model_monitoring/db/stores/sqldb/models/sqlite.py +5 -0
mlrun/model_monitoring/db/stores/sqldb/sql_store.py +246 -224
mlrun/model_monitoring/db/stores/v3io_kv/kv_store.py +232 -216
mlrun/model_monitoring/db/tsdb/__init__.py +100 -0
mlrun/model_monitoring/db/tsdb/base.py +329 -0
mlrun/model_monitoring/db/tsdb/helpers.py +30 -0
mlrun/model_monitoring/db/tsdb/tdengine/__init__.py +15 -0
mlrun/model_monitoring/db/tsdb/tdengine/schemas.py +240 -0
mlrun/model_monitoring/db/tsdb/tdengine/stream_graph_steps.py +45 -0
mlrun/model_monitoring/db/tsdb/tdengine/tdengine_connector.py +397 -0
mlrun/model_monitoring/db/tsdb/v3io/__init__.py +15 -0
mlrun/model_monitoring/db/tsdb/v3io/stream_graph_steps.py +117 -0
mlrun/model_monitoring/db/tsdb/v3io/v3io_connector.py +636 -0
mlrun/model_monitoring/evidently_application.py +6 -118
mlrun/model_monitoring/helpers.py +46 -1
mlrun/model_monitoring/model_endpoint.py +3 -2
mlrun/model_monitoring/stream_processing.py +57 -216
mlrun/model_monitoring/writer.py +134 -124
mlrun/package/utils/_formatter.py +2 -2
mlrun/platforms/__init__.py +10 -9
mlrun/platforms/iguazio.py +21 -202
mlrun/projects/operations.py +19 -12
mlrun/projects/pipelines.py +103 -109
mlrun/projects/project.py +377 -137
mlrun/render.py +15 -14
mlrun/run.py +16 -47
mlrun/runtimes/__init__.py +6 -3
mlrun/runtimes/base.py +8 -7
mlrun/runtimes/databricks_job/databricks_wrapper.py +1 -1
mlrun/runtimes/funcdoc.py +0 -28
mlrun/runtimes/kubejob.py +2 -1
mlrun/runtimes/local.py +5 -2
mlrun/runtimes/mpijob/__init__.py +0 -20
mlrun/runtimes/mpijob/v1.py +1 -1
mlrun/runtimes/nuclio/api_gateway.py +440 -208
mlrun/runtimes/nuclio/application/application.py +170 -8
mlrun/runtimes/nuclio/function.py +39 -49
mlrun/runtimes/pod.py +21 -41
mlrun/runtimes/remotesparkjob.py +9 -3
mlrun/runtimes/sparkjob/spark3job.py +1 -1
mlrun/runtimes/utils.py +6 -45
mlrun/serving/server.py +2 -1
mlrun/serving/states.py +53 -2
mlrun/serving/v2_serving.py +5 -1
mlrun/track/tracker.py +2 -1
mlrun/utils/async_http.py +25 -5
mlrun/utils/helpers.py +107 -75
mlrun/utils/logger.py +39 -7
mlrun/utils/notifications/notification/__init__.py +14 -9
mlrun/utils/notifications/notification/base.py +1 -1
mlrun/utils/notifications/notification/slack.py +61 -13
mlrun/utils/notifications/notification/webhook.py +1 -1
mlrun/utils/notifications/notification_pusher.py +147 -16
mlrun/utils/regex.py +9 -0
mlrun/utils/v3io_clients.py +0 -1
mlrun/utils/version/version.json +2 -2
{mlrun-1.7.0rc13.dist-info → mlrun-1.7.0rc21.dist-info}/METADATA +14 -6
{mlrun-1.7.0rc13.dist-info → mlrun-1.7.0rc21.dist-info}/RECORD +154 -133
mlrun/kfpops.py +0 -865
mlrun/platforms/other.py +0 -305
{mlrun-1.7.0rc13.dist-info → mlrun-1.7.0rc21.dist-info}/LICENSE +0 -0
{mlrun-1.7.0rc13.dist-info → mlrun-1.7.0rc21.dist-info}/WHEEL +0 -0
{mlrun-1.7.0rc13.dist-info → mlrun-1.7.0rc21.dist-info}/entry_points.txt +0 -0
{mlrun-1.7.0rc13.dist-info → mlrun-1.7.0rc21.dist-info}/top_level.txt +0 -0

mlrun/artifacts/plots.py CHANGED Viewed

@@ -13,14 +13,12 @@
 # limitations under the License.
 import base64
 import typing
+import warnings
 from io import BytesIO
-from deprecated import deprecated
 import mlrun
-from ..utils import dict_to_json
-from .base import Artifact, LegacyArtifact
+from .base import Artifact
 if typing.TYPE_CHECKING:
     from plotly.graph_objs import Figure
@@ -37,6 +35,12 @@ class PlotArtifact(Artifact):
     def __init__(
         self, key=None, body=None, is_inline=False, target_path=None, title=None
     ):
+        if key or body or is_inline or target_path:
+            warnings.warn(
+                "Artifact constructor parameters are deprecated and will be removed in 1.9.0. "
+                "Use the metadata and spec parameters instead.",
+                DeprecationWarning,
+            )
         super().__init__(key, body, format="html", target_path=target_path)
         self.metadata.description = title
@@ -70,138 +74,6 @@ class PlotArtifact(Artifact):
         )
-# TODO: remove in 1.7.0
-@deprecated(
-    version="1.5.0",
-    reason="'ChartArtifact' will be removed in 1.7.0, use 'Artifact' instead",
-    category=FutureWarning,
-)
-class ChartArtifact(Artifact):
-    kind = "chart"
-    _TEMPLATE = """
-<html>
-  <head>
-    <script
-        type="text/javascript"
-        src="https://www.gstatic.com/charts/loader.js"></script>
-    <script type="text/javascript">
-      google.charts.load('current', {'packages':['corechart']});
-      google.charts.setOnLoadCallback(drawChart);
-      function drawChart() {
-        var data = google.visualization.arrayToDataTable($data$);
-        var options = $opts$;
-        var chart = new google.visualization.$chart$(
-            document.getElementById('chart_div'));
-        chart.draw(data, options);
-      }
-    </script>
-  </head>
-  <body>
-    <div id="chart_div" style="width: 100%; height: 500px;"></div>
-  </body>
-</html>
-"""
-    def __init__(
-        self,
-        key=None,
-        data=None,
-        header=None,
-        options=None,
-        title=None,
-        chart=None,
-        target_path=None,
-    ):
-        data = [] if data is None else data
-        options = {} if options is None else options
-        super().__init__(key, target_path=target_path)
-        self.viewer = "chart"
-        self.header = header or []
-        self.title = title
-        self.rows = []
-        if data:
-            if header:
-                self.rows = data
-            else:
-                self.header = data[0]
-                self.rows = data[1:]
-        self.options = options
-        self.chart = chart or "LineChart"
-        self.format = "html"
-    def add_row(self, row):
-        self.rows += [row]
-    def get_body(self):
-        if not self.options.get("title"):
-            self.options["title"] = self.title or self.key
-        data = [self.header] + self.rows
-        return (
-            self._TEMPLATE.replace("$data$", dict_to_json(data))
-            .replace("$opts$", dict_to_json(self.options))
-            .replace("$chart$", self.chart)
-        )
-# TODO: remove in 1.7.0
-@deprecated(
-    version="1.5.0",
-    reason="'BokehArtifact' will be removed in 1.7.0, use 'Artifact' instead",
-    category=FutureWarning,
-)
-class BokehArtifact(Artifact):
-    """
-    Bokeh artifact is an artifact for saving Bokeh generated figures. They will be stored in a html format.
-    """
-    kind = "bokeh"
-    def __init__(
-        self,
-        figure=None,
-        key: str = None,
-        target_path: str = None,
-    ):
-        """
-        Initialize a Bokeh artifact with the given figure.
-        :param figure:      Bokeh figure ('bokeh.plotting.Figure' object) to save as an artifact.
-        :param key:         Key for the artifact to be stored in the database.
-        :param target_path: Path to save the artifact.
-        """
-        # Validate input:
-        try:
-            from bokeh.plotting import Figure
-        except (ModuleNotFoundError, ImportError) as Error:
-            raise Error(
-                "Using 'BokehArtifact' requires bokeh package. Use pip install mlrun[bokeh] to install it."
-            )
-        if figure is not None and not isinstance(figure, Figure):
-            raise ValueError(
-                "BokehArtifact requires the figure parameter to be a "
-                f"'bokeh.plotting.Figure' but received '{type(figure)}'"
-            )
-        # Call the artifact initializer:
-        super().__init__(key=key, target_path=target_path, viewer="bokeh")
-        # Continue initializing the bokeh artifact:
-        self._figure = figure
-        self.spec.format = "html"
-    def get_body(self):
-        """
-        Get the artifact's body - the bokeh figure's html code.
-        :return: The figure's html code.
-        """
-        from bokeh.embed import file_html
-        from bokeh.resources import CDN
-        return file_html(self._figure, CDN, self.metadata.key)
 class PlotlyArtifact(Artifact):
     """
     Plotly artifact is an artifact for saving Plotly generated figures. They will be stored in a html format.
@@ -222,6 +94,12 @@ class PlotlyArtifact(Artifact):
         :param key:         Key for the artifact to be stored in the database.
         :param target_path: Path to save the artifact.
         """
+        if key or target_path:
+            warnings.warn(
+                "Artifact constructor parameters are deprecated and will be removed in 1.9.0. "
+                "Use the metadata and spec parameters instead.",
+                DeprecationWarning,
+            )
         # Validate the plotly package:
         try:
             from plotly.graph_objs import Figure
@@ -258,242 +136,3 @@ class PlotlyArtifact(Artifact):
         :return: The figure's html code.
         """
         return self._figure.to_html()
-# TODO: remove in 1.7.0
-@deprecated(
-    version="1.3.0",
-    reason="'LegacyPlotArtifact' will be removed in 1.7.0, use 'PlotArtifact' instead",
-    category=FutureWarning,
-)
-class LegacyPlotArtifact(LegacyArtifact):
-    _TEMPLATE = """
-<h3 style="text-align:center">{}</h3>
-<img title="{}" src="data:image/png;base64,{}">
-"""
-    kind = "plot"
-    def __init__(
-        self, key=None, body=None, is_inline=False, target_path=None, title=None
-    ):
-        super().__init__(key, body, format="html", target_path=target_path)
-        self.description = title
-    def before_log(self):
-        self.viewer = "chart"
-        import matplotlib
-        if not self._body or not isinstance(
-            self._body, (bytes, matplotlib.figure.Figure)
-        ):
-            raise ValueError(
-                "matplotlib fig or png bytes must be provided as artifact body"
-            )
-    def get_body(self):
-        """Convert Matplotlib figure 'fig' into a <img> tag for HTML use
-        using base64 encoding."""
-        if isinstance(self._body, bytes):
-            data = self._body
-        else:
-            from matplotlib.backends.backend_agg import FigureCanvasAgg as FigureCanvas
-            canvas = FigureCanvas(self._body)
-            png_output = BytesIO()
-            canvas.print_png(png_output)
-            data = png_output.getvalue()
-        data_uri = base64.b64encode(data).decode("utf-8")
-        return self._TEMPLATE.format(self.description or self.key, self.key, data_uri)
-# TODO: remove in 1.7.0
-@deprecated(
-    version="1.3.0",
-    reason="'LegacyChartArtifact' will be removed in 1.7.0, use 'ChartArtifact' instead",
-    category=FutureWarning,
-)
-class LegacyChartArtifact(LegacyArtifact):
-    _TEMPLATE = """
-<html>
-  <head>
-    <script
-        type="text/javascript"
-        src="https://www.gstatic.com/charts/loader.js"></script>
-    <script type="text/javascript">
-      google.charts.load('current', {'packages':['corechart']});
-      google.charts.setOnLoadCallback(drawChart);
-      function drawChart() {
-        var data = google.visualization.arrayToDataTable($data$);
-        var options = $opts$;
-        var chart = new google.visualization.$chart$(
-            document.getElementById('chart_div'));
-        chart.draw(data, options);
-      }
-    </script>
-  </head>
-  <body>
-    <div id="chart_div" style="width: 100%; height: 500px;"></div>
-  </body>
-</html>
-"""
-    kind = "chart"
-    def __init__(
-        self,
-        key=None,
-        data=None,
-        header=None,
-        options=None,
-        title=None,
-        chart=None,
-        target_path=None,
-    ):
-        data = [] if data is None else data
-        options = {} if options is None else options
-        super().__init__(key, target_path=target_path)
-        self.viewer = "chart"
-        self.header = header or []
-        self.title = title
-        self.rows = []
-        if data:
-            if header:
-                self.rows = data
-            else:
-                self.header = data[0]
-                self.rows = data[1:]
-        self.options = options
-        self.chart = chart or "LineChart"
-        self.format = "html"
-    def add_row(self, row):
-        self.rows += [row]
-    def get_body(self):
-        if not self.options.get("title"):
-            self.options["title"] = self.title or self.key
-        data = [self.header] + self.rows
-        return (
-            self._TEMPLATE.replace("$data$", dict_to_json(data))
-            .replace("$opts$", dict_to_json(self.options))
-            .replace("$chart$", self.chart)
-        )
-# TODO: remove in 1.7.0
-@deprecated(
-    version="1.3.0",
-    reason="'LegacyBokehArtifact' will be removed in 1.7.0, use 'BokehArtifact' instead",
-    category=FutureWarning,
-)
-class LegacyBokehArtifact(LegacyArtifact):
-    """
-    Bokeh artifact is an artifact for saving Bokeh generated figures. They will be stored in a html format.
-    """
-    kind = "bokeh"
-    def __init__(
-        self,
-        figure=None,
-        key: str = None,
-        target_path: str = None,
-    ):
-        """
-        Initialize a Bokeh artifact with the given figure.
-        :param figure:      Bokeh figure ('bokeh.plotting.Figure' object) to save as an artifact.
-        :param key:         Key for the artifact to be stored in the database.
-        :param target_path: Path to save the artifact.
-        """
-        # Validate input:
-        try:
-            from bokeh.plotting import Figure
-        except (ModuleNotFoundError, ImportError) as Error:
-            raise Error(
-                "Using 'BokehArtifact' requires bokeh package. Use pip install mlrun[bokeh] to install it."
-            )
-        if figure is not None and not isinstance(figure, Figure):
-            raise ValueError(
-                "BokehArtifact requires the figure parameter to be a "
-                f"'bokeh.plotting.Figure' but received '{type(figure)}'"
-            )
-        # Call the artifact initializer:
-        super().__init__(key=key, target_path=target_path, viewer="bokeh")
-        # Continue initializing the bokeh artifact:
-        self._figure = figure
-        self.format = "html"
-    def get_body(self):
-        """
-        Get the artifact's body - the bokeh figure's html code.
-        :return: The figure's html code.
-        """
-        from bokeh.embed import file_html
-        from bokeh.resources import CDN
-        return file_html(self._figure, CDN, self.key)
-# TODO: remove in 1.7.0
-@deprecated(
-    version="1.3.0",
-    reason="'LegacyPlotlyArtifact' will be removed in 1.7.0, use 'PlotlyArtifact' instead",
-    category=FutureWarning,
-)
-class LegacyPlotlyArtifact(LegacyArtifact):
-    """
-    Plotly artifact is an artifact for saving Plotly generated figures. They will be stored in a html format.
-    """
-    kind = "plotly"
-    def __init__(
-        self,
-        figure=None,
-        key: str = None,
-        target_path: str = None,
-    ):
-        """
-        Initialize a Plotly artifact with the given figure.
-        :param figure:      Plotly figure ('plotly.graph_objs.Figure' object) to save as an artifact.
-        :param key:         Key for the artifact to be stored in the database.
-        :param target_path: Path to save the artifact.
-        """
-        # Validate the plotly package:
-        try:
-            from plotly.graph_objs import Figure
-        except ModuleNotFoundError:
-            raise mlrun.errors.MLRunMissingDependencyError(
-                "Using `PlotlyArtifact` requires plotly package. Use `pip install mlrun[plotly]` to install it."
-            )
-        except ImportError:
-            import plotly
-            raise mlrun.errors.MLRunMissingDependencyError(
-                f"Using `PlotlyArtifact` requires plotly version >= 5.4.0 but found version {plotly.__version__}. "
-                f"Use `pip install -U mlrun[plotly]` to install it."
-            )
-        # Call the artifact initializer:
-        super().__init__(key=key, target_path=target_path, viewer="plotly")
-        # Validate input:
-        if figure is not None and not isinstance(figure, Figure):
-            raise mlrun.errors.MLRunInvalidArgumentError(
-                f"PlotlyArtifact requires the figure parameter to be a "
-                f"`plotly.graph_objs.Figure` but received '{type(figure)}'"
-            )
-        # Continue initializing the plotly artifact:
-        self._figure = figure
-        self.format = "html"
-    def get_body(self):
-        """
-        Get the artifact's body - the Plotly figure's html code.
-        :return: The figure's html code.
-        """
-        return self._figure.to_html()

mlrun/common/constants.py CHANGED Viewed

@@ -12,12 +12,74 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
 IMAGE_NAME_ENRICH_REGISTRY_PREFIX = "."  # prefix for image name to enrich with registry
-MLRUN_CREATED_LABEL = "mlrun-created"
-MLRUN_MODEL_CONF = "model-conf"
-MLRUN_SERVING_SPEC_MOUNT_PATH = f"/tmp/mlrun/{MLRUN_MODEL_CONF}"
+MLRUN_SERVING_CONF = "serving-conf"
+MLRUN_SERVING_SPEC_MOUNT_PATH = f"/tmp/mlrun/{MLRUN_SERVING_CONF}"
 MLRUN_SERVING_SPEC_FILENAME = "serving_spec.json"
 MLRUN_SERVING_SPEC_PATH = (
     f"{MLRUN_SERVING_SPEC_MOUNT_PATH}/{MLRUN_SERVING_SPEC_FILENAME}"
 )
+MLRUN_FUNCTIONS_ANNOTATION = "mlrun/mlrun-functions"
 MYSQL_MEDIUMBLOB_SIZE_BYTES = 16 * 1024 * 1024
+MLRUN_LABEL_PREFIX = "mlrun/"
+DASK_LABEL_PREFIX = "dask.org/"
+NUCLIO_LABEL_PREFIX = "nuclio.io/"
+class MLRunInternalLabels:
+    ### dask
+    dask_cluster_name = f"{DASK_LABEL_PREFIX}cluster-name"
+    dask_component = f"{DASK_LABEL_PREFIX}component"
+    ### spark
+    spark_role = "spark-role"
+    ### mpi
+    mpi_job_name = "mpi-job-name"
+    mpi_job_role = "mpi-job-role"
+    mpi_role_type = "mpi_role_type"
+    ### nuclio
+    nuclio_project_name = f"{NUCLIO_LABEL_PREFIX}project-name"
+    nuclio_function_name = f"{NUCLIO_LABEL_PREFIX}function-name"
+    nuclio_class = f"{NUCLIO_LABEL_PREFIX}class"
+    ### mlrun
+    mlrun_auth_key = "mlrun-auth-key"
+    mlrun_class = f"{MLRUN_LABEL_PREFIX}class"
+    client_python_version = f"{MLRUN_LABEL_PREFIX}client_python_version"
+    client_version = f"{MLRUN_LABEL_PREFIX}client_version"
+    function = f"{MLRUN_LABEL_PREFIX}function"
+    job = f"{MLRUN_LABEL_PREFIX}job"
+    name = f"{MLRUN_LABEL_PREFIX}name"
+    mlrun_owner = f"{MLRUN_LABEL_PREFIX}owner"
+    owner_domain = f"{MLRUN_LABEL_PREFIX}owner_domain"
+    project = f"{MLRUN_LABEL_PREFIX}project"
+    runner_pod = f"{MLRUN_LABEL_PREFIX}runner-pod"
+    schedule_name = f"{MLRUN_LABEL_PREFIX}schedule-name"
+    scrape_metrics = f"{MLRUN_LABEL_PREFIX}scrape-metrics"
+    tag = f"{MLRUN_LABEL_PREFIX}tag"
+    uid = f"{MLRUN_LABEL_PREFIX}uid"
+    username = f"{MLRUN_LABEL_PREFIX}username"
+    username_domain = f"{MLRUN_LABEL_PREFIX}username_domain"
+    task_name = f"{MLRUN_LABEL_PREFIX}task-name"
+    host = "host"
+    job_type = "job-type"
+    kind = "kind"
+    component = "component"
+    resource_name = "resource_name"
+    created = "mlrun-created"
+    owner = "owner"
+    v3io_user = "v3io_user"
+    workflow = "workflow"
+    feature_vector = "feature-vector"
+    @classmethod
+    def all(cls):
+        return [
+            value
+            for key, value in cls.__dict__.items()
+            if not key.startswith("__") and isinstance(value, str)
+        ]

mlrun/common/formatters/__init__.py ADDED Viewed

@@ -0,0 +1,19 @@
+# Copyright 2024 Iguazio
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+from .artifact import ArtifactFormat  # noqa
+from .function import FunctionFormat  # noqa
+from .pipeline import PipelineFormat  # noqa
+from .project import ProjectFormat  # noqa

mlrun/{runtimes/mpijob/v1alpha1.py → common/formatters/artifact.py} RENAMED Viewed

@@ -1,4 +1,4 @@
-# Copyright 2023 Iguazio
+# Copyright 2024 Iguazio
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -11,19 +11,11 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-from deprecated import deprecated
+#
-from mlrun.runtimes.constants import MPIJobCRDVersions
-from mlrun.runtimes.mpijob.abstract import AbstractMPIJobRuntime
+import mlrun.common.types
-# TODO: Remove in 1.7.0
-@deprecated(
-    version="1.5.0",
-    reason="v1alpha1 mpi will be removed in 1.7.0, use v1 instead",
-    category=FutureWarning,
-)
-class MpiRuntimeV1Alpha1(AbstractMPIJobRuntime):
-    crd_group = "kubeflow.org"
-    crd_version = MPIJobCRDVersions.v1alpha1
-    crd_plural = "mpijobs"
+# TODO: add a format that returns a minimal response with ObjectFormat
+class ArtifactFormat(mlrun.common.types.StrEnum):
+    full = "full"

mlrun/common/formatters/base.py ADDED Viewed

@@ -0,0 +1,113 @@
+# Copyright 2024 Iguazio
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+import typing
+import mlrun.errors
+class ObjectFormat:
+    """
+    MLRun object formatter. Any class that inherits from this class should implement the `format_method` method
+    to specify the formatting method for each format.
+    A `filter_obj_method` utility method is provided to filter the object based on a list of keys.
+    """
+    full = "full"
+    @staticmethod
+    def format_method(_format: str) -> typing.Optional[typing.Callable]:
+        """
+        Get the formatting method for the provided format.
+        A `None` value signifies a pass-through formatting method (no formatting).
+        :param _format: The format as a string representation.
+        :return: The formatting method.
+        """
+        return {
+            ObjectFormat.full: None,
+        }[_format]
+    @classmethod
+    def format_obj(
+        cls,
+        obj: typing.Any,
+        _format: str,
+        exclude_formats: typing.Optional[list[str]] = None,
+    ) -> typing.Any:
+        """
+        Format the provided object based on the provided format.
+        :param obj: The object to format.
+        :param _format: The format as a string representation.
+        :param exclude_formats: A list of formats to exclude from the formatting process. If the provided format is in
+                                this list, an invalid format exception will be raised.
+        """
+        exclude_formats = exclude_formats or []
+        _format = _format or cls.full
+        invalid_format_exc = mlrun.errors.MLRunBadRequestError(
+            f"Provided format is not supported. format={_format}"
+        )
+        if _format in exclude_formats:
+            raise invalid_format_exc
+        try:
+            format_method = cls.format_method(_format)
+        except KeyError:
+            raise invalid_format_exc
+        if not format_method:
+            return obj
+        return format_method(obj)
+    @staticmethod
+    def filter_obj_method(_filter: list[str]) -> typing.Callable:
+        """
+        Returns a method that filters the object based on the provided list of keys.
+        The keys should be in a dot-separated format, denoting the path within the dictionary to the desired key.
+        The object maintains its structure, with the filtered keys and their values, while all other keys are removed.
+        :param _filter: The list of keys to filter by.
+                        Example:
+                        [
+                            "kind",
+                            "metadata.name",
+                            "spec.something.else",
+                        ]
+        :return: The filtering method.
+        """
+        def _filter_method(obj: dict) -> dict:
+            formatted_obj = {}
+            for key in _filter:
+                key_list = key.split(".")
+                obj_recursive_iterator = obj
+                formatted_obj_recursive_iterator = formatted_obj
+                for idx, key in enumerate(key_list):
+                    if key not in obj_recursive_iterator:
+                        break
+                    value = (
+                        {} if idx < len(key_list) - 1 else obj_recursive_iterator[key]
+                    )
+                    formatted_obj_recursive_iterator.setdefault(key, value)
+                    obj_recursive_iterator = obj_recursive_iterator[key]
+                    formatted_obj_recursive_iterator = formatted_obj_recursive_iterator[
+                        key
+                    ]
+            return formatted_obj
+        return _filter_method

mlrun 1.7.0rc13__py3-none-any.whl → 1.7.0rc21__py3-none-any.whl

Potentially problematic release.

mlrun 1.7.0rc13py3-none-any.whl → 1.7.0rc21py3-none-any.whl