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.

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 broken links to kubeflow website #1477

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions docs/developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ This developer guide is for people who want to contribute to the Katib project.
If you're interesting in using Katib in your machine learning project,
see the following user guides:

- [Concepts](https://www.kubeflow.org/docs/components/hyperparameter-tuning/overview/)
- [Concepts](https://www.kubeflow.org/docs/components/katib/overview/)
in Katib, hyperparameter tuning, and neural architecture search.
- [Getting started with Katib](https://kubeflow.org/docs/components/hyperparameter-tuning/hyperparameter/).
- [Getting started with Katib](https://kubeflow.org/docs/components/katib/hyperparameter/).
- Detailed guide to [configuring and running a Katib
experiment](https://kubeflow.org/docs/components/hyperparameter-tuning/experiment/).
experiment](https://kubeflow.org/docs/components/katib/experiment/).

## Requirements

Expand Down
2 changes: 1 addition & 1 deletion examples/v1beta1/tekton/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ is completed. Metrics collector should not be stopped after training container i
To avoid this problem, set `nop` image to metrics collector sidecar image.

For example, if you are using
[StdOut](https://www.kubeflow.org/docs/components/hyperparameter-tuning/experiment/#metrics-collector) metrics collector,
[StdOut](https://www.kubeflow.org/docs/components/katib/experiment/#metrics-collector) metrics collector,
`nop` image must be equal to `docker.io/kubeflowkatib/file-metrics-collector`.

After deploying Tekton on your cluster, run bellow command to modify `nop` image:
Expand Down
4 changes: 2 additions & 2 deletions pkg/ui/v1beta1/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Katib User Interface

This is the source code for the Katib UI. Current version of Katib UI is v1beta1. On the official Kubeflow website [here](https://www.kubeflow.org/docs/components/hyperparameter-tuning/experiment/#running-the-experiment-from-the-katib-ui) you can find information how to use Katib UI.
This is the source code for the Katib UI. Current version of Katib UI is v1beta1. On the official Kubeflow website [here](https://www.kubeflow.org/docs/components/katib/experiment/#running-the-experiment-from-the-katib-ui) you can find information how to use Katib UI.
We are using [React](https://reactjs.org/) framework to create frontend and Go as a backend.

We are using [Material UI](https://material-ui.com/) to design frontend. Try to use Material UI components to implement new Katib UI features.
Expand Down Expand Up @@ -69,7 +69,7 @@ After that, you can access the UI using this URL: `http://localhost:8080/katib/`

To run Katib UI in Production, after all changes in frontend and backend, you need to create an image for the UI. Under `/katib` directory run this: `docker build . -f cmd/ui/v1beta1/Dockerfile -t <name of your image>` to build the image. If Docker resources are not enough to build the frontend, you get `node` out of memory error. You can try to increase Docker resources or modify `package.json` as detailed [above](https://github.com/kubeflow/katib/tree/master/pkg/ui/v1beta1#serve-ui-frontend-and-backend) at step 1.

After that, you can modify UI [deployment](https://github.com/kubeflow/katib/blob/master/manifests/v1beta1/components/ui/ui.yaml#L21) with your new image. Then, follow [these steps](https://www.kubeflow.org/docs/components/hyperparameter-tuning/hyperparameter/#accessing-the-katib-ui) to access Katib UI.
After that, you can modify UI [deployment](https://github.com/kubeflow/katib/blob/master/manifests/v1beta1/components/ui/ui.yaml#L21) with your new image. Then, follow [these steps](https://www.kubeflow.org/docs/components/katib/hyperparameter/#accessing-the-katib-ui) to access Katib UI.

## Code style

Expand Down
2 changes: 1 addition & 1 deletion pkg/ui/v1beta1/frontend/src/components/Menu/Main.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ const Main = props => {
<Typography variant={'h6'}>
For usage instructions, see the{' '}
<a
href="https://www.kubeflow.org/docs/components/hyperparameter-tuning/"
href="https://www.kubeflow.org/docs/components/katib/"
target="_blank"
rel="noopener noreferrer"
className={classes.link}
Expand Down