developer-guide.md

Table of Contents generated with DocToc

• Developer Guide
  • Requirements
  • Build from source code
  • Implement new suggestion algorithm

Developer Guide

Requirements

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

Build from source code

Check source code as follows:

make check

If there are some errors for go fmt, update the go fmt as follows:

make update

You can build all images from source for v1alpha2 as follows:

make images

You can deploy katib v1alpha2 manifests into a k8s cluster as follows:

make deploy

You can undeploy katib v1alpha2 manifests from a k8s cluster as follows:

make undeploy

Implement new suggestion algorithm

Suggestion API is defined as GRPC service at pkg/api/v1alpha1/api.proto. Source code is here. You can attach new algorithm easily.

• implement suggestion API
• make k8s service named vizier-suggestion-{ algorithm-name } and expose port 6789

And to add new suggestion service, you don't need to stop components ( vizier-core, modeldb, and anything) that are already running.