developer-guide.md

Table of Contents

• Table of Contents
• Developer Guide
  • Requirements
  • Build from source code
  • Workflow design
  • Implement a new algorithm and use it in Katib
  • Create a new Trial kind
  • Algorithm settings 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 buildv1alpha3

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

make deployv1alpha3

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

make undeployv1alpha3

Workflow design

Please see workflow-design.md

Implement a new algorithm and use it in Katib

Please see new-algorithm-service.md

Create a new Trial kind

Please see new-trial-kind.md

Algorithm settings documentation

Please see algorithm-settings.md

Katib UI documentation

Please see Katib UI README

Design proposals

Please see proposals