mlrun 1.7.2__py3-none-any.whl → 1.8.0rc1__py3-none-any.whl

mlrun/frameworks/_common/mlrun_interface.py

@@ -17,7 +17,7 @@ import functools
 import inspect
 from abc import ABC
 from types import FunctionType, MethodType
-from typing import Any, Generic, Union
+from typing import Any, Generic, Optional, Union
 
 from .utils import CommonTypes
 
@@ -173,7 +173,7 @@ class MLRunInterface(ABC, Generic[CommonTypes.MLRunInterfaceableType]):
     def _insert_properties(
         cls,
         obj: CommonTypes.MLRunInterfaceableType,
-        properties: dict[str, Any] = None,
+        properties: Optional[dict[str, Any]] = None,
     ):
         """
         Insert the properties of the interface to the object. The properties default values are being copied (not deep
@@ -238,7 +238,9 @@ class MLRunInterface(ABC, Generic[CommonTypes.MLRunInterfaceableType]):
 
     @classmethod
     def _replace_properties(
-        cls, obj: CommonTypes.MLRunInterfaceableType, properties: dict[str, Any] = None
+        cls,
+        obj: CommonTypes.MLRunInterfaceableType,
+        properties: Optional[dict[str, Any]] = None,
     ):
         """
         Replace the properties of the given object according to the configuration in the MLRun interface.
@@ -282,7 +284,9 @@ class MLRunInterface(ABC, Generic[CommonTypes.MLRunInterfaceableType]):
 
     @classmethod
     def _replace_functions(
-        cls, obj: CommonTypes.MLRunInterfaceableType, functions: list[str] = None
+        cls,
+        obj: CommonTypes.MLRunInterfaceableType,
+        functions: Optional[list[str]] = None,
     ):
         """
         Replace the functions / methods of the given object according to the configuration in the MLRun interface.
@@ -417,8 +421,8 @@ class MLRunInterface(ABC, Generic[CommonTypes.MLRunInterfaceableType]):
     def _get_function_argument(
         func: FunctionType,
         argument_name: str,
-        passed_args: tuple = None,
-        passed_kwargs: dict = None,
+        passed_args: Optional[tuple] = None,
+        passed_kwargs: Optional[dict] = None,
         default_value: Any = None,
     ) -> tuple[Any, Union[str, int, None]]:
         """

mlrun/frameworks/_common/model_handler.py

@@ -20,7 +20,7 @@ import sys
 import zipfile
 from abc import ABC, abstractmethod
 from types import MethodType
-from typing import Any, Generic, Union
+from typing import Any, Generic, Optional, Union
 
 import numpy as np
 
@@ -55,7 +55,7 @@ class ModelHandler(ABC, Generic[CommonTypes.ModelType, CommonTypes.IOSampleType]
         self,
         model: CommonTypes.ModelType = None,
         model_path: CommonTypes.PathType = None,
-        model_name: str = None,
+        model_name: Optional[str] = None,
         modules_map: Union[
             dict[str, Union[None, str, list[str]]], CommonTypes.PathType
         ] = None,
@@ -306,7 +306,7 @@ class ModelHandler(ABC, Generic[CommonTypes.ModelType, CommonTypes.IOSampleType]
     def set_inputs(
         self,
         from_sample: CommonTypes.IOSampleType = None,
-        features: list[Feature] = None,
+        features: Optional[list[Feature]] = None,
         **kwargs,
     ):
         """
@@ -335,7 +335,7 @@ class ModelHandler(ABC, Generic[CommonTypes.ModelType, CommonTypes.IOSampleType]
     def set_outputs(
         self,
         from_sample: CommonTypes.IOSampleType = None,
-        features: list[Feature] = None,
+        features: Optional[list[Feature]] = None,
         **kwargs,
     ):
         """
@@ -363,8 +363,8 @@ class ModelHandler(ABC, Generic[CommonTypes.ModelType, CommonTypes.IOSampleType]
 
     def set_labels(
         self,
-        to_add: dict[str, Union[str, int, float]] = None,
-        to_remove: list[str] = None,
+        to_add: Optional[dict[str, Union[str, int, float]]] = None,
+        to_remove: Optional[list[str]] = None,
     ):
         """
         Update the labels dictionary of this model artifact.
@@ -383,8 +383,8 @@ class ModelHandler(ABC, Generic[CommonTypes.ModelType, CommonTypes.IOSampleType]
 
     def set_parameters(
         self,
-        to_add: dict[str, Union[str, int, float]] = None,
-        to_remove: list[str] = None,
+        to_add: Optional[dict[str, Union[str, int, float]]] = None,
+        to_remove: Optional[list[str]] = None,
     ):
         """
         Update the parameters dictionary of this model artifact.
@@ -403,8 +403,8 @@ class ModelHandler(ABC, Generic[CommonTypes.ModelType, CommonTypes.IOSampleType]
 
     def set_metrics(
         self,
-        to_add: dict[str, CommonTypes.ExtraDataType] = None,
-        to_remove: list[str] = None,
+        to_add: Optional[dict[str, CommonTypes.ExtraDataType]] = None,
+        to_remove: Optional[list[str]] = None,
     ):
         """
         Update the metrics dictionary of this model artifact.
@@ -423,8 +423,8 @@ class ModelHandler(ABC, Generic[CommonTypes.ModelType, CommonTypes.IOSampleType]
 
     def set_extra_data(
         self,
-        to_add: dict[str, CommonTypes.ExtraDataType] = None,
-        to_remove: list[str] = None,
+        to_add: Optional[dict[str, CommonTypes.ExtraDataType]] = None,
+        to_remove: Optional[list[str]] = None,
     ):
         """
         Update the extra data dictionary of this model artifact.
@@ -509,7 +509,9 @@ class ModelHandler(ABC, Generic[CommonTypes.ModelType, CommonTypes.IOSampleType]
             self._import_custom_objects()
 
     @abstractmethod
-    def to_onnx(self, model_name: str = None, optimize: bool = True, **kwargs):
+    def to_onnx(
+        self, model_name: Optional[str] = None, optimize: bool = True, **kwargs
+    ):
         """
         Convert the model in this handler to an ONNX model.
 
@@ -525,13 +527,13 @@ class ModelHandler(ABC, Generic[CommonTypes.ModelType, CommonTypes.IOSampleType]
     def log(
         self,
         tag: str = "",
-        labels: dict[str, Union[str, int, float]] = None,
-        parameters: dict[str, Union[str, int, float]] = None,
-        inputs: list[Feature] = None,
-        outputs: list[Feature] = None,
-        metrics: dict[str, Union[int, float]] = None,
-        artifacts: dict[str, Artifact] = None,
-        extra_data: dict[str, CommonTypes.ExtraDataType] = None,
+        labels: Optional[dict[str, Union[str, int, float]]] = None,
+        parameters: Optional[dict[str, Union[str, int, float]]] = None,
+        inputs: Optional[list[Feature]] = None,
+        outputs: Optional[list[Feature]] = None,
+        metrics: Optional[dict[str, Union[int, float]]] = None,
+        artifacts: Optional[dict[str, Artifact]] = None,
+        extra_data: Optional[dict[str, CommonTypes.ExtraDataType]] = None,
         **kwargs,
     ):
         """
@@ -630,13 +632,13 @@ class ModelHandler(ABC, Generic[CommonTypes.ModelType, CommonTypes.IOSampleType]
 
     def update(
         self,
-        labels: dict[str, Union[str, int, float]] = None,
-        parameters: dict[str, Union[str, int, float]] = None,
-        inputs: list[Feature] = None,
-        outputs: list[Feature] = None,
-        metrics: dict[str, Union[int, float]] = None,
-        artifacts: dict[str, Artifact] = None,
-        extra_data: dict[str, CommonTypes.ExtraDataType] = None,
+        labels: Optional[dict[str, Union[str, int, float]]] = None,
+        parameters: Optional[dict[str, Union[str, int, float]]] = None,
+        inputs: Optional[list[Feature]] = None,
+        outputs: Optional[list[Feature]] = None,
+        metrics: Optional[dict[str, Union[int, float]]] = None,
+        artifacts: Optional[dict[str, Artifact]] = None,
+        extra_data: Optional[dict[str, CommonTypes.ExtraDataType]] = None,
         **kwargs,
     ):
         """

mlrun/frameworks/_common/producer.py

@@ -13,6 +13,8 @@
 # limitations under the License.
 #
 
+from typing import Optional
+
 import mlrun
 from mlrun.artifacts import Artifact
 
@@ -28,7 +30,7 @@ class Producer:
     def __init__(
         self,
         context: mlrun.MLClientCtx = None,
-        plans: list[Plan] = None,
+        plans: Optional[list[Plan]] = None,
     ):
         """
         Initialize a producer with the given plans. The producer will log the produced artifacts using the given

mlrun/frameworks/_dl_common/__init__.py

@@ -11,7 +11,6 @@
 # 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.
-#
-# flake8: noqa  - this is until we take care of the F401 violations with respect to __all__ & sphinx
+
 from .model_handler import DLModelHandler
 from .utils import DLTypes, DLUtils

mlrun/frameworks/_dl_common/loggers/__init__.py

@@ -11,8 +11,7 @@
 # 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.
-#
-# flake8: noqa  - this is until we take care of the F401 violations with respect to __all__ & sphinx
+
 from .logger import Logger
 from .mlrun_logger import MLRunLogger
 from .tensorboard_logger import TensorboardLogger

mlrun/frameworks/_dl_common/loggers/mlrun_logger.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 #
 import itertools
-from typing import Union
+from typing import Optional, Union
 
 import numpy as np
 import plotly.graph_objects as go
@@ -144,9 +144,9 @@ class MLRunLogger(Logger):
         self,
         model_handler: DLModelHandler,
         tag: str = "",
-        labels: dict[str, DLTypes.TrackableType] = None,
-        parameters: dict[str, DLTypes.TrackableType] = None,
-        extra_data: dict[str, Union[DLTypes.TrackableType, Artifact]] = None,
+        labels: Optional[dict[str, DLTypes.TrackableType]] = None,
+        parameters: Optional[dict[str, DLTypes.TrackableType]] = None,
+        extra_data: Optional[dict[str, Union[DLTypes.TrackableType, Artifact]]] = None,
     ):
         """
         Log the run, summarizing the validation metrics and dynamic hyperparameters across all epochs. If 'update' is

mlrun/frameworks/_dl_common/loggers/tensorboard_logger.py

@@ -15,7 +15,7 @@
 import os
 from abc import abstractmethod
 from datetime import datetime
-from typing import Any, Callable, Generic, Union
+from typing import Any, Callable, Generic, Optional, Union
 
 import yaml
 
@@ -64,8 +64,8 @@ class TensorboardLogger(Logger, Generic[DLTypes.WeightType]):
             Callable[[DLTypes.WeightType], Union[float, DLTypes.WeightType]]
         ],
         context: mlrun.MLClientCtx = None,
-        tensorboard_directory: str = None,
-        run_name: str = None,
+        tensorboard_directory: Optional[str] = None,
+        run_name: Optional[str] = None,
         update_frequency: Union[int, str] = "epoch",
     ):
         """

mlrun/frameworks/_ml_common/__init__.py

@@ -11,8 +11,7 @@
 # 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.
-#
-# flake8: noqa  - this is until we take care of the F401 violations with respect to __all__ & sphinx
+
 from .artifacts_library import MLArtifactsLibrary
 from .model_handler import MLModelHandler
 from .pkl_model_server import PickleModelServer

mlrun/frameworks/_ml_common/loggers/__init__.py

@@ -11,7 +11,6 @@
 # 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.
-#
-# flake8: noqa  - this is until we take care of the F401 violations with respect to __all__ & sphinx
+
 from .logger import Logger
 from .mlrun_logger import MLRunLogger

mlrun/frameworks/_ml_common/model_handler.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 #
 from abc import ABC
-from typing import Union
+from typing import Optional, Union
 
 import mlrun
 from mlrun.artifacts import Artifact
@@ -33,7 +33,7 @@ class MLModelHandler(ModelHandler, ABC):
         self,
         model: MLTypes.ModelType = None,
         model_path: MLTypes.PathType = None,
-        model_name: str = None,
+        model_name: Optional[str] = None,
         modules_map: Union[
             dict[str, Union[None, str, list[str]]], MLTypes.PathType
         ] = None,
@@ -224,18 +224,18 @@ class MLModelHandler(ModelHandler, ABC):
     def log(
         self,
         tag: str = "",
-        labels: dict[str, Union[str, int, float]] = None,
-        parameters: dict[str, Union[str, int, float]] = None,
-        inputs: list[Feature] = None,
-        outputs: list[Feature] = None,
-        metrics: dict[str, Union[int, float]] = None,
-        artifacts: dict[str, Artifact] = None,
-        extra_data: dict[str, MLTypes.ExtraDataType] = None,
-        algorithm: str = None,
+        labels: Optional[dict[str, Union[str, int, float]]] = None,
+        parameters: Optional[dict[str, Union[str, int, float]]] = None,
+        inputs: Optional[list[Feature]] = None,
+        outputs: Optional[list[Feature]] = None,
+        metrics: Optional[dict[str, Union[int, float]]] = None,
+        artifacts: Optional[dict[str, Artifact]] = None,
+        extra_data: Optional[dict[str, MLTypes.ExtraDataType]] = None,
+        algorithm: Optional[str] = None,
         sample_set: MLTypes.DatasetType = None,
         target_columns: MLTypes.TargetColumnsNamesType = None,
-        feature_vector: str = None,
-        feature_weights: list[float] = None,
+        feature_vector: Optional[str] = None,
+        feature_weights: Optional[list[float]] = None,
     ):
         """
         Log the model held by this handler into the MLRun context provided.
@@ -299,15 +299,15 @@ class MLModelHandler(ModelHandler, ABC):
 
     def update(
         self,
-        labels: dict[str, Union[str, int, float]] = None,
-        parameters: dict[str, Union[str, int, float]] = None,
-        inputs: list[Feature] = None,
-        outputs: list[Feature] = None,
-        metrics: dict[str, Union[int, float]] = None,
-        artifacts: dict[str, Artifact] = None,
-        extra_data: dict[str, MLTypes.ExtraDataType] = None,
-        feature_vector: str = None,
-        feature_weights: list[float] = None,
+        labels: Optional[dict[str, Union[str, int, float]]] = None,
+        parameters: Optional[dict[str, Union[str, int, float]]] = None,
+        inputs: Optional[list[Feature]] = None,
+        outputs: Optional[list[Feature]] = None,
+        metrics: Optional[dict[str, Union[int, float]]] = None,
+        artifacts: Optional[dict[str, Artifact]] = None,
+        extra_data: Optional[dict[str, MLTypes.ExtraDataType]] = None,
+        feature_vector: Optional[str] = None,
+        feature_weights: Optional[list[float]] = None,
     ):
         """
         Update the model held by this handler into the MLRun context provided, updating the model's artifact properties

mlrun/frameworks/_ml_common/plans/__init__.py

@@ -11,8 +11,7 @@
 # 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.
-#
-# flake8: noqa  - this is until we take care of the F401 violations with respect to __all__ & sphinx
+
 from .calibration_curve_plan import CalibrationCurvePlan
 from .confusion_matrix_plan import ConfusionMatrixPlan
 from .dataset_plan import DatasetPlan

mlrun/frameworks/_ml_common/plans/confusion_matrix_plan.py

@@ -13,6 +13,8 @@
 # limitations under the License.
 #
 
+from typing import Optional
+
 import numpy as np
 import pandas as pd
 from plotly.figure_factory import create_annotated_heatmap
@@ -35,7 +37,7 @@ class ConfusionMatrixPlan(MLPlotPlan):
         self,
         labels: np.ndarray = None,
         sample_weight: np.ndarray = None,
-        normalize: str = None,
+        normalize: Optional[str] = None,
     ):
         """
         Initialize a confusion matrix plan with the given configuration.

mlrun/frameworks/_ml_common/plans/dataset_plan.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 #
 from enum import Enum
-from typing import Union
+from typing import Optional, Union
 
 import mlrun.errors
 from mlrun.artifacts import Artifact, DatasetArtifact
@@ -49,8 +49,8 @@ class DatasetPlan(MLPlan):
     def __init__(
         self,
         purpose: Union[Purposes, str] = Purposes.OTHER,
-        name: str = None,
-        preview: int = None,
+        name: Optional[str] = None,
+        preview: Optional[int] = None,
         stats: bool = False,
         fmt: str = "parquet",
     ):

mlrun/frameworks/_ml_common/plans/roc_curve_plan.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-from typing import Union
+from typing import Optional, Union
 
 import numpy as np
 import pandas as pd
@@ -35,13 +35,13 @@ class ROCCurvePlan(MLPlotPlan):
 
     def __init__(
         self,
-        pos_label: Union[str, int] = None,
+        pos_label: Optional[Union[str, int]] = None,
         sample_weight: np.ndarray = None,
         drop_intermediate: bool = True,
         average: str = "macro",
-        max_fpr: float = None,
+        max_fpr: Optional[float] = None,
         multi_class: str = "raise",
-        labels: list[str] = None,
+        labels: Optional[list[str]] = None,
     ):
         """
         Initialize a receiver operating characteristic plan with the given configuration.

mlrun/frameworks/auto_mlrun/__init__.py

@@ -11,6 +11,5 @@
 # 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.
-#
-# flake8: noqa  - this is until we take care of the F401 violations with respect to __all__ & sphinx
+
 from .auto_mlrun import AutoMLRun

mlrun/frameworks/auto_mlrun/auto_mlrun.py

@@ -11,9 +11,8 @@
 # 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.
-#
-# flake8: noqa  - this is until we take care of the F401 violations with respect to __all__ & sphinx
-from typing import Callable, Union
+
+from typing import Callable, Optional, Union
 
 import mlrun
 from mlrun.artifacts import get_model
@@ -261,7 +260,7 @@ class AutoMLRun:
 
     @staticmethod
     def _get_framework(
-        model: CommonTypes.ModelType = None, model_path: str = None
+        model: CommonTypes.ModelType = None, model_path: Optional[str] = None
     ) -> Union[tuple[str, dict]]:
         """
         Try to get the framework from the model or model path provided. The framework can be read from the model path
@@ -320,12 +319,16 @@ class AutoMLRun:
     @staticmethod
     def load_model(
         model_path: str,
-        model_name: str = None,
+        model_name: Optional[str] = None,
         context: mlrun.MLClientCtx = None,
-        modules_map: Union[dict[str, Union[None, str, list[str]]], str] = None,
-        custom_objects_map: Union[dict[str, Union[str, list[str]]], str] = None,
-        custom_objects_directory: str = None,
-        framework: str = None,
+        modules_map: Optional[
+            Union[dict[str, Union[None, str, list[str]]], str]
+        ] = None,
+        custom_objects_map: Optional[
+            Union[dict[str, Union[str, list[str]]], str]
+        ] = None,
+        custom_objects_directory: Optional[str] = None,
+        framework: Optional[str] = None,
         **kwargs,
     ) -> ModelHandler:
         """
@@ -417,14 +420,18 @@ class AutoMLRun:
     @staticmethod
     def apply_mlrun(
         model: CommonTypes.ModelType = None,
-        model_name: str = None,
+        model_name: Optional[str] = None,
         tag: str = "",
-        model_path: str = None,
-        modules_map: Union[dict[str, Union[None, str, list[str]]], str] = None,
-        custom_objects_map: Union[dict[str, Union[str, list[str]]], str] = None,
-        custom_objects_directory: str = None,
+        model_path: Optional[str] = None,
+        modules_map: Optional[
+            Union[dict[str, Union[None, str, list[str]]], str]
+        ] = None,
+        custom_objects_map: Optional[
+            Union[dict[str, Union[str, list[str]]], str]
+        ] = None,
+        custom_objects_directory: Optional[str] = None,
         context: mlrun.MLClientCtx = None,
-        framework: str = None,
+        framework: Optional[str] = None,
         auto_log: bool = True,
         **kwargs,
     ) -> ModelHandler:

mlrun/frameworks/huggingface/__init__.py

@@ -11,6 +11,5 @@
 # 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.
-#
-# flake8: noqa  - this is until we take care of the F401 violations with respect to __all__ & sphinx
+
 from .model_server import HuggingFaceModelServer

mlrun/frameworks/huggingface/model_server.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Any
+from typing import Any, Optional
 
 import numpy as np
 import transformers
@@ -32,14 +32,14 @@ class HuggingFaceModelServer(V2ModelServer):
     def __init__(
         self,
         context: mlrun.MLClientCtx = None,
-        name: str = None,
-        task: str = None,
-        model_path: str = None,
-        model_name: str = None,
-        model_class: str = None,
-        tokenizer_name: str = None,
-        tokenizer_class: str = None,
-        framework: str = None,
+        name: Optional[str] = None,
+        task: Optional[str] = None,
+        model_path: Optional[str] = None,
+        model_name: Optional[str] = None,
+        model_class: Optional[str] = None,
+        tokenizer_name: Optional[str] = None,
+        tokenizer_class: Optional[str] = None,
+        framework: Optional[str] = None,
         **class_args,
     ):
         """