README.md

Kubeflow Katib SDK

Python SDK for Kubeflow Katib

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

pip install kubeflow-katib

Then import package:

from kubeflow import katib

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Getting Started

Please follow the samples to create, update, delete and get hyperparamaters of Katib Experiment.

Documentation for API Endpoints

Class	Method	Description
KatibClient	create_experiment	Create Katib Experiment
KatibClient	get_experiment	Get or watch the specified Experiment or all Experiment in the namespace
KatibClient	delete_experiment	Delete specified Experiment
KatibClient	list_experiments	List all Experiments with status
KatibClient	get_experiment_status	Get Experiment status
KatibClient	is_experiment_succeeded	Check if Experiment status is Succeeded
KatibClient	list_trials	List all trials of specified Experiment
KatibClient	get_optimal_hyperparmeters	Get currentOptimalTrial with paramaterAssignments of an Experiment

Documentation For Models

• V1alpha3AlgorithmSetting
• V1alpha3AlgorithmSpec
• V1alpha3CollectorSpec
• V1alpha3EarlyStoppingSetting
• V1alpha3EarlyStoppingSpec
• V1alpha3Experiment
• V1alpha3ExperimentCondition
• V1alpha3ExperimentList
• V1alpha3ExperimentSpec
• V1alpha3ExperimentStatus
• V1alpha3FeasibleSpace
• V1alpha3FileSystemPath
• V1alpha3FilterSpec
• V1alpha3GoTemplate
• V1alpha3GraphConfig
• V1alpha3Metric
• V1alpha3MetricsCollectorSpec
• V1alpha3NasConfig
• V1alpha3ObjectiveSpec
• V1alpha3Observation
• V1alpha3Operation
• V1alpha3OptimalTrial
• V1alpha3ParameterAssignment
• V1alpha3ParameterSpec
• V1alpha3SourceSpec
• V1alpha3Suggestion
• V1alpha3SuggestionCondition
• V1alpha3SuggestionList
• V1alpha3SuggestionSpec
• V1alpha3SuggestionStatus
• V1alpha3TemplateSpec
• V1alpha3Trial
• V1alpha3TrialAssignment
• V1alpha3TrialCondition
• V1alpha3TrialList
• V1alpha3TrialSpec
• V1alpha3TrialStatus
• V1alpha3TrialTemplate

Documentation For Authorization

All endpoints do not require authorization.

Author

prem0912