mlops-katib 0.19.0__tar.gz

mlops_katib-0.19.0/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: mlops-katib
+Version: 0.19.0
+Summary: MLOps Katib Python SDK for APIVersion v1beta1
+Home-page: https://github.com/mlops-katib/mlops-katib
+Author: Kubeflow Authors
+Author-email: premnath.vel@gmail.com
+License: Apache License Version 2.0
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Description-Content-Type: text/plain
+Requires-Dist: certifi>=14.05.14
+Requires-Dist: six>=1.10
+Requires-Dist: setuptools>=21.0.0
+Requires-Dist: urllib3>=1.15.1
+Requires-Dist: kubernetes>=27.2.0
+Requires-Dist: grpcio>=1.64.1
+Requires-Dist: protobuf<5,>=4.21.12
+Requires-Dist: kubeflow-training==1.9.0
+Provides-Extra: huggingface
+Requires-Dist: kubeflow-training[huggingface]==1.9.0; extra == "huggingface"
+Provides-Extra: model-registry
+Requires-Dist: model-registry-client; extra == "model-registry"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
+
+MLOps Katib Python SDK for APIVersion v1beta1

mlops_katib-0.19.0/README.md

@@ -0,0 +1,125 @@
+# Kubeflow Katib SDK
+
+Python SDK for Kubeflow Katib
+
+## Requirements.
+
+Python >= 3.8
+
+Katib Python SDK follows [Python release cycle](https://devguide.python.org/versions/#python-release-cycle)
+for supported Python versions.
+
+## Installation & Usage
+
+### pip install
+
+```sh
+pip install kubeflow-katib
+```
+
+Then import package:
+
+```python
+from kubeflow import katib
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+
+(or `sudo python setup.py install` to install the package for all users)
+
+### Publish new SDK version to PyPi
+
+Our SDK is located in [`kubeflow-katib` PyPi package](https://pypi.org/project/kubeflow-katib/).
+Katib Python SDK is published as part of the Katib patch releases.
+You can check the release process [here](../../../scripts/v1beta1/release.sh).
+For each Katib patch release, we upload a new SDK version to the PyPi.
+The SDK version is equal to the Katib version.
+
+## Getting Started
+
+Please follow the [examples](../../../examples/v1beta1/sdk) to learn more about Katib SDK.
+
+## Documentation for API Endpoints
+
+| Class                 | Method                                 | Description                                                 |
+| --------------------- | -------------------------------------- | ----------------------------------------------------------- |
+| [KatibClient][client] | [create_experiment][create]            | Create the Katib Experiment                                 |
+| [KatibClient][client] | [get_experiment][get_e]                | Get the Katib Experiment                                    |
+| [KatibClient][client] | [get_suggestion][get_s]                | Get the Katib Suggestion                                    |
+| [KatibClient][client] | [delete_experiment][delete]            | Delete the Katib Experiment                                 |
+| [KatibClient][client] | [list_experiments][list_e]             | List all Katib Experiments                                  |
+| [KatibClient][client] | [get_experiment_status][get_status]    | Get the Experiment current status                           |
+| [KatibClient][client] | [is_experiment_succeeded][is_suc]      | Check if Experiment has succeeded                           |
+| [KatibClient][client] | [list_trials][list_t]                  | List all Experiment's Trials                                |
+| [KatibClient][client] | [get_success_trial_details][get_suc_t] | Get the Trial details that have succeeded for an Experiment |
+| [KatibClient][client] | [get_optimal_hyperparameters][opt_hp]  | Get the current optimal Trial from the Experiment           |
+
+[client]: docs/KatibClient.md
+[create]: docs/KatibClient.md#create_experiment
+[get_e]: docs/KatibClient.md#get_experiment
+[get_s]: docs/KatibClient.md#get_suggestion
+[delete]: docs/KatibClient.md#delete_experiment
+[list_e]: docs/KatibClient.md#list_experiments
+[get_status]: docs/KatibClient.md#get_experiment_status
+[is_suc]: docs/KatibClient.md#is_experiment_succeeded
+[list_t]: docs/KatibClient.md#list_trials
+[get_suc_t]: docs/KatibClient.md#get_success_trial_details
+[opt_hp]: docs/KatibClient.md#get_optimal_hyperparameters
+
+## Documentation For Models
+
+- [V1beta1AlgorithmSetting](docs/V1beta1AlgorithmSetting.md)
+- [V1beta1AlgorithmSpec](docs/V1beta1AlgorithmSpec.md)
+- [V1beta1CollectorSpec](docs/V1beta1CollectorSpec.md)
+- [V1beta1ConfigMapSource](docs/V1beta1ConfigMapSource.md)
+- [V1beta1EarlyStoppingRule](docs/V1beta1EarlyStoppingRule.md)
+- [V1beta1EarlyStoppingSetting](docs/V1beta1EarlyStoppingSetting.md)
+- [V1beta1EarlyStoppingSpec](docs/V1beta1EarlyStoppingSpec.md)
+- [V1beta1Experiment](docs/V1beta1Experiment.md)
+- [V1beta1ExperimentCondition](docs/V1beta1ExperimentCondition.md)
+- [V1beta1ExperimentList](docs/V1beta1ExperimentList.md)
+- [V1beta1ExperimentSpec](docs/V1beta1ExperimentSpec.md)
+- [V1beta1ExperimentStatus](docs/V1beta1ExperimentStatus.md)
+- [V1beta1FeasibleSpace](docs/V1beta1FeasibleSpace.md)
+- [V1beta1FileSystemPath](docs/V1beta1FileSystemPath.md)
+- [V1beta1FilterSpec](docs/V1beta1FilterSpec.md)
+- [V1beta1GraphConfig](docs/V1beta1GraphConfig.md)
+- [V1beta1Metric](docs/V1beta1Metric.md)
+- [V1beta1MetricStrategy](docs/V1beta1MetricStrategy.md)
+- [V1beta1MetricsCollectorSpec](docs/V1beta1MetricsCollectorSpec.md)
+- [V1beta1NasConfig](docs/V1beta1NasConfig.md)
+- [V1beta1ObjectiveSpec](docs/V1beta1ObjectiveSpec.md)
+- [V1beta1Observation](docs/V1beta1Observation.md)
+- [V1beta1Operation](docs/V1beta1Operation.md)
+- [V1beta1OptimalTrial](docs/V1beta1OptimalTrial.md)
+- [V1beta1ParameterAssignment](docs/V1beta1ParameterAssignment.md)
+- [V1beta1ParameterSpec](docs/V1beta1ParameterSpec.md)
+- [V1beta1SourceSpec](docs/V1beta1SourceSpec.md)
+- [V1beta1Suggestion](docs/V1beta1Suggestion.md)
+- [V1beta1SuggestionCondition](docs/V1beta1SuggestionCondition.md)
+- [V1beta1SuggestionList](docs/V1beta1SuggestionList.md)
+- [V1beta1SuggestionSpec](docs/V1beta1SuggestionSpec.md)
+- [V1beta1SuggestionStatus](docs/V1beta1SuggestionStatus.md)
+- [V1beta1Trial](docs/V1beta1Trial.md)
+- [V1beta1TrialAssignment](docs/V1beta1TrialAssignment.md)
+- [V1beta1TrialCondition](docs/V1beta1TrialCondition.md)
+- [V1beta1TrialList](docs/V1beta1TrialList.md)
+- [V1beta1TrialParameterSpec](docs/V1beta1TrialParameterSpec.md)
+- [V1beta1TrialSource](docs/V1beta1TrialSource.md)
+- [V1beta1TrialSpec](docs/V1beta1TrialSpec.md)
+- [V1beta1TrialStatus](docs/V1beta1TrialStatus.md)
+- [V1beta1TrialTemplate](docs/V1beta1TrialTemplate.md)
+
+## Documentation For Authorization
+
+All endpoints do not require authorization.
+
+## Author
+
+prem0912

mlops_katib-0.19.0/kubeflow/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)

mlops_katib-0.19.0/kubeflow/katib/__init__.py

@@ -0,0 +1,85 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Katib
+
+    Swagger description for Katib  # noqa: E501
+
+    The version of the OpenAPI document: v1beta1-0.1
+    Generated by: https://openapi-generator.tech
+"""
+
+
+from __future__ import absolute_import
+
+__version__ = "0.1"
+
+# import apis into sdk package
+
+# import ApiClient
+from kubeflow.katib.api_client import ApiClient
+from kubeflow.katib.configuration import Configuration
+from kubeflow.katib.exceptions import OpenApiException
+from kubeflow.katib.exceptions import ApiTypeError
+from kubeflow.katib.exceptions import ApiValueError
+from kubeflow.katib.exceptions import ApiKeyError
+from kubeflow.katib.exceptions import ApiException
+# import models into sdk package
+from kubeflow.katib.models.v1beta1_algorithm_setting import V1beta1AlgorithmSetting
+from kubeflow.katib.models.v1beta1_algorithm_spec import V1beta1AlgorithmSpec
+from kubeflow.katib.models.v1beta1_collector_spec import V1beta1CollectorSpec
+from kubeflow.katib.models.v1beta1_config_map_source import V1beta1ConfigMapSource
+from kubeflow.katib.models.v1beta1_early_stopping_rule import V1beta1EarlyStoppingRule
+from kubeflow.katib.models.v1beta1_early_stopping_setting import V1beta1EarlyStoppingSetting
+from kubeflow.katib.models.v1beta1_early_stopping_spec import V1beta1EarlyStoppingSpec
+from kubeflow.katib.models.v1beta1_experiment import V1beta1Experiment
+from kubeflow.katib.models.v1beta1_experiment_condition import V1beta1ExperimentCondition
+from kubeflow.katib.models.v1beta1_experiment_list import V1beta1ExperimentList
+from kubeflow.katib.models.v1beta1_experiment_spec import V1beta1ExperimentSpec
+from kubeflow.katib.models.v1beta1_experiment_status import V1beta1ExperimentStatus
+from kubeflow.katib.models.v1beta1_feasible_space import V1beta1FeasibleSpace
+from kubeflow.katib.models.v1beta1_file_system_path import V1beta1FileSystemPath
+from kubeflow.katib.models.v1beta1_filter_spec import V1beta1FilterSpec
+from kubeflow.katib.models.v1beta1_graph_config import V1beta1GraphConfig
+from kubeflow.katib.models.v1beta1_metric import V1beta1Metric
+from kubeflow.katib.models.v1beta1_metric_strategy import V1beta1MetricStrategy
+from kubeflow.katib.models.v1beta1_metrics_collector_spec import V1beta1MetricsCollectorSpec
+from kubeflow.katib.models.v1beta1_nas_config import V1beta1NasConfig
+from kubeflow.katib.models.v1beta1_objective_spec import V1beta1ObjectiveSpec
+from kubeflow.katib.models.v1beta1_observation import V1beta1Observation
+from kubeflow.katib.models.v1beta1_operation import V1beta1Operation
+from kubeflow.katib.models.v1beta1_optimal_trial import V1beta1OptimalTrial
+from kubeflow.katib.models.v1beta1_parameter_assignment import V1beta1ParameterAssignment
+from kubeflow.katib.models.v1beta1_parameter_spec import V1beta1ParameterSpec
+from kubeflow.katib.models.v1beta1_source_spec import V1beta1SourceSpec
+from kubeflow.katib.models.v1beta1_suggestion import V1beta1Suggestion
+from kubeflow.katib.models.v1beta1_suggestion_condition import V1beta1SuggestionCondition
+from kubeflow.katib.models.v1beta1_suggestion_list import V1beta1SuggestionList
+from kubeflow.katib.models.v1beta1_suggestion_spec import V1beta1SuggestionSpec
+from kubeflow.katib.models.v1beta1_suggestion_status import V1beta1SuggestionStatus
+from kubeflow.katib.models.v1beta1_trial import V1beta1Trial
+from kubeflow.katib.models.v1beta1_trial_assignment import V1beta1TrialAssignment
+from kubeflow.katib.models.v1beta1_trial_condition import V1beta1TrialCondition
+from kubeflow.katib.models.v1beta1_trial_list import V1beta1TrialList
+from kubeflow.katib.models.v1beta1_trial_parameter_spec import V1beta1TrialParameterSpec
+from kubeflow.katib.models.v1beta1_trial_source import V1beta1TrialSource
+from kubeflow.katib.models.v1beta1_trial_spec import V1beta1TrialSpec
+from kubeflow.katib.models.v1beta1_trial_status import V1beta1TrialStatus
+from kubeflow.katib.models.v1beta1_trial_template import V1beta1TrialTemplate
+
+# Import Katib API client.
+from kubeflow.katib.api.katib_client import KatibClient
+from kubeflow.katib.api.katib_client import ModelRegistryArtifactType
+from kubeflow.katib.api.katib_client import ModelRegistryConfig
+# Import Katib TrainerResources class.
+from kubeflow.katib.types.types import TrainerResources
+# Import Katib report metrics functions
+from kubeflow.katib.api.report_metrics import report_metrics
+# Import Katib helper functions.
+import kubeflow.katib.api.search as search
+# Import Katib helper constants.
+from kubeflow.katib.constants.constants import BASE_IMAGE_TENSORFLOW
+from kubeflow.katib.constants.constants import BASE_IMAGE_TENSORFLOW_GPU
+from kubeflow.katib.constants.constants import BASE_IMAGE_PYTORCH

mlops_katib-0.19.0/kubeflow/katib/api/__init__.py

@@ -0,0 +1,5 @@
+from __future__ import absolute_import
+
+# flake8: noqa
+
+# import apis into api package