ml-management 0.4.1__tar.gz → 0.5.1rc0__tar.gz

{ml-management-0.4.1 → ml-management-0.5.1rc0}/ML_management/mlmanagement/load_api.py

@@ -33,7 +33,7 @@ from mlflow.pyfunc import (
 
 
 def download_artifacts_by_name_version(
-    name: str, version: int, model_type: ModelType, path: str, dst_path: Optional[str] = None
+    name: str, version: Optional[int], model_type: ModelType, path: str, dst_path: Optional[str] = None
 ) -> str:
     """Download an artifact by name and version to a local directory, and return a local path for it."""
     url = get_log_service_url("download_artifacts_by_name_version")
@@ -55,7 +55,7 @@ def download_job_artifacts(job_id: str, path: str = "", dst_path: Optional[str]
 
 def _load_model_type(
     name: str,
-    version: int,
+    version: Optional[int],
     model_type: ModelType,
     unwrap: bool = True,
     install_requirements: bool = False,
@@ -79,7 +79,7 @@ def _load_model_type(
 
 def load_dataset(
     name: str,
-    version: int,
+    version: Optional[int] = None,
     install_requirements: bool = False,
     unwrap: bool = True,
     dst_path: Optional[str] = None,
@@ -91,8 +91,8 @@ def load_dataset(
     ==========
     name: str
         Name of the dataset.
-    version: int
-        Version of the dataset.
+    version: Optional[int] = None
+        Version of the dataset. Default: None, "latest" version is used.
     install_requirements: bool = False
         Whether to install dataset requirements. Default: False.
     unwrap: bool = True
@@ -128,7 +128,7 @@ def _set_model_version_requirements(local_path) -> None:
 
 def load_model(
     name: str,
-    version: int,
+    version: Optional[int] = None,
     install_requirements: bool = False,
     unwrap: bool = True,
     dst_path: Optional[str] = None,
@@ -140,8 +140,8 @@ def load_model(
     ==========
     name: str
         Name of the model.
-    version: int
-        Version of the model.
+    version: Optional[int] = None
+        Version of the model. Default: None, "latest" version is used.
     install_requirements: bool = False
         Whether to install model requirements. Default: False.
     unwrap: bool = True
@@ -160,7 +160,7 @@ def load_model(
 
 def load_executor(
     name: str,
-    version: int,
+    version: Optional[int] = None,
     install_requirements: bool = False,
     unwrap: bool = True,
     dst_path: Optional[str] = None,
@@ -171,8 +171,8 @@ def load_executor(
     ==========
     name: str
         Name of the executor.
-    version: int
-        Version of the executor.
+    version: Optional[int] = None
+        Version of the executor. Default: None, "latest" version is used.
     install_requirements: bool = False
         Whether to install executor requirements. Default: False.
     unwrap: bool = True

{ml-management-0.4.1 → ml-management-0.5.1rc0}/ML_management/sdk/__init__.py

@@ -9,7 +9,7 @@ job_metric_by_name = job.job_metric_by_name
 list_model_version = model.list_model_version
 list_dataset_loader_version = dataset_loader.list_dataset_loader_version
 list_executor_version = executor.list_executor_version
-model_version_metainfo = model.model_version_metainfo
+get_model_version = model.get_model_version
 rebuild_model_version_image = model.rebuild_model_version_image
 print_model_schema_for_executor = executor.print_model_schema_for_executor
 generate_model_params_for_executor = executor.generate_model_params_for_executor
@@ -43,13 +43,13 @@ get_experiment_by_id = experiment.get_experiment_by_name
 get_experiment_by_name = experiment.get_experiment_by_name
 ModelMethodParams = parameters.ModelMethodParams
 ModelVersionChoice = parameters.ModelVersionChoice
-SingleModel = parameters.SingleModel
+ModelForm = parameters.ModelForm
 ModelWithRole = parameters.ModelWithRole
-ArbitraryModels = parameters.ArbitraryModels
+AnyModelForm = parameters.AnyModelForm
 DatasetLoaderMethodParams = parameters.DatasetLoaderMethodParams
-SingleDatasetLoader = parameters.SingleDatasetLoader
+DatasetLoaderForm = parameters.DatasetLoaderForm
 DatasetLoaderWithRole = parameters.DatasetLoaderWithRole
-ArbitraryDatasetLoaders = parameters.ArbitraryDatasetLoaders
+AnyDatasetLoaderForm = parameters.AnyDatasetLoaderForm
 get_dataset_loader_version_requirements = dataset_loader.get_dataset_loader_version_requirements
 get_executor_version_requirements = executor.get_executor_version_requirements
 get_model_version_requirements = model.get_model_version_requirements
@@ -77,4 +77,8 @@ set_dataset_loader_tag = dataset_loader.set_dataset_loader_tag
 set_executor_tag = executor.set_executor_tag
 set_model_tag = model.set_model_tag
 get_latest_model_version = model.get_latest_model_version
+get_latest_executor_version = executor.get_latest_executor_version
+get_latest_dataset_loader_version = dataset_loader.get_latest_dataset_loader_version
 get_initial_model_version = model.get_initial_model_version
+get_initial_executor_version = executor.get_initial_executor_version
+get_initial_dataset_loader_version = dataset_loader.get_initial_dataset_loader_version

{ml-management-0.4.1 → ml-management-0.5.1rc0}/ML_management/sdk/dataset_loader.py

@@ -5,7 +5,7 @@ from sgqlc.operation import Operation
 
 from ML_management.dataset_loader.dataset_loader_pattern_to_methods_map import DatasetLoaderMethodName
 from ML_management.sdk import schema
-from ML_management.sdk.schema import DatasetLoader, DatasetLoaderVersion
+from ML_management.sdk.schema import DatasetLoaderInfo, DatasetLoaderVersionInfo
 from ML_management.sdk.sdk import _print_params_by_schema, _to_datetime, send_graphql_request
 
 
@@ -30,7 +30,7 @@ def list_dataset_loader() -> pd.DataFrame:
     return df
 
 
-def set_dataset_loader_tag(name: str, key: str, value: str) -> DatasetLoader:
+def set_dataset_loader_tag(name: str, key: str, value: str) -> DatasetLoaderInfo:
     """
     Set dataset loader tag.
 
@@ -45,7 +45,7 @@ def set_dataset_loader_tag(name: str, key: str, value: str) -> DatasetLoader:
 
     Returns
     -------
-    DatasetLoader
+    DatasetLoaderInfo
         DatasetLoader instance with meta information.
     """
     op = Operation(schema.Mutation)
@@ -53,10 +53,10 @@ def set_dataset_loader_tag(name: str, key: str, value: str) -> DatasetLoader:
     set_tag.name()
     set_tag.tags()
     dataset_loader = send_graphql_request(op=op)
-    return DatasetLoader(dataset_loader)
+    return DatasetLoaderInfo(dataset_loader)
 
 
-def delete_dataset_loader_tag(name: str, key: str) -> DatasetLoader:
+def delete_dataset_loader_tag(name: str, key: str) -> DatasetLoaderInfo:
     """
     Delete dataset loader tag.
 
@@ -69,7 +69,7 @@ def delete_dataset_loader_tag(name: str, key: str) -> DatasetLoader:
 
     Returns
     -------
-    DatasetLoader
+    DatasetLoaderInfo
         DatasetLoader instance with meta information.
     """
     op = Operation(schema.Mutation)
@@ -77,10 +77,10 @@ def delete_dataset_loader_tag(name: str, key: str) -> DatasetLoader:
     delete_tag.name()
     delete_tag.tags()
     dataset_loader = send_graphql_request(op=op)
-    return DatasetLoader(dataset_loader)
+    return DatasetLoaderInfo(dataset_loader)
 
 
-def set_dataset_loader_description(name: str, description: str) -> DatasetLoader:
+def set_dataset_loader_description(name: str, description: str) -> DatasetLoaderInfo:
     """
     Set dataset loader description.
 
@@ -93,7 +93,7 @@ def set_dataset_loader_description(name: str, description: str) -> DatasetLoader
 
     Returns
     -------
-    DatasetLoader
+    DatasetLoaderInfo
         DatasetLoader instance with meta information.
     """
     op = Operation(schema.Mutation)
@@ -101,7 +101,7 @@ def set_dataset_loader_description(name: str, description: str) -> DatasetLoader
     set_description.name()
     set_description.description()
     dataset_loader = send_graphql_request(op=op)
-    return DatasetLoader(dataset_loader)
+    return DatasetLoaderInfo(dataset_loader)
 
 
 def list_dataset_loader_version(name: str) -> pd.DataFrame:
@@ -194,7 +194,7 @@ def print_dataset_loader_schema(name: str, version: Optional[int] = None) -> Non
         _print_params_by_schema(json_schema=schema_, schema_type=DatasetLoaderMethodName(method_name).name)
 
 
-def set_dataset_loader_version_description(name: str, version: int, description: str) -> DatasetLoaderVersion:
+def set_dataset_loader_version_description(name: str, version: int, description: str) -> DatasetLoaderVersionInfo:
     """
     Set dataset loader version description.
 
@@ -209,7 +209,7 @@ def set_dataset_loader_version_description(name: str, version: int, description:
 
     Returns
     -------
-    DatasetLoaderVersion
+    DatasetLoaderVersionInfo
         Dataset loader version instance with meta information.
     """
     op = Operation(schema.Mutation)
@@ -220,10 +220,10 @@ def set_dataset_loader_version_description(name: str, version: int, description:
     set_description.description()
 
     dataset_loader = send_graphql_request(op=op)
-    return DatasetLoaderVersion(dataset_loader)
+    return DatasetLoaderVersionInfo(dataset_loader)
 
 
-def set_dataset_loader_version_tag(name: str, version: int, key: str, value: str) -> DatasetLoaderVersion:
+def set_dataset_loader_version_tag(name: str, version: int, key: str, value: str) -> DatasetLoaderVersionInfo:
     """
     Set dataset loader version tag.
 
@@ -240,7 +240,7 @@ def set_dataset_loader_version_tag(name: str, version: int, key: str, value: str
 
     Returns
     -------
-    DatasetLoaderVersion
+    DatasetLoaderVersionInfo
         Dataset loader version instance with meta information.
     """
     op = Operation(schema.Mutation)
@@ -250,10 +250,10 @@ def set_dataset_loader_version_tag(name: str, version: int, key: str, value: str
     set_tag.version()
     set_tag.tags()
     dataset_loader = send_graphql_request(op=op)
-    return DatasetLoaderVersion(dataset_loader)
+    return DatasetLoaderVersionInfo(dataset_loader)
 
 
-def delete_dataset_loader_version_tag(name: str, version: int, key: str) -> DatasetLoaderVersion:
+def delete_dataset_loader_version_tag(name: str, version: int, key: str) -> DatasetLoaderVersionInfo:
     """
     Delete dataset loader version tag.
 
@@ -268,7 +268,7 @@ def delete_dataset_loader_version_tag(name: str, version: int, key: str) -> Data
 
     Returns
     -------
-    DatasetLoaderVersion
+    DatasetLoaderVersionInfo
         Dataset loader version instance with meta information.
     """
     op = Operation(schema.Mutation)
@@ -278,10 +278,10 @@ def delete_dataset_loader_version_tag(name: str, version: int, key: str) -> Data
     delete_tag.version()
     delete_tag.tags()
     dataset_loader = send_graphql_request(op=op)
-    return DatasetLoaderVersion(dataset_loader)
+    return DatasetLoaderVersionInfo(dataset_loader)
 
 
-def get_dataset_loader_version(name: str, version: Optional[int] = None) -> DatasetLoaderVersion:
+def get_dataset_loader_version(name: str, version: Optional[int] = None) -> DatasetLoaderVersionInfo:
     """
     Meta information about the dataset loader version by the dataset loader name and version.
 
@@ -294,7 +294,7 @@ def get_dataset_loader_version(name: str, version: Optional[int] = None) -> Data
 
     Returns
     -------
-    DatasetLoaderVersion
+    DatasetLoaderVersionInfo
         DatasetLoaderVersion instance with meta information.
     """
     op = Operation(schema.Query)
@@ -356,3 +356,45 @@ def get_dataset_loader_version_requirements(name: str, version: int) -> list:
     base_query.list_requirements()
     model_version = send_graphql_request(op, json_response=False)
     return model_version.dataset_loader_version_from_name_version.list_requirements
+
+
+def get_latest_dataset_loader_version(name) -> DatasetLoaderVersionInfo:
+    """
+    Latest dataset loader version by the dataset loader name.
+
+    Parameters
+    ----------
+    name: str
+        Name of the dataset loader.
+
+    Returns
+    -------
+    DatasetLoaderVersionInfo
+        DatasetLoaderVersion instance with meta information.
+    """
+    return get_dataset_loader_version(name)
+
+
+def get_initial_dataset_loader_version(name) -> DatasetLoaderVersionInfo:
+    """
+    Initial dataset loader version by the dataset loader name.
+
+    Parameters
+    ----------
+    name: str
+        Name of the dataset loader.
+
+    Returns
+    -------
+    DatasetLoaderVersionInfo
+        DatasetLoaderVersion instance with meta information.
+    """
+    op = Operation(schema.Query)
+    version = op.dataset_loader_from_name(name=name).init_dataset_loader_version()
+    version.name()
+    version.version()
+    version.tags()
+    version.description()
+    version.run.run_id()
+    dataset_loader_version = send_graphql_request(op, json_response=False)
+    return dataset_loader_version.dataset_loader_version_from_name_version

{ml-management-0.4.1 → ml-management-0.5.1rc0}/ML_management/sdk/executor.py

@@ -7,8 +7,8 @@ from ML_management.executor import BaseExecutor
 from ML_management.model.model_type_to_methods_map import ModelMethodName
 from ML_management.sdk import schema
 from ML_management.sdk.model import get_latest_model_version
-from ML_management.sdk.parameters import ArbitraryModels, ModelMethodParams, ModelVersionChoice, ModelWithRole
-from ML_management.sdk.schema import Executor, ExecutorVersion
+from ML_management.sdk.parameters import AnyModelForm, ModelMethodParams, ModelVersionChoice, ModelWithRole
+from ML_management.sdk.schema import ExecutorInfo, ExecutorVersionInfo
 from ML_management.sdk.sdk import _generate_fake_schema, _print_params_by_schema, _to_datetime, send_graphql_request
 
 
@@ -33,7 +33,7 @@ def list_executor() -> pd.DataFrame:
     return df
 
 
-def set_executor_tag(name: str, key: str, value: str) -> Executor:
+def set_executor_tag(name: str, key: str, value: str) -> ExecutorInfo:
     """
     Set executor tag.
 
@@ -48,7 +48,7 @@ def set_executor_tag(name: str, key: str, value: str) -> Executor:
 
     Returns
     -------
-    Executor
+    ExecutorInfo
         Executor instance with meta information.
     """
     op = Operation(schema.Mutation)
@@ -56,10 +56,10 @@ def set_executor_tag(name: str, key: str, value: str) -> Executor:
     set_tag.name()
     set_tag.tags()
     executor = send_graphql_request(op=op)
-    return Executor(executor)
+    return ExecutorInfo(executor)
 
 
-def delete_executor_tag(name: str, key: str) -> Executor:
+def delete_executor_tag(name: str, key: str) -> ExecutorInfo:
     """
     Delete executor tag.
 
@@ -72,7 +72,7 @@ def delete_executor_tag(name: str, key: str) -> Executor:
 
     Returns
     -------
-    Executor
+    ExecutorInfo
         Executor instance with meta information.
     """
     op = Operation(schema.Mutation)
@@ -80,10 +80,10 @@ def delete_executor_tag(name: str, key: str) -> Executor:
     delete_tag.name()
     delete_tag.tags()
     executor = send_graphql_request(op=op)
-    return Executor(executor)
+    return ExecutorInfo(executor)
 
 
-def set_executor_description(name: str, description: str) -> Executor:
+def set_executor_description(name: str, description: str) -> ExecutorInfo:
     """
     Set executor description.
 
@@ -96,7 +96,7 @@ def set_executor_description(name: str, description: str) -> Executor:
 
     Returns
     -------
-    Executor
+    ExecutorInfo
         Executor instance with meta information.
     """
     op = Operation(schema.Mutation)
@@ -104,7 +104,7 @@ def set_executor_description(name: str, description: str) -> Executor:
     set_description.name()
     set_description.description()
     executor = send_graphql_request(op=op)
-    return Executor(executor)
+    return ExecutorInfo(executor)
 
 
 def delete_executor(executor_name: str) -> bool:
@@ -285,7 +285,7 @@ def _get_model_schema_for_executor(executor_name: str, executor_version: Optiona
 
 def generate_model_params_for_executor(
     executor_name: str, models: List[dict], executor_version: Optional[int] = None
-) -> Union[List[ModelMethodParams], ArbitraryModels]:
+) -> Union[List[ModelMethodParams], AnyModelForm]:
     """
     Return example of model's methods parameters for executor.
 
@@ -410,7 +410,7 @@ def generate_model_params_for_executor(
 
         sdk_models.append(current_model)
 
-    return ArbitraryModels(models=sdk_models)
+    return AnyModelForm(models=sdk_models)
 
 
 def print_executor_schema(name: str, version: Optional[int] = None) -> None:
@@ -479,7 +479,7 @@ def get_required_classes_by_executor(name: str, version: Optional[int] = None) -
     return json_data["executorVersionFromNameVersion"]["desiredModelPatterns"]
 
 
-def set_executor_version_description(name: str, version: int, description: str) -> ExecutorVersion:
+def set_executor_version_description(name: str, version: int, description: str) -> ExecutorVersionInfo:
     """
     Set executor version description.
 
@@ -494,7 +494,7 @@ def set_executor_version_description(name: str, version: int, description: str)
 
     Returns
     -------
-    ExecutorVersion
+    ExecutorVersionInfo
         Executor version instance with meta information.
     """
     op = Operation(schema.Mutation)
@@ -505,10 +505,10 @@ def set_executor_version_description(name: str, version: int, description: str)
     set_description.description()
 
     executor = send_graphql_request(op=op)
-    return ExecutorVersion(executor)
+    return ExecutorVersionInfo(executor)
 
 
-def set_executor_version_tag(name: str, version: int, key: str, value: str) -> ExecutorVersion:
+def set_executor_version_tag(name: str, version: int, key: str, value: str) -> ExecutorVersionInfo:
     """
     Set executor version tag.
 
@@ -525,7 +525,7 @@ def set_executor_version_tag(name: str, version: int, key: str, value: str) -> E
 
     Returns
     -------
-    ExecutorVersion
+    ExecutorVersionInfo
         Executor version instance with meta information.
     """
     op = Operation(schema.Mutation)
@@ -535,10 +535,10 @@ def set_executor_version_tag(name: str, version: int, key: str, value: str) -> E
     set_tag.version()
     set_tag.tags()
     executor = send_graphql_request(op=op)
-    return ExecutorVersion(executor)
+    return ExecutorVersionInfo(executor)
 
 
-def delete_executor_version_tag(name: str, version: int, key: str) -> ExecutorVersion:
+def delete_executor_version_tag(name: str, version: int, key: str) -> ExecutorVersionInfo:
     """
     Delete executor version tag.
 
@@ -553,7 +553,7 @@ def delete_executor_version_tag(name: str, version: int, key: str) -> ExecutorVe
 
     Returns
     -------
-    ExecutorVersion
+    ExecutorVersionInfo
         Executor version instance with meta information.
     """
     op = Operation(schema.Mutation)
@@ -563,10 +563,10 @@ def delete_executor_version_tag(name: str, version: int, key: str) -> ExecutorVe
     delete_tag.version()
     delete_tag.tags()
     executor = send_graphql_request(op=op)
-    return ExecutorVersion(executor)
+    return ExecutorVersionInfo(executor)
 
 
-def get_executor_version(name: str, version: Optional[int] = None) -> ExecutorVersion:
+def get_executor_version(name: str, version: Optional[int] = None) -> ExecutorVersionInfo:
     """
     Meta information about the executor version by the executor name and version.
 
@@ -579,7 +579,7 @@ def get_executor_version(name: str, version: Optional[int] = None) -> ExecutorVe
 
     Returns
     -------
-    ExecutorVersion
+    ExecutorVersionInfo
         ExecutorVersion instance with meta information.
     """
     op = Operation(schema.Query)
@@ -641,3 +641,45 @@ def get_executor_version_requirements(name: str, version: int) -> list:
     base_query.list_requirements()
     model_version = send_graphql_request(op, json_response=False)
     return model_version.executor_version_from_name_version.list_requirements
+
+
+def get_latest_executor_version(name) -> ExecutorVersionInfo:
+    """
+    Latest executor version by the executor name.
+
+    Parameters
+    ----------
+    name: str
+        Name of the executor.
+
+    Returns
+    -------
+    ExecutorVersionInfo
+        ExecutorVersion instance with meta information.
+    """
+    return get_executor_version(name)
+
+
+def get_initial_executor_version(name) -> ExecutorVersionInfo:
+    """
+    Initial executor version by the executor name.
+
+    Parameters
+    ----------
+    name: str
+        Name of the executor.
+
+    Returns
+    -------
+    ExecutorVersionInfo
+        ExecutorVersion instance with meta information.
+    """
+    op = Operation(schema.Query)
+    version = op.executor_from_name(name=name).init_executor_version()
+    version.name()
+    version.version()
+    version.tags()
+    version.description()
+    version.run.run_id()
+    executor_version = send_graphql_request(op, json_response=False)
+    return executor_version.executor_version_from_name_version

{ml-management-0.4.1 → ml-management-0.5.1rc0}/ML_management/sdk/job.py

@@ -16,7 +16,7 @@ from ML_management.mlmanagement.session import AuthSession
 from ML_management.mlmanagement.variables import get_server_websocket_url
 from ML_management.sdk import schema
 from ML_management.sdk.model import get_latest_model_version
-from ML_management.sdk.parameters import ArbitraryDatasetLoaders, ArbitraryModels, SingleDatasetLoader, SingleModel
+from ML_management.sdk.parameters import AnyDatasetLoaderForm, AnyModelForm, DatasetLoaderForm, ModelForm
 from ML_management.sdk.schema import ExecutionJob, Param
 from ML_management.sdk.sdk import send_graphql_request
 
@@ -334,8 +334,8 @@ def _get_logs_url(params: Dict[str, Any], job_type: JobType, stream: bool = True
 def add_ml_job(
     job_executor_name: str,
     executor_params: dict,
-    models_pattern: Union[SingleModel, ArbitraryModels],
-    data_pattern: Union[SingleDatasetLoader, ArbitraryDatasetLoaders],
+    models_pattern: Union[ModelForm, AnyModelForm],
+    data_pattern: Union[DatasetLoaderForm, AnyDatasetLoaderForm],
     gpu: bool = False,
     job_executor_version: Optional[int] = None,
     experiment_name: str = "Default",
@@ -361,9 +361,9 @@ def add_ml_job(
                 ...
             }
 
-    models_pattern: Union[SingleModel, ArbitraryModels]
+    models_pattern: Union[ModelForm, AnyModelForm]
         Necessary information for using the models.
-    data_pattern: Union[SingleDatasetLoader, ArbitraryDatasetLoaders]
+    data_pattern: Union[DatasetLoaderForm, AnyDatasetLoaderForm]
         Necessary information for using the datasets.
     gpu: bool = False
         Whether to use GPU for this job or not. Default: False
@@ -383,9 +383,9 @@ def add_ml_job(
     str
         Name of the Job.
     """
-    if not isinstance(models_pattern, SingleModel) and not isinstance(models_pattern, ArbitraryModels):
+    if not isinstance(models_pattern, ModelForm) and not isinstance(models_pattern, AnyModelForm):
         raise TypeError("Parameter models must have type SingleModel or ArbitraryModels.")
-    if not isinstance(data_pattern, SingleDatasetLoader) and not isinstance(data_pattern, ArbitraryDatasetLoaders):
+    if not isinstance(data_pattern, DatasetLoaderForm) and not isinstance(data_pattern, AnyDatasetLoaderForm):
         raise TypeError("Parameter data_pattern must have type SingleDatasetLoader or ArbitraryDatasetLoaders.")
     models = models_pattern.serialize()
     data_params = data_pattern.serialize()