mlrun 1.3.2rc1__py3-none-any.whl → 1.3.2rc2__py3-none-any.whl

mlrun/model_monitoring/stores/model_endpoint_store.py

@@ -1,147 +0,0 @@
-# Copyright 2018 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
-from abc import ABC, abstractmethod
-
-
-class ModelEndpointStore(ABC):
-    """
-    An abstract class to handle the model endpoint in the DB target.
-    """
-
-    def __init__(self, project: str):
-        """
-        Initialize a new model endpoint target.
-
-        :param project:             The name of the project.
-        """
-        self.project = project
-
-    @abstractmethod
-    def write_model_endpoint(self, endpoint: typing.Dict[str, typing.Any]):
-        """
-        Create a new endpoint record in the DB table.
-
-        :param endpoint: model endpoint dictionary that will be written into the DB.
-        """
-        pass
-
-    @abstractmethod
-    def update_model_endpoint(
-        self, endpoint_id: str, attributes: typing.Dict[str, typing.Any]
-    ):
-        """
-        Update a model endpoint record with a given attributes.
-
-        :param endpoint_id: The unique id of the model endpoint.
-        :param attributes: Dictionary of attributes that will be used for update the model endpoint. Note that the keys
-                           of the attributes dictionary should exist in the DB table.
-
-        """
-        pass
-
-    @abstractmethod
-    def delete_model_endpoint(self, endpoint_id: str):
-        """
-        Deletes the record of a given model endpoint id.
-
-        :param endpoint_id: The unique id of the model endpoint.
-        """
-        pass
-
-    @abstractmethod
-    def delete_model_endpoints_resources(
-        self, endpoints: typing.List[typing.Dict[str, typing.Any]]
-    ):
-        """
-        Delete all model endpoints resources.
-
-        :param endpoints: A list of model endpoints flattened dictionaries.
-
-        """
-        pass
-
-    @abstractmethod
-    def get_model_endpoint(
-        self,
-        endpoint_id: str,
-    ) -> typing.Dict[str, typing.Any]:
-        """
-        Get a single model endpoint record.
-
-        :param endpoint_id: The unique id of the model endpoint.
-
-        :return: A model endpoint record as a dictionary.
-        """
-        pass
-
-    @abstractmethod
-    def list_model_endpoints(
-        self,
-        model: str = None,
-        function: str = None,
-        labels: typing.List[str] = None,
-        top_level: bool = None,
-        uids: typing.List = None,
-    ) -> typing.List[typing.Dict[str, typing.Any]]:
-        """
-        Returns a list of model endpoint dictionaries, supports filtering by model, function, labels or top level.
-        By default, when no filters are applied, all available model endpoints for the given project will
-        be listed.
-
-        :param model:           The name of the model to filter by.
-        :param function:        The name of the function to filter by.
-        :param labels:          A list of labels to filter by. Label filters work by either filtering a specific value
-                                of a label (i.e. list("key=value")) or by looking for the existence of a given
-                                key (i.e. "key").
-        :param top_level:       If True will return only routers and endpoint that are NOT children of any router.
-        :param uids:             List of model endpoint unique ids to include in the result.
-
-        :return: A list of model endpoint dictionaries.
-        """
-        pass
-
-    @abstractmethod
-    def get_endpoint_real_time_metrics(
-        self,
-        endpoint_id: str,
-        metrics: typing.List[str],
-        start: str = "now-1h",
-        end: str = "now",
-        access_key: str = None,
-    ) -> typing.Dict[str, typing.List[typing.Tuple[str, float]]]:
-        """
-        Getting metrics from the time series DB. There are pre-defined metrics for model endpoints such as
-        `predictions_per_second` and `latency_avg_5m` but also custom metrics defined by the user.
-
-        :param endpoint_id:      The unique id of the model endpoint.
-        :param metrics:          A list of real-time metrics to return for the model endpoint.
-        :param start:            The start time of the metrics. Can be represented by a string containing an RFC 3339
-                                 time, a Unix timestamp in milliseconds, a relative time (`'now'` or
-                                 `'now-[0-9]+[mhd]'`, where `m` = minutes, `h` = hours, and `'d'` = days), or 0 for the
-                                 earliest time.
-        :param end:              The end time of the metrics. Can be represented by a string containing an RFC 3339
-                                 time, a Unix timestamp in milliseconds, a relative time (`'now'` or
-                                 `'now-[0-9]+[mhd]'`, where `m` = minutes, `h` = hours, and `'d'` = days), or 0 for the
-                                 earliest time.
-        :param access_key:       V3IO access key that will be used for generating Frames client object. If not
-                                 provided, the access key will be retrieved from the environment variables.
-
-        :return: A dictionary of metrics in which the key is a metric name and the value is a list of tuples that
-                 includes timestamps and the values.
-        """
-
-        pass

mlrun/model_monitoring/stores/models/__init__.py

@@ -1,23 +0,0 @@
-# Copyright 2018 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.
-#
-
-
-def get_ModelEndpointsTable(connection_string: str = None):
-    """Return ModelEndpointsTable based on the provided connection string"""
-    if "mysql:" in connection_string:
-        from .mysql import ModelEndpointsTable
-    else:
-        from .sqlite import ModelEndpointsTable
-    return ModelEndpointsTable

mlrun/model_monitoring/stores/models/base.py

@@ -1,18 +0,0 @@
-# Copyright 2018 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 sqlalchemy.ext.declarative import declarative_base
-
-Base = declarative_base()

mlrun/model_monitoring/stores/models/mysql.py

@@ -1,100 +0,0 @@
-# Copyright 2018 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 sqlalchemy.dialects
-from sqlalchemy import Boolean, Column, Integer, String, Text
-
-import mlrun.model_monitoring.constants as model_monitoring_constants
-from mlrun.utils.db import BaseModel
-
-from .base import Base
-
-
-class ModelEndpointsTable(Base, BaseModel):
-    __tablename__ = model_monitoring_constants.EventFieldType.MODEL_ENDPOINTS
-
-    uid = Column(
-        model_monitoring_constants.EventFieldType.UID,
-        String(40),
-        primary_key=True,
-    )
-    state = Column(model_monitoring_constants.EventFieldType.STATE, String(10))
-    project = Column(model_monitoring_constants.EventFieldType.PROJECT, String(40))
-    function_uri = Column(
-        model_monitoring_constants.EventFieldType.FUNCTION_URI,
-        String(255),
-    )
-    model = Column(model_monitoring_constants.EventFieldType.MODEL, String(255))
-    model_class = Column(
-        model_monitoring_constants.EventFieldType.MODEL_CLASS,
-        String(255),
-    )
-    labels = Column(model_monitoring_constants.EventFieldType.LABELS, Text)
-    model_uri = Column(model_monitoring_constants.EventFieldType.MODEL_URI, String(255))
-    stream_path = Column(model_monitoring_constants.EventFieldType.STREAM_PATH, Text)
-    algorithm = Column(
-        model_monitoring_constants.EventFieldType.ALGORITHM,
-        String(255),
-    )
-    active = Column(model_monitoring_constants.EventFieldType.ACTIVE, Boolean)
-    monitoring_mode = Column(
-        model_monitoring_constants.EventFieldType.MONITORING_MODE,
-        String(10),
-    )
-    feature_stats = Column(
-        model_monitoring_constants.EventFieldType.FEATURE_STATS, Text
-    )
-    current_stats = Column(
-        model_monitoring_constants.EventFieldType.CURRENT_STATS, Text
-    )
-    feature_names = Column(
-        model_monitoring_constants.EventFieldType.FEATURE_NAMES, Text
-    )
-    children = Column(model_monitoring_constants.EventFieldType.CHILDREN, Text)
-    label_names = Column(model_monitoring_constants.EventFieldType.LABEL_NAMES, Text)
-
-    endpoint_type = Column(
-        model_monitoring_constants.EventFieldType.ENDPOINT_TYPE,
-        String(10),
-    )
-    children_uids = Column(
-        model_monitoring_constants.EventFieldType.CHILDREN_UIDS, Text
-    )
-    drift_measures = Column(
-        model_monitoring_constants.EventFieldType.DRIFT_MEASURES, Text
-    )
-    drift_status = Column(
-        model_monitoring_constants.EventFieldType.DRIFT_STATUS,
-        String(40),
-    )
-    monitor_configuration = Column(
-        model_monitoring_constants.EventFieldType.MONITOR_CONFIGURATION,
-        Text,
-    )
-    monitoring_feature_set_uri = Column(
-        model_monitoring_constants.EventFieldType.FEATURE_SET_URI,
-        String(255),
-    )
-    first_request = Column(
-        model_monitoring_constants.EventFieldType.FIRST_REQUEST,
-        sqlalchemy.dialects.mysql.TIMESTAMP(fsp=3),
-    )
-    last_request = Column(
-        model_monitoring_constants.EventFieldType.LAST_REQUEST,
-        sqlalchemy.dialects.mysql.TIMESTAMP(fsp=3),
-    )
-    error_count = Column(model_monitoring_constants.EventFieldType.ERROR_COUNT, Integer)
-    metrics = Column(model_monitoring_constants.EventFieldType.METRICS, Text)

mlrun/model_monitoring/stores/models/sqlite.py

@@ -1,98 +0,0 @@
-# Copyright 2018 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 sqlalchemy import TIMESTAMP, Boolean, Column, Integer, String, Text
-
-import mlrun.model_monitoring.constants as model_monitoring_constants
-from mlrun.utils.db import BaseModel
-
-from .base import Base
-
-
-class ModelEndpointsTable(Base, BaseModel):
-    __tablename__ = model_monitoring_constants.EventFieldType.MODEL_ENDPOINTS
-
-    uid = Column(
-        model_monitoring_constants.EventFieldType.UID,
-        String(40),
-        primary_key=True,
-    )
-    state = Column(model_monitoring_constants.EventFieldType.STATE, String(10))
-    project = Column(model_monitoring_constants.EventFieldType.PROJECT, String(40))
-    function_uri = Column(
-        model_monitoring_constants.EventFieldType.FUNCTION_URI,
-        String(255),
-    )
-    model = Column(model_monitoring_constants.EventFieldType.MODEL, String(255))
-    model_class = Column(
-        model_monitoring_constants.EventFieldType.MODEL_CLASS,
-        String(255),
-    )
-    labels = Column(model_monitoring_constants.EventFieldType.LABELS, Text)
-    model_uri = Column(model_monitoring_constants.EventFieldType.MODEL_URI, String(255))
-    stream_path = Column(model_monitoring_constants.EventFieldType.STREAM_PATH, Text)
-    algorithm = Column(
-        model_monitoring_constants.EventFieldType.ALGORITHM,
-        String(255),
-    )
-    active = Column(model_monitoring_constants.EventFieldType.ACTIVE, Boolean)
-    monitoring_mode = Column(
-        model_monitoring_constants.EventFieldType.MONITORING_MODE,
-        String(10),
-    )
-    feature_stats = Column(
-        model_monitoring_constants.EventFieldType.FEATURE_STATS, Text
-    )
-    current_stats = Column(
-        model_monitoring_constants.EventFieldType.CURRENT_STATS, Text
-    )
-    feature_names = Column(
-        model_monitoring_constants.EventFieldType.FEATURE_NAMES, Text
-    )
-    children = Column(model_monitoring_constants.EventFieldType.CHILDREN, Text)
-    label_names = Column(model_monitoring_constants.EventFieldType.LABEL_NAMES, Text)
-    endpoint_type = Column(
-        model_monitoring_constants.EventFieldType.ENDPOINT_TYPE,
-        String(10),
-    )
-    children_uids = Column(
-        model_monitoring_constants.EventFieldType.CHILDREN_UIDS, Text
-    )
-    drift_measures = Column(
-        model_monitoring_constants.EventFieldType.DRIFT_MEASURES, Text
-    )
-    drift_status = Column(
-        model_monitoring_constants.EventFieldType.DRIFT_STATUS,
-        String(40),
-    )
-    monitor_configuration = Column(
-        model_monitoring_constants.EventFieldType.MONITOR_CONFIGURATION,
-        Text,
-    )
-    monitoring_feature_set_uri = Column(
-        model_monitoring_constants.EventFieldType.FEATURE_SET_URI,
-        String(255),
-    )
-    first_request = Column(
-        model_monitoring_constants.EventFieldType.FIRST_REQUEST,
-        TIMESTAMP,
-    )
-    last_request = Column(
-        model_monitoring_constants.EventFieldType.LAST_REQUEST,
-        TIMESTAMP,
-    )
-    error_count = Column(model_monitoring_constants.EventFieldType.ERROR_COUNT, Integer)
-    metrics = Column(model_monitoring_constants.EventFieldType.METRICS, Text)