https://github.com/kubeflow/katib
Raw File
Tip revision: 8cc162e593c41df13c6e8824cce95c612c6a90fc authored by YujiOshima on 19 December 2018, 01:34:46 UTC
add api doc
Tip revision: 8cc162e
developer-guide.md
# Developer Guide

## Requirements

- Docker (17.05 or later.)

## Build from source code

Pull in the dependencies

```
dep ensure --vendor-only
```

You can build all images from source.

```bash
./scripts/build.sh
```

## Implement new suggestion algorithm

Suggestion API is defined as GRPC service at `API/api.proto`.
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.
back to top