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

fix: Fix docs about metrics collection and suggestion design #858

Merged
merged 1 commit into from
Oct 8, 2019
Merged

fix: Fix docs about metrics collection and suggestion design #858

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Binary file removed docs/images/suggestion-workflow.png
View file
Open in desktop
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/proposals/metrics-collector.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@ For more detail, see [here](https://github.com/kubeflow/katib/pull/697#issuecomm
To avoid collecting duplicated metrics, as we discuss in [kubeflow/katib#685](https://github.com/kubeflow/katib/issues/685), only one metrics collector sidecar will be injected into the master pod during one Experiment.
In the new design, there are two modes for katib mutating webhook to inject the sidecar: **Pod Level Injecting** and **Job Level Injecting**.

The webhook decides which mode to be used based on the `katib-metrics-collector-injection=enabled` label tagged on the namespace.
In the namespace with `katib-metrics-collector-injection=enabled` label, the webhook inject the sidecar in the pod level. Otherwise, without this label, injecting in the job level.
The webhook decides which mode to be used based on the `katib-metricscollector-injection=enabled` label tagged on the namespace.
In the namespace with `katib-metricscollector-injection=enabled` label, the webhook inject the sidecar in the pod level. Otherwise, without this label, injecting in the job level.

In **Pod Level Injecting**,

Expand Down
2 changes: 1 addition & 1 deletion docs/proposals/suggestion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ message Metric {

### Workflow

![](../images/suggestion-workflow.png)
![](../images/katib-workflow.png)

When the user creates a Experiment, we will create a Suggestion for the Experiment. When the Experiment needs some suggestions, Experiment controller updates the `Suggestions`, then Suggestion controller communicates with the Suggestion to get parameter assignments and set them in Suggestion status.

Expand Down