Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add api doc #303

Merged
merged 4 commits into from
Dec 25, 2018
+5,512 −751
Merged

Add api doc #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8cc162e
add api doc
YujiOshima Dec 19, 2018
835e7af
fix typo
YujiOshima Dec 21, 2018
c652502
add instructions for update api files and docs
YujiOshima Dec 21, 2018
682520d
fix typo
YujiOshima Dec 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@ Katib provides a Web UI.
You can visualize general trend of Hyper parameter space and each training history.
![katibui](https://user-images.githubusercontent.com/10014831/48778081-a4388b80-ed17-11e8-938b-fc59a5d2e574.gif)

## CLI Documentation
## API Documentation

Please refer to [katib-cli.md](./docs/CLI/katib-cli.md).
Please refer to [api.md](./pkg/api/gen-doc/api.md).

## CONTRIBUTING

Expand Down
13 changes: 13 additions & 0 deletions pkg/api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Katib API
This is APIs for Katib.
Manager service is an API for core component.
Suggestion service is an API for Suggestion services.
EarlyStopping service is an API for EarlyStopping services.

## Documentation
Please refer to [api.md](./gen-doc/api.md).

## Update API and generate documents
When you want to edit API, please only edit [api.proto](./api.proto) and generate other file from it.
Documents are also generated from [api.proto](./api.proto) by [protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc).
By [build.sh](./build.sh), you can update every file from api.proto and generate docs.
Loading