Revision 1f74dc103a537405a3b2a2eb1d9bb472f3a830f5 authored by Johnu George on 31 March 2019, 06:45:24 UTC, committed by Johnu George on 31 March 2019, 06:45:24 UTC
1 parent abedddc
developer-guide.md
# Developer Guide
## Requirements
- [Go](https://golang.org/)
- [Dep](https://golang.github.io/dep/)
- [Docker](https://docs.docker.com/) (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 `pkg/api/api.proto`. Source code is [here](https://github.com/kubeflow/katib/blob/master/pkg/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.
Computing file changes ...