developer-guide.md

Table of Contents

• Table of Contents
• Developer Guide
  • Requirements
  • Build from source code
  • Modify controller APIs
  • Workflow design
  • Implement a new algorithm and use it in Katib
  • Algorithm settings documentation
  • Katib UI documentation
  • Design proposals

Created by gh-md-toc

Developer Guide

This developer guide is for people who want to contribute to the Katib project. If you're interesting in using Katib in your machine learning project, see the following user guides:

• Concepts in Katib, hyperparameter tuning, and neural architecture search.
• Getting started with Katib.
• Detailed guide to configuring and running a Katib experiment.

Requirements

• Go
• Dep
• Docker (17.05 or later.)

Build from source code

Check source code as follows:

make build REGISTRY=<image-registry> TAG=<image-tag>

You can deploy Katib v1beta1 manifests into a k8s cluster as follows:

make deploy

You can undeploy Katib v1beta1 manifests from a k8s cluster as follows:

make undeploy

Modify controller APIs

If you want to modify Katib controller APIs you have to generate deepcopy, clientset, listers, informers, open-api and python SDK with changed APIs. You can update necessary files as follows:

make generate

Workflow design

Please see workflow-design.md.

Implement a new algorithm and use it in Katib

Please see new-algorithm-service.md.

Algorithm settings documentation

Please see algorithm-settings.md.

Katib UI documentation

Please see Katib UI README.

Design proposals

Please see proposals.