Skip to content

Latest commit

 

History

History
 
 

v1beta1

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

Kubeflow Katib SDK

Python SDK for Kubeflow Katib

Requirements.

Python >= 3.8

Katib Python SDK follows Python release cycle for supported Python versions.

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)

Publish new SDK version to PyPi

Our SDK is located in kubeflow-katib PyPi package. Katib Python SDK is published as part of the Katib patch releases. You can check the release process here. 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 to learn more about Katib SDK.

Documentation for API Endpoints

Class Method Description
KatibClient create_experiment Create the Katib Experiment
KatibClient get_experiment Get the Katib Experiment
KatibClient get_suggestion Get the Katib Suggestion
KatibClient delete_experiment Delete the Katib Experiment
KatibClient list_experiments List all Katib Experiments
KatibClient get_experiment_status Get the Experiment current status
KatibClient is_experiment_succeeded Check if Experiment has succeeded
KatibClient list_trials List all Experiment's Trials
KatibClient get_success_trial_details Get the Trial details that have succeeded for an Experiment
KatibClient get_optimal_hyperparameters Get the current optimal Trial from the Experiment

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

prem0912