mirror of
https://github.com/hanzo-ml/katib.git
synced 2026-09-24 00:31:27 +00:00
Andrey VelichkevichandGitHub
2992c5706f
* Upload 0.0.4 SDK version * Fix doc links * Fix links in README * Modify tables * Fix link * Remove * Modify client and gen script * Update version to 0.0.5 * Run CI * Add Katib client to init
5.2 KiB
5.2 KiB
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)
Upload new version to PyPi
Our SDK is located in kubeflow-katib PyPi package.
If you want to release new SDK version with updated API you have to ask anyone from
OWNERS file to follow these steps:
-
Update version in
setup.py -
Generate distributive packages:
python3 setup.py sdist bdist_wheel -
Upload package to PyPi:
twine upload dist/*
Getting Started
Please follow the examples to learn more about Katib SDK.
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_hyperparameters | Get currentOptimalTrial with parameterAssignments of an Experiment |
Documentation For Models
- V1beta1AlgorithmSetting
- V1beta1AlgorithmSpec
- V1beta1CollectorSpec
- V1beta1ConfigMapSource
- V1beta1EarlyStoppingSetting
- V1beta1EarlyStoppingSpec
- V1beta1Experiment
- V1beta1ExperimentCondition
- V1beta1ExperimentList
- V1beta1ExperimentSpec
- V1beta1ExperimentStatus
- V1beta1FeasibleSpace
- V1beta1FileSystemPath
- V1beta1FilterSpec
- V1beta1GraphConfig
- V1beta1Metric
- V1beta1MetricStrategy
- V1beta1MetricsCollectorSpec
- V1beta1NasConfig
- V1beta1ObjectiveSpec
- V1beta1Observation
- V1beta1Operation
- V1beta1OptimalTrial
- V1beta1ParameterAssignment
- V1beta1ParameterSpec
- V1beta1SourceSpec
- V1beta1Suggestion
- V1beta1SuggestionCondition
- V1beta1SuggestionList
- V1beta1SuggestionSpec
- V1beta1SuggestionStatus
- V1beta1Trial
- V1beta1TrialAssignment
- V1beta1TrialCondition
- V1beta1TrialList
- V1beta1TrialParameterSpec
- V1beta1TrialSource
- V1beta1TrialSpec
- V1beta1TrialStatus
- V1beta1TrialTemplate
Documentation For Authorization
All endpoints do not require authorization.
Author
prem0912