From 7ec0cd4ca72abcd51f48a9d778b6e03cd1856876 Mon Sep 17 00:00:00 2001 From: avelichk Date: Fri, 19 Feb 2021 21:50:07 +0000 Subject: [PATCH 1/4] Init commit --- scripts/update-readme-toc.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/update-readme-toc.sh b/scripts/update-readme-toc.sh index f33f0997a38..1cbaaa48233 100755 --- a/scripts/update-readme-toc.sh +++ b/scripts/update-readme-toc.sh @@ -3,5 +3,5 @@ SCRIPT_ROOT=$(dirname ${BASH_SOURCE})/.. cd ${SCRIPT_ROOT} -doctoc --github ./README.md --title "**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*" -cd - > /dev/null +doctoc --github ./README.md --title "# Table of Contents" +cd - >/dev/null From 60bf17886d238a56a8eda5fb3c8559c08d00b2d2 Mon Sep 17 00:00:00 2001 From: avelichk Date: Mon, 22 Feb 2021 20:52:01 +0000 Subject: [PATCH 2/4] Add presentations list Update README with community info --- README.md | 29 +++++++++++++++++++++++------ docs/presentations.md | 16 ++++++++++++++++ 2 files changed, 39 insertions(+), 6 deletions(-) create mode 100644 docs/presentations.md diff --git a/README.md b/README.md index 77fa4881ecc..48aaf1be1b4 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Katib is a Kubernetes-native project for automated machine learning (AutoML). Katib supports [Hyperparameter Tuning](https://en.wikipedia.org/wiki/Hyperparameter_optimization), [Early Stopping](https://en.wikipedia.org/wiki/Early_stopping) and -[Neural Architecture Search](https://en.wikipedia.org/wiki/Neural_architecture_search) +[Neural Architecture Search](https://en.wikipedia.org/wiki/Neural_architecture_search). Katib is the project which is agnostic to machine learning (ML) frameworks. It can tune hyperparameters of applications written in any language of the @@ -46,8 +46,8 @@ MXNet, PyTorch, XGBoost, and others. - [Katib SDK](#katib-sdk) - [Cleanups](#cleanups) - [Quick Start](#quick-start) -- [Who are using Katib?](#who-are-using-katib) -- [CONTRIBUTING](#contributing) +- [Community](#community) +- [Contributing](#contributing) - [Citation](#citation) @@ -307,11 +307,28 @@ Please follow the [Kubeflow documentation](https://www.kubeflow.org/docs/components/katib/hyperparameter/#examples) to submit your first Katib experiment. -## Who are using Katib? +## Community -Please see [ADOPTERS.md](ADOPTERS.md). +We are always growing our community and invite new users and AutoML enthusiasts +to contribute to the Katib project. The following links provides information +about getting involved in the community: -## CONTRIBUTING +- If you use Katib, please update [the adopters list](ADOPTERS.md). + +- Subscribe + [to the calendar](https://calendar.google.com/calendar/u/0/r?cid=ZDQ5bnNpZWZzbmZna2Y5MW8wdThoMmpoazRAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ) + to attend the AutoML WG community meeting. + +- Check + [the AutoML WG meeting notes](https://docs.google.com/document/d/1MChKfzrKAeFRtYqypFbMXL6ZIc_OgijjkvbqmwRV-64/edit). + +- Join + [the AutoML WG Slack channel](https://kubeflow.slack.com/archives/C018PMV53NW). + +- Learn more about Katib in + [the presentations and demos list](./docs/presentations.md). + +## Contributing Please feel free to test the system! [developer-guide.md](./docs/developer-guide.md) is a good starting point diff --git a/docs/presentations.md b/docs/presentations.md new file mode 100644 index 00000000000..454e03272f0 --- /dev/null +++ b/docs/presentations.md @@ -0,0 +1,16 @@ +# Katib Presentations and Demos + +Bellow are the list of Katib presentations and demos. If you want to add your +presentation or demo in this list please send a pull request. Please keep the +list in reverse chronological order. + +| Presentation or Demo title | Presenters | Date | +| --- | --- | --- | +| [KF Community: New Kubeflow components UI](https://youtu.be/OKqx3IS2_G4) | Stefano Fioravanzo | 2020-12-08 | +| [KF Community: Using Pipelines in Katib](https://youtu.be/BszcHMkGLgc) | Andrey Velichkevich | 2020-11-10 | +| [KubeCon 2020: From Notebook to Kubeflow Pipelines with HP Tuning](https://youtu.be/QK0NxhyADpM) | Stefano Fioravanzo, Ilias Katsakioris | 2020-09-04 | +| [Kubeflow Dojo: Distributed Training and HPO Deep Dive](https://youtu.be/KJFOlhD3L1E) | Andrew Butler, Qianyang Yu, Tommy Li, Animesh Singh | 2020-07-17 | +| [Kubeflow 101: Hyperparameter Tuning with Katib](https://youtu.be/1PKH_D6zjoM) | Stephanie Wong | 2020-06-21 | +| [KubeCon 2019: Hyperparameter Tuning Using Kubeflow](https://youtu.be/OkAoiA6A2Ac) | Richard Liu, Johnu George | 2019-07-05 | +| [KF Community: Kubeflow Katib & Hyperparameter Tuning](https://youtu.be/1PKH_D6zjoM) | Richard Liu | 2019-03-29 | +| [KF Community: Neural Architecture Search System on Kubeflow](https://youtu.be/WAK37UW7spo) | Andrey Velichkevich, Kirill Prosvirov, Jinan Zhou, Anubhav Garg | 2019-03-26 | From 80a251afb54e4905ae0ccbfa3aebbd56f023d1b2 Mon Sep 17 00:00:00 2001 From: avelichk Date: Mon, 22 Feb 2021 21:21:06 +0000 Subject: [PATCH 3/4] Fix --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 48aaf1be1b4..e746a3a7571 100644 --- a/README.md +++ b/README.md @@ -310,7 +310,7 @@ to submit your first Katib experiment. ## Community We are always growing our community and invite new users and AutoML enthusiasts -to contribute to the Katib project. The following links provides information +to contribute to the Katib project. The following links provide information about getting involved in the community: - If you use Katib, please update [the adopters list](ADOPTERS.md). From 2a7636cbf30132e23747b698f7aebf49e33cb316 Mon Sep 17 00:00:00 2001 From: avelichk Date: Mon, 22 Feb 2021 21:28:07 +0000 Subject: [PATCH 4/4] Fix presentation link --- docs/presentations.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/presentations.md b/docs/presentations.md index 454e03272f0..e836ffd42fd 100644 --- a/docs/presentations.md +++ b/docs/presentations.md @@ -6,11 +6,11 @@ list in reverse chronological order. | Presentation or Demo title | Presenters | Date | | --- | --- | --- | -| [KF Community: New Kubeflow components UI](https://youtu.be/OKqx3IS2_G4) | Stefano Fioravanzo | 2020-12-08 | +| [KF Community: New UI for Kubeflow components](https://youtu.be/OKqx3IS2_G4) | Stefano Fioravanzo | 2020-12-08 | | [KF Community: Using Pipelines in Katib](https://youtu.be/BszcHMkGLgc) | Andrey Velichkevich | 2020-11-10 | | [KubeCon 2020: From Notebook to Kubeflow Pipelines with HP Tuning](https://youtu.be/QK0NxhyADpM) | Stefano Fioravanzo, Ilias Katsakioris | 2020-09-04 | | [Kubeflow Dojo: Distributed Training and HPO Deep Dive](https://youtu.be/KJFOlhD3L1E) | Andrew Butler, Qianyang Yu, Tommy Li, Animesh Singh | 2020-07-17 | -| [Kubeflow 101: Hyperparameter Tuning with Katib](https://youtu.be/1PKH_D6zjoM) | Stephanie Wong | 2020-06-21 | +| [Kubeflow 101: Hyperparameter Tuning with Katib](https://youtu.be/nIKVlosDvrc) | Stephanie Wong | 2020-06-21 | | [KubeCon 2019: Hyperparameter Tuning Using Kubeflow](https://youtu.be/OkAoiA6A2Ac) | Richard Liu, Johnu George | 2019-07-05 | | [KF Community: Kubeflow Katib & Hyperparameter Tuning](https://youtu.be/1PKH_D6zjoM) | Richard Liu | 2019-03-29 | | [KF Community: Neural Architecture Search System on Kubeflow](https://youtu.be/WAK37UW7spo) | Andrey Velichkevich, Kirill Prosvirov, Jinan Zhou, Anubhav Garg | 2019-03-26 |