restructure `About` section (#3007)

* restructure `About` section

* restructure `About` section

* rename "Kubeflow Overview" to "Architecture"

* rename "Kubeflow Overview" to "Architecture"

* rename "Kubeflow Overview" to "Architecture"

* reword minikf slack link
This commit is contained in:
Mathew Wicks 2021-11-29 13:47:02 +11:00 committed by GitHub
parent cd8142a921
commit 6c527dd09a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
21 changed files with 342 additions and 730 deletions

View File

@ -218,35 +218,29 @@ no = 'Sorry to hear that. Please <a href="https://github.com/kubeflow/website/is
[params.links]
# Docsy: "User" links will show on left side of footer and in the community page if you have one.
[[params.links.user]]
name ="Twitter"
url = "https://twitter.com/kubeflow"
name = "Twitter"
url = "https://twitter.com/kubeflow/"
icon = "fab fa-twitter"
desc = "Follow us on Twitter to get the latest news"
[[params.links.user]]
name = "GitHub"
url = "https://github.com/kubeflow/kubeflow"
icon = "fab fa-github"
desc = "Development takes place here!"
desc = "Follow us on Twitter to get the latest news!"
[[params.links.user]]
name = "Slack"
url = "https://kubeflow.slack.com/join/shared_invite/zt-cpr020z4-PfcAue_2nw67~iIDy7maAQ"
url = "/docs/about/community/#slack"
icon = "fab fa-slack"
desc = "Chat with other project contributors"
desc = "Join the Kubeflow Slack Workspace!"
[[params.links.user]]
name = "Mailing list"
url = "https://groups.google.com/forum/#!forum/kubeflow-discuss"
url = "/docs/about/community/#mailing-list"
icon = "fa fa-envelope"
desc = "Discussion and help from your fellow users"
desc = "Join the Kubeflow Mailing List!"
[[params.links.user]]
name = "Calendar"
url = "https://calendar.google.com/calendar/embed?src=kubeflow.org_7l5vnbn8suj2se10sen81d9428%40group.calendar.google.com&ctz=America%2FLos_Angeles"
name = "Weekly Community Call"
url = "/docs/about/community/#weekly-community-call"
icon = "fa fa-calendar"
desc = "Discussion and help from your fellow users"
desc = "Join the weekly Kubeflow Community Call!"
# Docsy: "Developer" links will show on right side of footer and in the community page if you have one.
#[[params.links.developer]]
# name = "A name"
# url = "http://example.com"
# icon = "fab fa-envelope"
# desc = "A description"
# desc = "A description"

View File

@ -8,7 +8,7 @@ title = "Kubeflow"
<p class="lead mt-5">The Machine Learning Toolkit for Kubernetes</p>
<a
class="btn btn-lg btn-primary mr-3 mb-4"
href="/docs/started/installing-kubeflow/"
href="/docs/started/"
>
Get Started <i class="fas fa-arrow-alt-circle-right ml-2"></i>
</a>
@ -155,10 +155,8 @@ title = "Kubeflow"
<div class=" card-body bg-primary-dark">
<h5 class="card-title text-white section-head">Community</h5>
<p class="card-text text-white">
We are an open and welcoming community of software developers, data
scientists, and organizations! Join our <a target="_blank" rel="noopener"
href="https://kubeflow.slack.com/join/shared_invite/zt-cpr020z4-PfcAue_2nw67~iIDy7maAQ">Slack workspace</a>
for help with any issues you may face, and read <a target="_blank" rel="noopener" href="/docs/about/community/">more about the community</a>.
We are an open and welcoming community of software developers, data scientists, and organizations!
Join our <a target="_blank" rel="noopener" href="/docs/about/community/#slack">Slack Workspace</a>!
</p>
</div>
</div>
@ -173,7 +171,7 @@ title = "Kubeflow"
<div class="contain">
<h4 class="section-head">Join our community</h4>
<p>
Want to contribute to Kubeflow? <a href="/docs/about/community/">Join our community</a>! Check out upcoming meetings, get involved in discussions on our mailing list or on Slack, and suggest exciting new integrations.
Check out the <a href="/docs/about/community/#weekly-community-call">weekly community call</a>, get involved in discussions on the <a href="/docs/about/community/#mailing-list">mailing list</a> or chat with others on the <a href="/docs/about/community/#slack">Slack Workspace</a>!
</p>
<a

View File

@ -177,6 +177,10 @@ docs/started/requirements/ /docs/started/getting-started/
/docs/components/pipelines/overview/concepts/* /docs/components/pipelines/concepts/:splat
/docs/components/pipelines/sdk/v2/* /docs/components/pipelines/sdk-v2/:splat
# Restructure About section
/docs/about/kubeflow /docs/started/introduction
/docs/started/kubeflow-overview /docs/started/architecture
# ===============
# IMPORTANT NOTE:
# Catch-all redirects should be added at the end of this file as redirects happen from top to bottom

View File

@ -1,5 +1,5 @@
+++
title = "About"
description = "Information about Kubeflow software, community, docs, and events."
description = "About Kubeflow and its community"
weight = 10
+++

View File

@ -1,101 +1,210 @@
+++
title = "Community"
title = "Community"
description = "About the Kubeflow community"
weight = 4
weight = 10
aliases = ["/docs/community/"]
+++
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of
experience, education, socio-economic status, nationality, personal appearance,
race, religion, or sexual identity and orientation.
## Slack
The Kubeflow community is guided by our [Code of
Conduct](https://github.com/kubeflow/community/blob/master/CODE_OF_CONDUCT.md),
which we encourage everybody to read before participating. We hold our leaders
accountable for the guidelines in
[this document](https://github.com/kubeflow/community/blob/master/INCLUSIVITY.md).
Join the official Kubeflow Slack with [this invite link](https://join.slack.com/t/kubeflow/shared_invite/zt-n73pfj05-l206djXlXk5qdQKs4o1Zkg).
## Welcome to all Google Summer of Code (GSoC) participants
{{% alert title="Tip" color="info" %}}
If the above invite has expired, please [raise an issue on the `kubeflow/website` repo](https://github.com/kubeflow/website/issues/new).
{{% /alert %}}
The Kubeflow community is delighted to be part of
**Google Summer of Code 2020**. Community
mentors look forward to working with students on their GSoC projects.
The Kubeflow Slack workspace has many channels, here are a few examples:
[Visit the Kubeflow GSoC page](/docs/about/gsoc/) to find handy information and
links for GSoC students and mentors.
| Topic | Slack Channel |
| --- | --- |
| General Discussion | [#general](https://kubeflow.slack.com/archives/C7REE0ETX)
| Feature Requests | [#feature-requests](https://kubeflow.slack.com/archives/C01A7RYEYMB)
| Job Postings | [#job-postings](https://kubeflow.slack.com/archives/CJ9PJE5FS)
| Kubeflow - Pipelines | [#kubeflow-pipelines](https://kubeflow.slack.com/archives/CE10KS9M4)
| Kubeflow - Notebooks | [#kubeflow-notebooks](https://kubeflow.slack.com/archives/CESP7FCQ7)
| Kubeflow - KFServing | [#kubeflow-kfserving](https://kubeflow.slack.com/archives/CH6E58LNP)
| Platform - AWS | [#platform-aws](https://kubeflow.slack.com/archives/CKBA5D0MU)
| Platform - Azure | [#platform-azure](https://kubeflow.slack.com/archives/CUW6SLCPR)
| Platform - GCP | [#platform-gcp](https://kubeflow.slack.com/archives/CKH7V1M7F)
| Users - China | [#users-china](https://kubeflow.slack.com/archives/C93HYNM9C)
| Users - Korea | [#users-korea](https://kubeflow.slack.com/archives/CKPCJB9AP)
| Users - Oceania | [#users-oceania](https://kubeflow.slack.com/archives/C023ZN1R9FC)
## Community discussions
## Mailing List
There are many ways to contribute! Join one of our communication channels,
attend a community meeting, get to know the community, discuss updates, suggest
exciting new integrations.
### Community meetings
[**Meeting calendar**](https://calendar.google.com/calendar/embed?src=kubeflow.org_7l5vnbn8suj2se10sen81d9428%40group.calendar.google.com&ctz=America%2FLos_Angeles) ([iCal version](https://calendar.google.com/calendar/ical/kubeflow.org_7l5vnbn8suj2se10sen81d9428%40group.calendar.google.com/public/basic.ics)).
[Meeting notes](http://bit.ly/kf-meeting-notes).
If your group has a regular meeting, talk to
[@ewilderj](https://github.com/ewilderj) about getting it added to the calendar.
### Kubeflow community call
The project team holds a weekly community call on Tuesdays. This call alternates
weekly between US East/EMEA and US West/APAC friendly times. Joining the
[kubeflow-discuss](https://groups.google.com/forum/#!forum/kubeflow-discuss)
mailing list will automatically send you calendar invitations for the meetings,
or you can subscribe to the community meeting calendar above.
Agenda, notes, and a reminder of the next call are sent to the kubeflow-discuss
mailing list.
<a id="slack"></a>
### Slack community and channels
The Kubeflow Slack workspace is
[kubeflow.slack.com](https://kubeflow.slack.com/). To join, click this
[**invitation to our Slack
workspace**](https://kubeflow.slack.com/join/shared_invite/zt-n73pfj05-l206djXlXk5qdQKs4o1Zkg#/).
The Kubeflow Slack workspace offers several channels. Here are a few examples:
| Topic | Slack channel |
| :---------------------------------------------------------------------------------------- | :------------------------------------------------------------------- |
| General discussion | [#general](https://kubeflow.slack.com/messages/C7REE0EHK) |
| Community meeting chat | [#community](https://kubeflow.slack.com/messages/C8Q0QJYNB) |
| Documentation ([GitHub](https://github.com/kubeflow/website)) | [#website](https://kubeflow.slack.com/messages/CA4M298LD) |
| Examples ([GitHub](https://github.com/kubeflow/examples)) | [#kubeflow-examples](https://kubeflow.slack.com/messages/CA30Q9A4U) |
| Google Summer of Code (GSoC) | [#gsoc](https://kubeflow.slack.com/messages/CUF1GCJ4Q) |
| KFServing ([GitHub](https://github.com/kubeflow/kfserving)) | [#kfserving](https://kubeflow.slack.com/messages/CH6E58LNP) |
| On-prem SIG | [#sig-onprem](https://kubeflow.slack.com/archives/C01C9NPD15H) |
| Pipelines ([GitHub](https://github.com/kubeflow/pipelines)) | [#kubeflow-pipelines](https://kubeflow.slack.com/messages/CE10KS9M4) |
| Product management | [#product-management](https://kubeflow.slack.com/messages/CGP3DKT5E) |
| WG AutoML ([GitHub](https://github.com/kubeflow/community/tree/master/wg-automl)) | [#wg-automl](https://kubeflow.slack.com/messages/C018PMV53NW) |
| WG Training ([GitHub](https://github.com/kubeflow/community/tree/master/wg-training)) | [#wg-training](https://kubeflow.slack.com/messages/C018N3M6QKB) |
### Mailing lists
The primary mailing list (email group) is
[kubeflow-discuss](https://groups.google.com/forum/#!forum/kubeflow-discuss).
The official Kubeflow mailing list is a Google Group called [kubeflow-discuss](https://groups.google.com/g/kubeflow-discuss).
More detail about the Kubeflow mailing lists:
| Topic | Mailing list |
| :----------------- | :--------------------------------------------------------------------------- |
| General discussion | [kubeflow-discuss](https://groups.google.com/forum/#!forum/kubeflow-discuss) |
| Topic | Mailing List |
| --- | --- |
| General Discussion | [kubeflow-discuss](https://groups.google.com/g/kubeflow-discuss)
## Who should consider contributing to Kubeflow?
## Weekly Community Call
- Folks who want to add support for other ML frameworks (e.g. PyTorch, XGBoost, scikit-learn)
- Folks who want to bring more Kubernetes magic to ML (e.g. ISTIO integration for prediction)
- Folks who want to make Kubeflow a richer ML platform (e.g. support for ML pipelines, hyperparameter tuning, neural architecture search)
- Folks who want to tune Kubeflow for their particular Kubernetes distribution or Cloud
- Folks who want to write tutorials or blog posts showing how to use Kubeflow to solve ML problems
The Kubeflow community holds a public call every Tuesday, alternating between `US East/EMEA` and `US West/APAC` friendly times.
For details on contributing please look at [the contributor's guide](/docs/about/contributing/).
{{% alert title="Tip" color="info" %}}
Joining the [kubeflow-discuss](https://groups.google.com/g/kubeflow-discuss) Google Group will automatically send a calendar invitation to your email address.
{{% /alert %}}
More detail about the Kubeflow weekly community call:
| Description | Link |
| --- | --- |
| Meeting Notes | [Google Doc](http://bit.ly/kf-meeting-notes)
| Call Recordings | [YouTube Playlist](https://www.youtube.com/playlist?list=PLmzRWLV1CK_ypvsQu10SGRmhf2S7mbYL5)
| Community Calendar | [Google Calendar](https://calendar.google.com/calendar/embed?src=kubeflow.org_7l5vnbn8suj2se10sen81d9428%40group.calendar.google.com) and [iCal file](https://calendar.google.com/calendar/ical/kubeflow.org_7l5vnbn8suj2se10sen81d9428%40group.calendar.google.com/public/basic.ics)
| Community Calendar Management | [GitHub Repo](https://github.com/kubeflow/community/tree/master/calendar)
## Blog
The official Kubeflow blog is [found here](https://blog.kubeflow.org).
{{% alert title="Tip" color="info" %}}
To contribute an article for the blog, please raise an issue on the [kubeflow/community](https://github.com/kubeflow/community) GitHub repo.
Note that articles are managed on the [kubeflow/blog](https://github.com/kubeflow/blog) GitHub repo.
{{% /alert %}}
## Kubeflow Trademark
The Kubeflow trademark and logos are registered trademarks of Google, please review the [Kubeflow Brand Guidelines](https://github.com/kubeflow/community/blob/master/KUBEFLOW_BRAND_GUIDELINES.pdf) for more information.
## Kubeflow Working Groups
The Kubeflow project has a number of Working Groups (WGs) who each maintain some aspect of the Kubeflow project.
<div class="table-responsive">
<table class="table table-bordered">
<thead class="thead-light">
<tr>
<th>Working Group</th>
<th>Maintained Components</th>
</tr>
</thead>
<tbody>
<!-- ======================= -->
<!-- AutoML Working Group -->
<!-- ======================= -->
<tr>
<td rowspan="1" class="align-middle">
<a href="https://github.com/kubeflow/community/tree/master/wg-automl">AutoML</a>
</td>
<td>
<a href="https://github.com/kubeflow/katib">Katib</a>
</td>
</tr>
<!-- ======================= -->
<!-- Deployment Working Group -->
<!-- ======================= -->
<tr>
<td rowspan="1" class="align-middle">
<a href="https://github.com/kubeflow/community/tree/master/wg-deployment">Deployment</a>
</td>
<td>
<a href="https://github.com/kubeflow/kfctl">kfctl</a>
</td>
</tr>
<!-- ======================= -->
<!-- Manifests Working Group -->
<!-- ======================= -->
<tr>
<td rowspan="1" class="align-middle">
<a href="https://github.com/kubeflow/community/tree/master/wg-manifests">Manifests</a>
</td>
<td>
<a href="https://github.com/kubeflow/manifests">Manifests Repository</a>
</td>
</tr>
<!-- ======================= -->
<!-- Notebooks Working Group -->
<!-- ======================= -->
<tr>
<td rowspan="9" class="align-middle">
<a href="https://github.com/kubeflow/community/tree/master/wg-notebooks">Notebooks</a>
</td>
<td>
<a href="https://github.com/kubeflow/kubeflow/tree/master/components/admission-webhook">Admission Webhook (PodDefaults)</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/kubeflow/kubeflow/tree/master/components/centraldashboard">Central Dashboard</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/kubeflow/kubeflow/tree/master/components/crud-web-apps/jupyter">Jupyter Web App</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/kubeflow/kubeflow/tree/master/components/access-management">Kubeflow Access Management API (KFAM)</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/kubeflow/kubeflow/tree/master/components/notebook-controller">Notebook Controller</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/kubeflow/kubeflow/tree/master/components/profile-controller">Profile Controller</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/kubeflow/kubeflow/tree/master/components/tensorboard-controller">Tensorboard Controller</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/kubeflow/kubeflow/tree/master/components/crud-web-apps/tensorboards">Tensorboard Web App</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/kubeflow/kubeflow/tree/master/components/crud-web-apps/volumes">Volumes Web App</a>
</td>
</tr>
<!-- ======================= -->
<!-- Pipelines Working Group -->
<!-- ======================= -->
<tr>
<td rowspan="2" class="align-middle">
<a href="https://github.com/kubeflow/community/tree/master/wg-pipelines">Pipelines</a>
</td>
<td>
<a href="https://github.com/kubeflow/pipelines">Kubeflow Pipelines</a>
</td>
</tr>
<tr>
<td>
<a href="https://github.com/kubeflow/kfp-tekton">Kubeflow Pipelines on Tekton</a>
</td>
</tr>
<!-- ======================= -->
<!-- Serving Working Group -->
<!-- ======================= -->
<tr>
<td rowspan="1" class="align-middle">
<a href="https://github.com/kubeflow/community/tree/master/wg-serving">Serving</a>
</td>
<td>
<a href="https://github.com/kserve/kserve">KServe (formerly KFServing)</a>
</td>
</tr>
<!-- ======================= -->
<!-- Training Working Group -->
<!-- ======================= -->
<tr>
<td rowspan="1" class="align-middle">
<a href="https://github.com/kubeflow/community/tree/master/wg-training">Training</a>
</td>
<td>
<a href="https://github.com/kubeflow/training-operator">Kubeflow Training Operator</a>
</td>
</tr>
</tbody>
</table>
</div>

View File

@ -1,49 +1,34 @@
+++
title = "Contributing to Kubeflow"
description = "How to start contributing to Kubeflow"
weight = 3
title = "Contributing"
description = "Guidelines for contributing to Kubeflow"
weight = 20
aliases = ["/docs/contributing/"]
+++
Welcome to the Kubeflow project!
## Getting started as a Kubeflow contributor
This document is the single source of truth for how to contribute to the code base.
We'd love to accept your patches and contributions to this project. There are
just a few small guidelines you need to follow.
We'd love to accept your patches and contributions to this project.
There are just a few small guidelines you need to follow.
## Getting Started
### Sign the CLA
Contributions to this project must be accompanied by a Contributor License Agreement (CLA).
You (or your employer) retain the copyright to your contribution.
This gives us permission to use and redistribute your contributions as
part of the project. Head over to <https://cla.developers.google.com/> to see
your current agreements on file or to sign a new one.
This gives us permission to use and redistribute your contributions as part of the project.
Head over to <https://cla.developers.google.com/> to see your current agreements on file or to sign a new one.
You generally only need to submit a CLA once, so if you've already submitted one
(even if it was for a different project), you probably don't need to do it
again.
You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project),
you probably don't need to do it again.
### Follow the code of conduct
Please make sure to read and observe our [Code of Conduct](https://github.com/kubeflow/community/blob/master/CODE_OF_CONDUCT.md) and [inclusivity document](https://github.com/kubeflow/community/blob/master/INCLUSIVITY.md).
### Consider participating in Kubeflow user research
Maggie Lynn, a user experience researcher, is conducting user studies to
inform future developments for Kubeflow. These typically involve a one hour
study session conducted online with a thank you gift for providing your feedback.
As a member of the Kubeflow community, your feedback and expertise are
extremely valuable to us, so if you have time in the next month, please consider
participating. To gather your interest, availability, and some basic information
about you, please fill out this form where youll find out more details about
this research opportunity: [https://goo.gl/forms/sv5sRo3UfsgeUEjK2](https://goo.gl/forms/sv5sRo3UfsgeUEjK2)
Please make sure to read and observe our [Code of Conduct](https://github.com/kubeflow/community/blob/master/CODE_OF_CONDUCT.md)
and [inclusivity document](https://github.com/kubeflow/community/blob/master/INCLUSIVITY.md).
## Joining the community
Follow these instructions if you want to
Follow these instructions if you want to:
- Become a member of the Kubeflow GitHub org (see below)
- Become part of the Kubeflow build cop or release teams
@ -51,97 +36,85 @@ Follow these instructions if you want to
### Joining the Kubeflow GitHub Org
- **Note**: Anyone can contribute to Kubeflow, adding yourself as a member in [org.yaml](https://github.com/kubeflow/internal-acls/blob/master/github-orgs/kubeflow/org.yaml) is not a mandatory step.
Before asking to join the community, we ask that you first make a small number of contributions
to demonstrate your intent to continue contributing to Kubeflow.
There are a number of ways to contribute to Kubeflow
- **Note**: Anyone can contribute to Kubeflow, adding yourself as a member in [org.yaml](https://github.com/kubeflow/internal-acls/blob/master/github-orgs/kubeflow/org.yaml)
is not a mandatory step.
There are a number of ways to contribute to Kubeflow:
- Submit PRs
- File issues reporting bugs or providing feedback
- Answer questions on Slack or GitHub issues
You can use this [table](http://devstats.kubeflow.org/d/9/developers-summary) to see how many contributions
you've made
You can use this [table](http://devstats.kubeflow.org/d/9/developers-summary) to see how many contributions you've made.
- **Note**: This only counts GitHub related ways of contributing
When you are ready to join
- Send a PR adding yourself as a member in [org.yaml](https://github.com/kubeflow/internal-acls/blob/master/github-orgs/kubeflow/org.yaml#L19). Follow the instructions in [Joining the Kubeflow GitHub organization](https://github.com/kubeflow/internal-acls#joining-kubeflow-github-organization) for more information about artifacts to include with your PR and how to test your PR.
- Send a PR adding yourself as a member in [org.yaml](https://github.com/kubeflow/internal-acls/blob/master/github-orgs/kubeflow/org.yaml#L19).
Follow the instructions in [Joining the Kubeflow GitHub organization](https://github.com/kubeflow/internal-acls#joining-kubeflow-github-organization)
for more information about artifacts to include with your PR and how to test your PR.
- After the PR is merged an admin will send you an invitation
- This is a manual process that's generally run a couple times a week
- This is a manual process that's generally run a couple of times a week
- If a week passes without receiving an invitation reach out on [kubeflow#community](https://kubeflow.slack.com/messages/C8Q0QJYNB/convo/CABQ2BWHW-1544147308.002500/)
### Companies/organizations
If you would like your company or organization to be acknowledged for contributing to
Kubeflow or participating in the community (being a user counts) please send a PR
adding the relevant info to
[member_organizations.yaml](https://github.com/kubeflow/community/blob/master/member_organizations.yaml).
If you would like your company or organization to be acknowledged for contributing to Kubeflow,
or participating in the community (being a user counts),
please send a PR adding the relevant info to [member_organizations.yaml](https://github.com/kubeflow/community/blob/master/member_organizations.yaml).
If you want your employee's GitHub contributions to be attributed to your company please ask them to set
the company field in their GitHub profile.
### Community discussions
There are many ways to contribute! Join one of our communication channels,
attend a community meeting, get to know the community. Read the details in
our [community guide](/docs/about/community).
If you want your employee's GitHub contributions to be attributed to your company,
please ask them to set the company field in their GitHub profile.
## Your first contribution
### Find something to work on
Help is always welcome! For example, documentation (like the text you are reading
now) can always use improvement. There's always code that can be clarified and
variables or functions that can be renamed or commented. There's always a need
for more test coverage. You get the idea - if you ever see something you think
should be fixed, you should own it. Here is how you get started.
Help is always welcome!
For example, documentation (like the text you are reading now) can always use improvement.
There's always code that can be clarified and variables or functions that can be renamed or commented.
There's always a need for more test coverage.
You get the idea - if you ever see something you think should be fixed, you should own it.
Here is how you get started.
### Starter issues
To find Kubeflow issues that make good entry points:
- Start with issues labeled **good first issue**. For example, see the good
first issues in the [kubeflow/website
repository](https://github.com/kubeflow/website/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
for doc updates, and in the [kubeflow/kubeflow
repository](https://github.com/kubeflow/kubeflow/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
- Start with issues labeled **good first issue**.
For example, see the good first issues in the [kubeflow/website repository](https://github.com/kubeflow/website/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
for doc updates, and in the [kubeflow/kubeflow repository](https://github.com/kubeflow/kubeflow/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
for updates to the core Kubeflow code.
- For issues that require deeper knowledge of one or more technical aspects,
look at issues labeled **help wanted**. For example, see these issues in the
[kubeflow/kubeflow
repository](https://github.com/kubeflow/kubeflow/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
- Examine the issues in any of the
[Kubeflow repositories](https://github.com/kubeflow).
- For issues that require deeper knowledge of one or more technical aspects, look at issues labeled **help wanted**.
For example, see these issues in the [kubeflow/kubeflow repository](https://github.com/kubeflow/kubeflow/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
- Examine the issues in any of the [Kubeflow repositories](https://github.com/kubeflow).
## Owners files and PR workflow
Our PR workflow is nearly identical to Kubernetes'. Most of these instructions are a
modified version of Kubernetes' [contributors](https://github.com/kubernetes/community/blob/master/contributors/guide/README.md)
and [owners](https://github.com/kubernetes/community/blob/master/contributors/guide/owners.md#code-review-using-owners-files)
guides.
Our PR workflow is nearly identical to Kubernetes'.
Most of these instructions are a modified version of Kubernetes' [contributors](https://github.com/kubernetes/community/blob/master/contributors/guide/README.md)
and [owners](https://github.com/kubernetes/community/blob/master/contributors/guide/owners.md#code-review-using-owners-files) guides.
### Overview of OWNERS files
OWNERS files are used to designate responsibility over different parts of the Kubeflow codebase.
Today, we use them to assign the **reviewer** and **approver** roles used in our two-phase code
review process. Our OWNERS files were inspired by [Chromium OWNERS
files](https://chromium.googlesource.com/chromium/src/+/master/docs/code_reviews.md), which in turn
inspired [GitHub's CODEOWNERS files](https://help.github.com/articles/about-codeowners/).
Today, we use them to assign the **reviewer** and **approver** roles used in our two-phase code review process.
Our OWNERS files were inspired by [Chromium OWNERS files](https://chromium.googlesource.com/chromium/src/+/master/docs/code_reviews.md),
which in turn inspired [GitHub's CODEOWNERS files](https://help.github.com/articles/about-codeowners/).
The velocity of a project that uses code review is limited by the number of people capable of
reviewing code. The quality of a person's code review is limited by their familiarity with the code
under review. Our goal is to address both of these concerns through the prudent use and maintenance
of OWNERS files
The velocity of a project that uses code review is limited by the number of people capable of reviewing code.
The quality of a person's code review is limited by their familiarity with the code under review.
Our goal is to address both of these concerns through the prudent use and maintenance of OWNERS files
### OWNERS <a name="owners-1"></a>
<a name="owners-1"></a>
### OWNERS
Each directory that contains a unit of independent code or content may also contain an OWNERS file.
This file applies to everything within the directory, including the OWNERS file itself, sibling
files, and child directories.
This file applies to everything within the directory, including the OWNERS file itself, sibling files, and child directories.
OWNERS files are in YAML format and support the following keys:
@ -153,8 +126,8 @@ OWNERS files are in YAML format and support the following keys:
effect on `a/deep/nested/bit/of/code`
- `reviewers`: a list of GitHub usernames or aliases that are good candidates to `/lgtm` a PR
All users are expected to be assignable. In GitHub terms, this means they are either collaborators
of the repo, or members of the organization to which the repo belongs.
All users are expected to be assignable.
In GitHub terms, this means they are either collaborators of the repo, or members of the organization to which the repo belongs.
A typical OWNERS file looks like:
@ -176,8 +149,7 @@ OWNERS_ALIAS files are in YAML format and support the following keys:
- `aliases`: a mapping of alias name to a list of GitHub usernames
We use aliases for groups instead of GitHub Teams, because changes to GitHub Teams are not
publicly auditable.
We use aliases for groups instead of GitHub Teams, because changes to GitHub Teams are not publicly auditable.
A sample OWNERS_ALIASES file looks like:
@ -276,8 +248,7 @@ is the state of today.
- **Authors** are unresponsive
- This costs a tremendous amount of attention as context for an individual PR is lost over time
- This hurts the project in general as its general noise level increases over time
- Instead, close PR's that are untouched after too long (we currently have a bot do this after 90
days)
- Instead, close PR's that are untouched after too long (we currently have a bot do this after 90 days)
## Automation using OWNERS files

View File

@ -1,47 +0,0 @@
+++
title = "Docs"
description = "Information on the Kubeflow docs and how to contribute to them"
weight = 6
aliases = ["/docs/docs/"]
+++
Welcome to the Kubeflow documentation!
## Introduction
The Kubeflow docs are published at
[www.kubeflow.org](https://www.kubeflow.org/).
The source for the docs is in the
[kubeflow/website repo](https://github.com/kubeflow/website/) on GitHub.
We use [Hugo](https://gohugo.io/) to format and generate our website, and
[Netlify](https://www.netlify.com/) to manage the deployment of the site.
## Versioning
www.kubeflow.org points to the **master** branch of the docs. You can access
other versions by clicking the version dropdown at top right of the website
menu bar:
<img src="/docs/images/version-dropdown.jpg"
alt="Version dropdown"
style="width:30%;"
class="mt-3 mb-3 border border-info rounded">
We create a new branch of the docs for each stable release of Kubeflow.
For example, the docs for the v0.2 stable release are on published on the
[v0.2 website](https://v0-2.kubeflow.org/docs/about/kubeflow/), which
corresponds to the
[v0.2-branch](https://github.com/kubeflow/website/tree/v0.2-branch) on
GitHub.
## Contributing to the docs
We welcome updates to the docs! Please help us make them better. Small fixes,
typos, bug fixes, plugging gaps&mdash;all are useful.
- For help with getting started, take a look at the
[README](https://github.com/kubeflow/website/blob/master/README.md).
- For guidance on writing effective documentation, see the
[style guide](/docs/about/style-guide/).

View File

@ -1,198 +0,0 @@
+++
title = "Events Calendar"
description = "Events related to Kubeflow"
weight = 10
aliases = ["/docs/events/"]
+++
This is a nonexhaustive list of events (in reverse chronological order) with talks and workshops about Kubeflow.
Please edit this page and send a pull request, or raise a [GitHub issue](https://github.com/kubeflow/website/issues/new), if something is missing or incorrect.
- [Kubeflow Doc Sprint - Sunnyvale and online](https://github.com/kubeflow/website/wiki/Kubeflow-Doc-Sprint),
10-12 February 2020
- _Monday 10 February:_ Welcome; docs/code development; learning sessions.
- _Tuesday 11 February:_ Sprint updates; docs/code development; learning sessions.
- _Wednesday 12 February:_ Docs/code development; sprint demos.
- Kubeflow Doc Sprint, 10-12 July 2019. See the [results of the July 2019 doc sprint](https://medium.com/kubeflow/kubeflow-doc-sprint-its-a-wrap-2683bfd4078d).
- [Google Cloud Next, San Francisco](https://cloud.withgoogle.com/next/sf), 9-11 April, 2019
- [Undoing Human Bias at Scale With Kubeflow](https://cloud.withgoogle.com/next/sf/sessions?session=MLAI206): John Bohannon, Michelle Casbon
- [Kubeflow Contributor Summit 2019](https://docs.google.com/document/d/14Jr79aWVjsJg8xq38CLVE4rKRwM1_-gHLuxhGAhrGTI/edit?usp=sharing), Sunnyvale, CA, 12-13 March, 2019
- Kubeflow and the ML Landscape: Jeremy Lewi, Google
- [Slides](https://docs.google.com/presentation/d/1kJtBNOLHI8bR7z5OVUNDQHUBJ0K7ayGPwP4UQezMAoA/edit?usp=sharing)
- Updates from the PM Working Group:
- PMs: David Aronchick, Josh Bottum, Carmine Rimi
- [Slides](https://docs.google.com/presentation/d/100GXMDDKDyiANSZnvIN_l5kCNxKnsOOcTLq-34-OaJc/edit?usp=sharing)
- Building Together: Community in Kubeflow: Thea Lamkin, Google
- [Slides](https://docs.google.com/presentation/d/1kEOkz82lUJEfr0GrfDLnTN-g7D1NaFyvqBAzuEDjce8/edit?usp=sharing)
- Experiment Tracking with Kubeflow, Lukas Biewald, Weights & Biases
- [Slides](https://drive.google.com/a/kubeflow.org/file/d/1JEqNlDHk9LKe8QZ0lUQc7X09Y_59Zyga/view?usp=sharing)
- Multi-User Environments, Kam Kasravi & Ebi Shahbazi, Intel
- [Slides](https://docs.google.com/presentation/d/1xoqu189q54sAXRTQ-Ise3_T09JLkQxVBGe5lCFy4UsE/edit?usp=sharing)
- On-Premise: Debo Dutta, Cisco
- [Slides](https://docs.google.com/presentation/d/1cphcFf4qszQ9PxcEnYkF0pkY3AZEQiEEjs8cso2KJjE/edit?usp=sharing)
- MiniKF: Local Kubeflow: Vangelis Koukis, Arrikto
- [Slides](https://docs.google.com/presentation/d/1ftOhRZtpIF3Iy-2R6z9kwgS3KMUtIFnvA1LHHEyxsp8/edit?usp=sharing)
- TensorFlow 2.0 is coming!: Paige Bailey, Google
- [Slides](https://docs.google.com/presentation/d/1G0BE7tvhsCzZn2uaxEZsoosEZyXkjN8CnB3uHvLpiC0/edit?usp=sharing)
- Overview of Kubeflow Pipelines: Pavel Dournov, Google
- [Slides](https://docs.google.com/presentation/d/1aMmJUz7r7Toky4nGZ1bItWKfXW4kSMbs4cofFeyKE-M/edit?usp=sharing)
- Feast: Feature Storage for Machine Learning: Tim Sell, Google
- [Slides](https://docs.google.com/presentation/d/1k2FrlIyob3UfzvzxJ7B8YI9H3dx8B-LTDqCH_FESYCA/edit?usp=sharing)
- Understanding the Earth: Machine Learning with Kubeflow Pipelines: Faustine Li, Descartes Labs
- [Slides](https://docs.google.com/presentation/d/17KeqJmoKM0hBnXDiC5X2qEPutX08TmL56RyTWMbQ34w/edit?usp=sharing)
- Kubeflow Experiments at LinkedIn: Tengfei Mu & Abin Shahab, LinkedIn
- [Slides](https://docs.google.com/presentation/d/1bnVZXCvNKOtmqCIMefT2QZCQb62_P0pwBa3PBachNus/edit?usp=sharing)
- Ask the User: Data Science Panel, Moderator: Karthik Ramasamy, Google
- Panelists: Ting Chen, Emmanuel Ameisen, Scott Leishman, Caio Soares, June Andrews, Jun Wang
- Simple, GPU-Accelerated Kubeflow Pipeline: Ananth Sankarasubramanian, NVIDIA
- [Slides](https://docs.google.com/presentation/d/1B84ix3Dq_s-vj0wRagKGEUtyT4Euhr_siY8oCG-zW1w/edit?usp=sharing)
- Fairing: Matt Rickard, Google
- [Slides](https://docs.google.com/presentation/d/1-gqS-HxMpMd2Kv5-W1_i2TQuXO8O_oM1mL0s-7I2-bA/edit?usp=sharing)
- ModelDB: Open-source model management: Manasi Vartak, Verta.ai
- [Slides](https://docs.google.com/presentation/d/1ri_GrTNyz1XScbaK5f1isvSeA8pGpURg7lmghv8h4Yw/edit?usp=sharing)
- Katib & Hyperparameter Tuning: Richard Liu, Google
- [Slides](https://docs.google.com/presentation/d/1QbF8naUIHHHvOWKq7uA-DP_jmADbgep8nfjOC_zG_JQ/edit?usp=sharing)
- Kubeflow User Experience: Derek Ferguson, JP Morgan Chase
- [Slides](https://docs.google.com/presentation/d/1l4zZVisA1xG1Ty1TNZrWFnDbY9YZ3tZ1TkLe6UqUSXk/edit?usp=sharing)
- Kubeflow & TFX: Kevin Haas, Google
- [Slides](https://docs.google.com/presentation/d/1j4q7AkMs2Pz-9VFmE2vKOanqrR7NFIkN22ObJ_7DVm0/edit?usp=sharing)
- Kubeflow inference on Knative: Dan Sun, Bloomberg
- [Slides](https://docs.google.com/presentation/d/1sApAPkBWEKBVB5KZCJKHAcsy8Ry2TLzTnGLbpN6EiXA/edit?usp=sharing)
- Arena: Yang Che, Alibaba
- [Slides](https://docs.google.com/presentation/d/1mZ6pjgUYt0LhGN8E-zCM1FE-3GNbtK8Y6NlVeD1WahY/edit?usp=sharing)
- [Demo video](https://drive.google.com/a/kubeflow.org/file/d/1ITkcf9YvYDJ9KiRlNWOHmMEFOe2DeMGi/view?usp=sharing)
- Examples, Codelabs, & Demos: Michelle Casbon, Google
- [Slides](https://docs.google.com/presentation/d/1h001JfBUaAjoPTrHpbuVRNJtrO1jWRMG_YRDzL2Pd3I/edit?usp=sharing)
- [Data Day Texas, Austin](https://datadaytexas.com/), 26 January, 2019
- [Kubeflow: Portable Machine Learning on Kubernetes](https://datadaytexas.com/2019/sessions#casbon): Michelle Casbon
- [Slides](https://docs.google.com/presentation/d/1PvtKTw3KNbGurNymDddbsmEfLQd9cOfjbpDQ-2DSNd8)
- [AI NEXTCon, Seattle](http://aisea19.xnextcon.com/), 23-26 January, 2019
- [Build and Manage Machine Learning Pipelines](http://aisea19.xnextcon.com/talkabstract.html#ws-kubeflow): Amy Unruh
- [KubeCon, Seattle](https://events.linuxfoundation.org/events/kubecon-cloudnativecon-north-america-2018/), 11-13 December, 2018
- [Deep Dive: Kubeflow BoF](https://sched.co/Ha1X): Jeremy Lewi, David Aronchick
- [Slides](https://docs.google.com/presentation/d/1QP-o4O3ygpJ6aVfu6lAm0tMWYhAvdKE9FD6_92DB3EY)
- [Video](https://www.youtube.com/watch?v=gbZJ8eSIfJg)
- [Eco-Friendly ML: How the Kubeflow Ecosystem Bootstrapped Itself](https://sched.co/GrTc): Peter McKinnon
- [Slides](https://docs.google.com/presentation/d/1DUJHiYxz0D6qexBbNGjtRHYi4ERTKUOZ-LvqoHVKS-E)
- [Video](https://www.youtube.com/watch?v=EVSfp8HGJXY)
- [Machine Learning as Code](https://sched.co/GrVh): Jay Smith
- [Slides](https://docs.google.com/presentation/d/1XKyf5fAM9KfF4OSnZREoDu-BP8JBtGkuSv72iX7CARY)
- [Video](https://www.youtube.com/watch?v=VXrGp5er1ZE)
- [Natural Language Code Search for GitHub Using Kubeflow](https://sched.co/GrVn): Jeremy Lewi, Hamel Husain
- [Slides](https://drive.google.com/open?id=1jHE61fAqZNgaDrpItk5L_tCzLU0DuL86rCz4yAKz4Ss)
- [Video](https://www.youtube.com/watch?v=SF77UBvfTHU)
- [Workshop: Kubeflow End-to-End: GitHub Issue Summarization](https://sched.co/GrWE): Amy Unruh, Michelle Casbon
- [Codelab](https://g.co/codelabs/kubecon18)
- [Slides](https://docs.google.com/presentation/d/1FFftSbWidin3opCIl4U0HVPvS6xk17izUFrrMR7e5qk)
- [Video](https://www.youtube.com/watch?v=UdthJEq8YsA)
- [Women in ML & Data Science](https://www.meetup.com/Melbourne-Women-in-Machine-Learning-and-Data-Science/), Melbourne, 5 December, 2018
- [Panel](https://www.meetup.com/Melbourne-Women-in-Machine-Learning-and-Data-Science/events/256563019/): Michelle Casbon
- [YOW!, Melbourne](https://melbourne.yowconference.com.au/), 4-7 December, 2018
- [Kubeflow Explained: NLP Architectures on Kubernetes](https://melbourne.yowconference.com.au/proposal/?id=6858): Michelle Casbon
- [Slides](https://docs.google.com/presentation/d/1lXs1B4xrXTK2QiVe5rJSPCQjTdyMDfNVJcZCLh-Bcu0)
- [YOW!, Brisbane](https://brisbane.yowconference.com.au/), 3-4 December, 2018
- [Kubeflow Explained: NLP Architectures on Kubernetes](https://brisbane.yowconference.com.au/proposal/?id=6859): Michelle Casbon
- [Slides](https://docs.google.com/presentation/d/1lXs1B4xrXTK2QiVe5rJSPCQjTdyMDfNVJcZCLh-Bcu0)
- [YOW!, Sydney](https://sydney.yowconference.com.au/), 27-30 November, 2018
- [Kubeflow Explained: NLP Architectures on Kubernetes](https://sydney.yowconference.com.au/proposal/?id=6860): Michelle Casbon
- [Slides](https://docs.google.com/presentation/d/1lXs1B4xrXTK2QiVe5rJSPCQjTdyMDfNVJcZCLh-Bcu0)
- [Scale By the Bay, San Francisco](http://scale.bythebay.io/), 15-17 November, 2018
- [Data Engineering & AI Panel](https://sched.co/Fndz): Michelle Casbon
- [Video](https://www.youtube.com/watch?v=sJd9RRmgCH4)
- [KubeCon, Shanghai](https://www.lfasiallc.com/events/kubecon-cloudnativecon-china-2018/), 13-15 November, 2018
- [A Tale of Using Kubeflow to Make the Electricity Smarter in China](https://sched.co/FzGn): Julia Han, Xin Zhang
- [Slides](https://schd.ws/hosted_files/kccncchina2018english/34/XinZhang_JuliaHan_En.pdf)
- [Video](https://www.youtube.com/watch?v=fad1FsfEvNY)
- [A Year of Democratizing ML With Kubernetes & Kubeflow](https://sched.co/FuLr): David Aronchick, Fei Xue
- [Slides](https://docs.google.com/presentation/d/1ZuZs32CFPYZ9ub8o8whSK8SA2333UjtAVujRnKJTf2M)
- [Video](https://www.youtube.com/watch?v=oMlddDdJgEg)
- [Benchmarking Machine Learning Workloads on Kubeflow](https://sched.co/FuJw): Xinyuan Huang, Ce Gao
- [Slides](https://schd.ws/hosted_files/kccncchina2018english/22/Kubebench_KubeCon2018China.pdf)
- [Video](https://www.youtube.com/watch?v=9sLRIBYYUlQ)
- [CI/CD Pipelines & Machine Learning](https://sched.co/FuJo): Jeremy Lewi
- [Slides](https://schd.ws/hosted_files/kccncchina2018english/ee/KubeConChina2018.pdf)
- [Video](https://www.youtube.com/watch?v=EH850bIQVag)
- [Kubeflow From the End User's Perspective](https://sched.co/FuJx): Xin Zhang
- [Video](https://www.youtube.com/watch?v=x0CKhyoV9aI)
- [Kubernetes CI/CD Hacks with KicroK8s and Kubeflow](https://sched.co/FuJc): Land Lu, Zhang Lei Mao
- [Slides](https://schd.ws/hosted_files/kccncchina2018english/0a/Kubecon%20Shanghai%20-%20CICD%20Hacks_Canonical.pdf)
- [Video](https://www.youtube.com/watch?v=1SSvS2w5OMQ)
- [Machine Learning on Kubernetes BoF](https://sched.co/FuJs): David Aronchick
- [Video](https://www.youtube.com/watch?v=0eEAZ7lmLbo)
- [Operating Deep Learning Pipelines Anywhere Using Kubeflow](https://sched.co/FuJt): Jörg Schad, Gilbert Song
- [Slides](https://schd.ws/hosted_files/kccncchina2018english/fe/Kubecon%20KubeFlow%2B%2B%20Summit.pdf)
- [Video](https://www.youtube.com/watch?v=63HJgZK27mU)
- [DevFest, Seattle](https://www.eventbrite.com/e/devfest-seattle-2018-tickets-50408043816), 3 November, 2018
- Kubeflow End to End: Amy Unruh
- [Data@Scale, Boston](https://dataatscale2018.splashthat.com/), 25 October, 2018
- [Women in Engineering Panel](https://datascalewomensbreakfast.splashthat.com/): Michelle Casbon
- [Kubeflow: Portable Machine Learning on Kubernetes](https://code.fb.com/core-data/data-scale-boston/): Michelle Casbon
- [Video](https://www.facebook.com/atscaleevents/videos/114311602829170/)
- [Kafka Summit, San Francisco](https://kafka-summit.org/), 16-17 October, 2018
- [OReilly AI Conference, London](https://conferences.oreilly.com/artificial-intelligence/ai-eu), 08-11 October, 2018
- [Machine Learning at Scale with Kubernetes](https://conferences.oreilly.com/artificial-intelligence/ai-eu/public/schedule/detail/69194): Chris Cho
- Cloud-Native, Docker, and Kubernetes Summit, Dallas, 12 September, 2018
- [Deploying Machine Learning Workloads in Kubernetes clusters that support GPUs](https://www.eventbrite.com/e/kubernetes-classes-at-cloud-native-docker-k8s-summit-tickets-44954443952): Michael Iatrou
- [OReilly Strata Data, New York](https://conferences.oreilly.com/strata/strata-ny), 11-13 September, 2018
- [From Training to Serving: Deploying TensorFlow Models with Kubernetes](https://conferences.oreilly.com/strata/strata-ny/public/schedule/detail/69362): Brian Foo, Holden Karau, Jay Smith
- [Kubeflow Explained: Portable Machine Learning on Kubernetes](https://conferences.oreilly.com/strata/strata-ny/public/schedule/detail/69041): Michelle Casbon
- [O'Reilly AI Conference, San Francisco](https://conferences.oreilly.com/artificial-intelligence/ai-ca), 4-7 September, 2018
- [TensorFlow Days: Kubeflow: Portable Machine Learning on Kubernetes](https://conferences.oreilly.com/artificial-intelligence/ai-ca/public/schedule/topic/2899): Michelle Casbon
- [Open Source Summit, Vancouver](https://events.linuxfoundation.org/events/open-source-summit-north-america-2018/), 29-31 August, 2018
- [Elastic AI Pipeline with Kubeflow for Intelligent SKU Management in a Large Chinese Retailer](https://events.linuxfoundation.org/events/open-source-summit-north-america-2018/program/schedule/): Xin Zhang
- [Introducing Kubeflow: A System for Deploying ML/AI on
Kubernetes](https://events.linuxfoundation.org/events/open-source-summit-north-america-2018/program/schedule/): Trevor Grant, Holden Karau
- [JupyterCon, New York](https://conferences.oreilly.com/jupyter/jup-ny), 21-25 August, 2018
- [Machine Learning at Scale with Kubernetes](https://conferences.oreilly.com/jupyter/jup-ny/public/schedule/detail/69752): Chris Cho
- [Google Next, San Francisco](https://cloud.withgoogle.com/next18/sf/), 24-26 July, 2018
- AI Platform Showcase demo: Dan Sanche
- [Video](https://www.youtube.com/watch?v=el7cw-nVcBE)
- [Machine Learning Made Easy: How to Build Flexible, Portable ML Stacks with Kubeflow and Elastifile](https://cloud.withgoogle.com/next18/sf/sessions/session/193227): David Aronchick, Allon Cohen
- [Video](https://www.youtube.com/watch?v=NAqD6siHcpE)
- [Spotlight Lab: Introduction to Kubeflow on Google Kubernetes Engine](https://cloud.withgoogle.com/next18/sf/sessions/session/229041): Michelle Casbon
- [Codelab](https://codelabs.developers.google.com/codelabs/kubeflow-introduction/index.html)
- [Spotlight Lab: Kubeflow End-to-End: GitHub Issue Summarization](https://cloud.withgoogle.com/next18/sf/sessions/session/229637): Michelle Casbon
- [Codelab](https://codelabs.developers.google.com/codelabs/cloud-kubeflow-e2e-gis/index.html)
- [O'Reilly Open Source Convention, Portland](https://conferences.oreilly.com/oscon/oscon-or-2018), 16-19 July, 2018
- [TensorFlow Day: Hassle-free, scalable machine learning with Kubeflow](https://conferences.oreilly.com/oscon/oscon-or/public/schedule/detail/70899): Barbara Fusinska
- [SciPy, Austin](https://scipy2018.scipy.org/ehome/index26ac.html?eventid=299527&tabid=712461&cid=2233540&sessionid=21618893&sessionchoice=1&%26), 09-15 July, 2018
- Kubeflow: Pythonic Machine Learning at Scale on Kubernetes: David Aronchick, Paige Bailey
- [Video](https://www.youtube.com/watch?v=b_CvqzmB51M)
- [Container Day, Paris](https://paris-container-day.fr/en/), 26 June, 2018
- [Keynote: Cloud Native ML with Kubeflow](http://paris-container-day.fr/en/#tabidff38a849e758226764f1da33f5bd81e3): David Aronchick, Chris Cho
- [Video](https://www.youtube.com/watch?v=rcC11EZdo8Y)
- [Dockercon, San Francisco](https://2018.dockercon.com/), 12 - 15 June, 2018
- [Keynote: Moby's Cool Hacks](https://dockercon18.smarteventscloud.com/connect/sessionDetail.ww?SESSION_ID=224348): David Aronchick, Michelle Casbon
- [Video](https://youtu.be/RnWXOAplvjY?t=1128)
- [QCon, São Paulo](https://qconsp.com/sp2018/schedule/tabular.html), 9-11 May, 2018
- [Architecture of an NLP Deployment](https://qconsp.com/sp2018/sp2018/presentation/architecture-nlp-deployment.html): Michelle Casbon
- [Video](https://www.youtube.com/watch?v=SbecYkirt8w&t=1975)
- [KubeCon, Copenhagen](https://events.linuxfoundation.org/events/kubecon-cloudnativecon-europe-2018/), 2-4 May, 2018
- Interview: Building applications on Kubeflow: Jeremy Lewi
- [Video](https://www.youtube.com/watch?v=VTGH9ocdVM0)
- [Keynote: Cloud Native ML on Kubernetes](https://kccnceu18.sched.com/event/Duoq/keynote-cloud-native-ml-on-kubernetes-david-aronchick-product-manager-cloud-ai-and-co-founder-of-kubeflow-google-vishnu-kannan-sr-software-engineer-google-slides-attached): David Aronchick, Vishnu Kannan
- [Video](https://www.youtube.com/watch?v=I6iMznIYwM8)
- [Slides](https://drive.google.com/file/d/1_QxDZXX-sSP8llFZQ6T2zseZOcPFuVLk/view?usp=sharing)
- [Kubeflow Deep Dive](https://kccnceu18.sched.com/event/Drnd/kubeflow-deep-dive-david-aronchick-jeremy-lewi-google-intermediate-skill-level): David Aronchick, Jeremy Lewi
- [Video](https://www.youtube.com/watch?v=86GD1VzSnks)
- [Slides](https://www.google.com/url?q=https%3A%2F%2Fschd.ws%2Fhosted_files%2Fkccnceu18%2Fd4%2FKubeflow_Deep_Dive.pdf&sa=D&sntz=1&usg=AFQjCNFK_-mkyWfKAFM9wnywPVYH9thoYw)
- [Kubeflow Intro](https://kccnceu18.sched.com/event/Drmt/kubeflow-intro-michal-jastrzebski-ala-raddaoui-intel-any-skill-level-slides-attached): Michał Jastrzębski, Ala Raddaoui
- [Video](https://www.youtube.com/watch?v=NrDpQks0e98)
- [Slides](https://schd.ws/hosted_files/kccnceu18/9f/kubeflow-intro.pdf)
- [Serving ML Models at Scale with Seldon & Kubeflow](https://kccnceu18.sched.com/event/Dqvw/serving-ml-models-at-scale-with-seldon-and-kubeflow-clive-cox-seldonio-intermediate-skill-level-slides-attached): Clive Cox
- [Video](https://www.youtube.com/watch?v=pDlapGtecbY)
- [Slides](https://schd.ws/hosted_files/kccnceu18/1a/SeldonKubeconEurope2018.pdf)
- [Conquering a Kubeflow Kubernetes Cluster with ksonnet, Ark, & Sonobuoy](https://kccnceu18.sched.com/event/Dqv6/conquering-a-kubeflow-kubernetes-cluster-with-ksonnet-ark-and-sonobuoy-kris-nova-heptio-david-aronchick-google-intermediate-skill-level): David Aronchick, Kris Nova
- [Video](https://www.youtube.com/watch?v=givpqZ2IchI)
- [Building ML Products with Kubeflow](https://kccnceu18.sched.com/event/Dquu/building-ml-products-with-kubeflow-jeremy-lewi-google-stephan-fabel-canonical-intermediate-skill-level-slides-attached): Jeremy Lewi, Stephan Fabel
- [Video](https://www.youtube.com/watch?v=sC8Ce9vUggo)
- [Slides](https://schd.ws/hosted_files/kccnceu18/c2/Building%20ML%20Products%20With%20Kubeflow%20%28Kubecon%202018%29%20%281%29.pdf)
- [Compliant Data Management & Machine Learning on Kubernetes](https://kccnceu18.sched.com/event/DqvC/compliant-data-management-and-machine-learning-on-kubernetes-daniel-whitenack-pachyderm-intermediate-skill-level-slides-attached): Daniel Whitenack
- [Video](https://www.youtube.com/watch?v=eOzl-LFqYFM)
- [Slides](https://schd.ws/hosted_files/kccnceu18/a1/KubeCon_EU_2018%20%281%29.pdf)
- [Bringing Your Data Pipeline into the Machine Learning Era](https://kccnceu18.sched.com/event/E46y/bringing-your-data-pipeline-into-the-machine-learning-era-chris-gaun-jorg-schad-mesosphere-intermediate-skill-level): Chris Gaun, Jörg Schad
- [Video](https://www.youtube.com/watch?v=f_-3rQoudnc)
- [KubeCon, Austin](http://events17.linuxfoundation.org/events/kubecon-and-cloudnativecon-north-america), 6-8 December, 2017
- ["Hot Dog or Not Hot Dog" at Scale - Kubernetes & Machine Learning](https://kccncna17.sched.com/event/CU5v/hot-dogs-or-not-at-scale-with-kubernetes-i-vish-kannan-david-aronchick-google): David Aronchick, Vishnu Kannan
- [Video](https://www.youtube.com/watch?v=R3dVF5wWz-g&feature=youtu.be)

View File

@ -1,98 +0,0 @@
+++
title = "Google Summer of Code"
description = "Welcome to all Kubeflow GSoC students and mentors"
weight = 5
+++
<div>
<img src="/docs/images/gsoc-icon-192.png"
alt="The Google Summer of Code icon"
class="mt-1 mb-3 float-right img-fluid">
</div>
The Kubeflow community is delighted to be part of
[Google Summer of Code (GSoC) 2020](https://summerofcode.withgoogle.com/). Community
mentors look forward to working with students on their GSoC projects.
**Top links:**
- [GSoC timeline](https://summerofcode.withgoogle.com/how-it-works/#timeline)
- [Kubeflow GSoC project
ideas](https://docs.google.com/document/d/1AQDD9s8VpCf3y8OLKTBSMgDzHSjdsV_DOyL5dc-XCOQ/)
- [Kubeflow template for project
proposals](https://docs.google.com/document/d/1dnhvxFLV1odqpqdWdujUNNUhVPSykflLy2nLJCz-Yws/edit?usp=sharing)
## Information for students
The GSoC student application phase is now closed and student selection is in
progress. See the
[GSoC timeline](https://summerofcode.withgoogle.com/how-it-works/#timeline).
You're still welcome to explore Kubeflow. Kubeflow welcomes contributions
at any time, whether within or outside the framework of GSoC. See the
[community page](/docs/about/community/) for Slack channels, mailing lists,
meetings, and other ways to connect with the Kubeflow community.
For more information about GSoC, see the
[GSoC docs](https://developers.google.com/open-source/gsoc/faq) and
[guides](https://developers.google.com/open-source/gsoc/resources/guide).
## Information for mentors
Thanks to all mentors who're interested in helping a GSoC student with their
Kubeflow project.
To get started:
- Read the [Google Summer of Code mentor
guide](https://google.github.io/gsocguides/mentor/) and the [roles and
responsibilities](https://developers.google.com/open-source/gsoc/help/responsibilities)
to understand what is expected of you over the next 6 months.
- Bookmark the
[GSoC timeline](https://summerofcode.withgoogle.com/how-it-works/#timeline)
and be prepared to take action in time for the milestones shown on the
timeline, and to help your students meet the deadlines.
- Watch the 5 minute YouTube video: [Being a Great GSoC
Mentor](https://www.youtube.com/watch?v=3J_eBuYxcyg). The video was shot with
GSoC veteran org admins and mentors. It contains helpful information about the
program and how to participate successfully at each step in GSoC.
- If you're not registered as a mentor, email
[kubeflow-gsoc-admin@kubeflow.org](mailto:kubeflow-gsoc-admin@kubeflow.org)
to indicate your interest in mentoring a student during GSoC.
- When you receive an invitation, follow the link in the email to register on the
GSoC program site.
- Examine the student proposals. Click **want to mentor** on the proposals
that you'd like to mentor.
Start chatting to students:
- Join the
[#gsoc](https://kubeflow.slack.com/messages/CUF1GCJ4Q) channel on Kubeflow
Slack and answer students' questions.
- Respond to students' questions on the Kubeflow mentors mailing list
(`kubeflow-gsoc-mentors@kubeflow.org`).
For more information about GSoC, see the
[GSoC docs](https://developers.google.com/open-source/gsoc/faq) and
[guides](https://developers.google.com/open-source/gsoc/resources/guide).
## Mailing lists
These are the Kubeflow mailing lists related to GSoC:
- [kubeflow-gsoc-mentors@kubeflow.org](mailto:kubeflow-gsoc-mentors@kubeflow.org):
The mentor mailing list for Kubeflow GSoC projects.
Students can email this group to receive feedback on project proposals.
Mentors and org administrators can use this group to discuss Kubeflow GSoC
matters. Group members are Kubeflow GSoC mentors and org administrators.
Messages are visible to sender, CCs, and group members.
- [kubeflow-gsoc-admin@kubeflow.org](mailto:kubeflow-gsoc-admin@kubeflow.org):
The organization administrator mailing list for Kubeflow's participation in
GSoC.
Students and mentors can email this group to raise Kubeflow GSoC matters with
the administrators. Group members are Kubeflow GSoC org administrators only.
Messages are visible to sender, CCs, and group members.
- [kubeflow-discuss](https://groups.google.com/forum/#!forum/kubeflow-discuss):
Kubeflow's primarily mailing list and discussion group. See the
[community page](/docs/about/community/) for more information.

View File

@ -1,46 +1,41 @@
+++
title = "Style Guide for the Kubeflow Docs"
description = "Guidelines on effective writing"
weight = 6
title = "Documentation Style Guide"
description = "Style guide for writing Kubeflow documentation"
weight = 90
+++
This style guide is for the
[Kubeflow documentation](https://www.kubeflow.org/docs/).
The style guide helps contributors to write documentation that
readers can understand quickly and correctly. The Kubeflow docs aim for:
This style guide is for the [Kubeflow documentation](/docs/).
The style guide helps contributors to write documentation that readers can understand quickly and correctly.
The Kubeflow docs aim for:
- Consistency in style and terminology, so that readers can expect certain
structures and conventions. Readers don't have to keep re-learning how to use
the documentation or questioning whether they've understood something
correctly.
- Clear, concise writing so that readers can quickly find and understand the
information they need.
## Use standard American spelling
Use American spelling rather than Commonwealth or British spelling.
Refer to [Merriam-Webster's Collegiate Dictionary, Eleventh
Edition](http://www.merriam-webster.com/).
Refer to [Merriam-Webster's Collegiate Dictionary, Eleventh Edition](http://www.merriam-webster.com/).
## Use capital letters sparingly
Some hints:
- Capitalize only the first letter of each heading within the page. (That is,
use sentence case.)
- Capitalize (almost) every word in page titles. (That is, use title case.) The
little words like "and", "in", etc, don't get a capital letter.
- In page content, use capitals only for brand names, like Kubeflow, Kubernetes,
and so on. See more about brand names [below](#use-full-correct-brand-names).
- Capitalize only the first letter of each heading within the page. (That is, use sentence case.)
- Capitalize (almost) every word in page titles. (That is, use title case.)
The little words like "and", "in", etc, don't get a capital letter.
- In page content, use capitals only for brand names, like Kubeflow, Kubernetes, and so on.
See more about brand names [below](#use-full-correct-brand-names).
- Don't use capital letters to emphasize words.
## Spell out abbreviations and acronyms on first use
Always spell out the full term for every abbreviation or acronym the first time
you use it on the page. Don't assume people know what an abbreviation or acronym
means, even if it seems like common knowledge.
Always spell out the full term for every abbreviation or acronym the first time you use it on the page.
Don't assume people know what an abbreviation or acronym means, even if it seems like common knowledge.
Example: "To run Kubernetes locally in a virtual machine (VM)"
@ -52,10 +47,9 @@ For example, it's fine to write "it's" instead of "it is".
## Use full, correct brand names
When referring to a product or brand, use the full name. Capitalize the
name as the product owners do in the product documentation. Do
not use abbreviations even if they're in common use, unless the product owner
has sanctioned the abbreviation.
When referring to a product or brand, use the full name.
Capitalize the name as the product owners do in the product documentation.
Do not use abbreviations even if they're in common use, unless the product owner has sanctioned the abbreviation.
<div class="table-responsive">
<table class="table table-bordered">
@ -84,22 +78,20 @@ has sanctioned the abbreviation.
## Be consistent with punctuation
Use punctuation consistently within a page. For example, if you use a period
(full stop) after every item in list, then use a period on all other lists on
the page.
Use punctuation consistently within a page.
For example, if you use a period (full stop) after every item in list, then use a period on all other lists on the page.
Check the other pages if you're unsure about a particular convention.
Examples:
- Most pages in the Kubeflow docs use a period at the end of every list item.
- There is no period at the end of the page subtitle and the subtitle need not
be a full sentence. (The subtitle comes from the `description` in the front
matter of each page.)
- There is no period at the end of the page subtitle and the subtitle need not be a full sentence.
(The subtitle comes from the `description` in the front matter of each page.)
## Use active voice rather than passive voice
Passive voice is often confusing, as it's not clear who should perform the
action.
Passive voice is often confusing, as it's not clear who should perform the action.
<div class="table-responsive">
<table class="table table-bordered">
@ -124,8 +116,7 @@ action.
## Use simple present tense
Avoid future tense ("will") and complex syntax such as conjunctive mood
("would", "should").
Avoid future tense ("will") and complex syntax such as conjunctive mood ("would", "should").
<div class="table-responsive">
<table class="table table-bordered">
@ -150,21 +141,20 @@ Avoid future tense ("will") and complex syntax such as conjunctive mood
</table>
</div>
**Exception:** Use future tense if it's necessary to convey the correct
meaning. This requirement is rare.
**Exception:** Use future tense if it's necessary to convey the correct meaning. This requirement is rare.
## Address the audience directly
Using "we" in a sentence can be confusing, because the reader may not know
whether they're part of the "we" you're describing. For example, compare the
following two statements:
Using "we" in a sentence can be confusing, because the reader may not know whether they're part of the "we" you're describing.
For example, compare the following two statements:
- "In this release we've added many new features."
- "In this tutorial we build a flying saucer."
The words "the developer" or "the user" can be ambiguous. For example, if the
reader is building a product that also has users, then the reader does not
know whether you're referring to the reader or the users of their product.
The words "the developer" or "the user" can be ambiguous.
For example, if the reader is building a product that also has users,
then the reader does not know whether you're referring to the reader or the users of their product.
<div class="table-responsive">
<table class="table table-bordered">
@ -190,7 +180,7 @@ know whether you're referring to the reader or the users of their product.
## Use short, simple sentences
Keep sentences short. Short sentences are easier to read than long ones.
Keep sentences short. Short sentences are easier to read than long ones.
Below are some tips for writing short sentences.
<div class="table-responsive">
@ -278,8 +268,8 @@ Use `code style` for:
- inline code and commands
- object field names
Avoid using bold text or capital letters for emphasis. If a page has too much
textual highlighting it becomes confusing and even annoying.
Avoid using bold text or capital letters for emphasis.
If a page has too much textual highlighting it becomes confusing and even annoying.
## Use angle brackets for placeholders
@ -291,8 +281,8 @@ For example:
## Style your images
The Kubeflow docs recognise Bootstrap classes to style images and other content.
The following code snippet shows the typical styling that makes an
image show up nicely on the page:
The following code snippet shows the typical styling that makes an image show up nicely on the page:
```
<img src="/docs/images/my-image.png"
@ -300,25 +290,14 @@ image show up nicely on the page:
class="mt-3 mb-3 p-3 border border-info rounded">
```
To see some examples of styled images, take a look at the
[OAuth setup page](/docs/gke/deploy/oauth-setup/).
To see the markup, search for `.png` in the [page
source](https://raw.githubusercontent.com/kubeflow/website/master/content/en/docs/distributions/gke/deploy/oauth-setup.md).
To see some examples of styled images, take a look at the [OAuth setup page](/docs/gke/deploy/oauth-setup/).
For more help, see the guide to
[Bootstrap image styling](https://getbootstrap.com/docs/4.6/content/images/)
and the Bootstrap utilities, such as
[borders](https://getbootstrap.com/docs/4.6/utilities/borders/).
For more help, see the guide to [Bootstrap image styling](https://getbootstrap.com/docs/4.6/content/images/) and the Bootstrap utilities, such as [borders](https://getbootstrap.com/docs/4.6/utilities/borders/).
## A detailed style guide
The [Google Developer Documentation Style
Guide](https://developers.google.com/style/)
contains detailed information about specific aspects of writing clear, readable,
succinct documentation for a developer audience.
The [Google Developer Documentation Style Guide](https://developers.google.com/style/) contains detailed information about specific aspects of writing clear, readable, succinct documentation for a developer audience.
## Next steps
Take a look at the [documentation
README](https://github.com/kubeflow/website/blob/master/README.md) for
guidance on contributing to the Kubeflow docs.
- Take a look at the [documentation README](https://github.com/kubeflow/website/blob/master/README.md) for guidance on contributing to the Kubeflow docs.

View File

@ -1,96 +0,0 @@
+++
title = "Use Cases"
description = "Reasons for using Kubeflow"
weight = 1
aliases = ["/docs/", "/docs//", "/docs/usecases/"]
+++
The end goal of every organization that utilizes machine learning (ML) is to have
their ML models successfully run in production and generate value to the
business. But what does it take to reach that point?
Before a model ends up in production, there are potentially many steps required
to build and deploy an ML model: data loading, verification, splitting,
processing, feature engineering, model training and verification, hyperparameter
tuning, and model serving.
In addition, ML models can require more observation than traditional
applications, because your data inputs can drift over time. Manually rebuilding
models and data sets is time consuming and error prone.
To simplify these requirements and challenges, we created Kubeflow.
## Deploying and managing a complex ML system at scale
Kubeflow is a scalable, portable, distributed ML platform that runs on
Kubernetes. This means that all capabilities of Kubernetes are available to a
Kubeflow user. With Kubeflow, you can manage the entire AI organization at scale
and still be able to maintain the same quality of control.
Kubeflow and Kubernetes provide consistent and efficient operations and
optimized infrastructure. Your researchers can have more time to focus on the
valuable tasks of developing domain specific intellectual property rather than
debugging DevOps configuration issues.
Kubeflows core and ecosystem critical user journeys (CUJs) provide software
solutions for end-to-end workflows: build, train and deploy and/or develop a
model and create, run and explore a pipeline.
## Experimentation with training an ML model
Rapid experimentation is critical to building high quality machine learning
models quickly. Kubeflow offers a user-friendly interface (UI) that allows you
to track and compare experiments. You can decide later on which experiment was
the best and use it as a main source for your future steps.
In addition, Kubeflow 1.1 provides stable software sub-systems for model
training, such as Jupyter notebooks and popular ML training operators—
TensorFlow and PyTorch that run efficiently and securely in Kubernetes isolated
namespaces. The ML training operators simplify configuration and operations of
scaling ML training tasks.
Kubeflow has also delivered Critical User Journeys (CUJs), such as the build,
train and deploy, which provide end-to-end workflows that speed development.
You can read more about the CUJs in the Kubeflow roadmap.
## End to end hybrid and multi-cloud ML workloads
The development of ML models can require hybrid and multi-cloud portability and
secure sharing between teams, clusters and clouds. Kubeflow is supported
by all major cloud providers and available for on-premises installation.
If you need to develop on your laptop, train with GPU on your on-prem cluster
and serve in the cloud, Kubeflow provides the portability to support fast
experimentation, rapid training and robust deployment in the same or
different environments with minimal operational overhead.
## Tuning the model hyperparameters during training
During the model development part hyperparameters are often hard to tune.
Tuning hyperparameters is critical for model performance and accuracy.
Manually configuring hyperparameters is time consuming.
Kubeflows hyperparameter tuner (Katib) provides an automated way to match
your objectives. This automation can save days of model testing compute time
(freeing up valuable infrastructure), and speed the delivery of improved models.
## Continuous integration and deployment (CI/CD) for ML
Kubeflow currently doesnt have a dedicated tool for this purpose. But our users
have been using the Pipelines component and it worked really well for them.
Kubeflow Pipelines can be used to create reproducible workflows.
These workflows automate the steps needed to build a ML workflow,
which delivers consistency, saves iteration time, and helps in debugging,
auditability and compliance requirements.
## Next steps
See these docs for more information on the topics covered above:
- [Hyperparameter tuning with Katib](/docs/components/katib/)
- [Training models with operators](/docs/components/training/)
- [Get started with Pipelines](https://www.kubeflow.org/docs/components/pipelines/)
- [Jupyter notebooks](/docs/components/notebooks/)
- [Kubeflow roadmap](http://bit.ly/kf_roadmap)

View File

@ -7,7 +7,7 @@ weight = 40
{{% alert title="Opportunity to add cloud tutorials" color="info" %}}
<p><b>Invitation:</b> Create a cloud-specific tutorial and link it here.
See the <a href="/docs/about/docs/">guide to the Kubeflow docs</a>.</p>
See the <a href="/docs/about/style-guide/">style guide for the Kubeflow docs</a>.</p>
{{% /alert %}}
* [Pipelines End-to-end on Azure](/docs/azure/azureendtoend/): An end-to-end tutorial for Kubeflow Pipelines on Microsoft Azure.

View File

@ -26,8 +26,7 @@ Join the discussion on the
[#minikf](https://kubeflow.slack.com/messages/CGRKM3N0G/) Slack channel,
ask questions, request features, and get support for MiniKF.
To join the Kubeflow Slack workspace, please [request an
invite](https://kubeflow.slack.com/join/shared_invite/zt-cpr020z4-PfcAue_2nw67~iIDy7maAQ).
Refer to the [Community Slack Guide](/docs/about/community/#slack) for how to join the Kubeflow Slack workspace.
### System requirements
For a smooth experience we recommend that your system meets the

View File

@ -57,7 +57,7 @@ The following are the goals of the [Kubeflow Fairing project][fairing-repo]:
[kubeflow-notebooks]: /docs/components/notebooks/setup/
[ai-platform]: https://cloud.google.com/ml-engine/docs/
[fairing-repo]: https://github.com/kubeflow/fairing
[kubeflow]: /docs/about/kubeflow/
[kubeflow]: /docs/started/
[conf]: /docs/external-add-ons/fairing/configure-fairing/
[install]: /docs/external-add-ons/fairing/install-fairing/

View File

@ -164,7 +164,7 @@ Further information:
* KFServing:
* [Kubeflow documentation](/docs/components/kfserving/)
* [GitHub repository](https://github.com/kubeflow/kfserving)
* [Community](/docs/about/community/)
* [Kubeflow Community](/docs/about/community/)
* Seldon Core
* [Kubeflow documentation](/docs/external-add-ons/serving/seldon/)
* [Seldon Core documentation](https://docs.seldon.io/projects/seldon-core/en/latest/)

View File

@ -1,5 +1,5 @@
+++
title = "Getting Started"
description = "How to get started using Kubeflow."
description = "How to get started with Kubeflow"
weight = 20
+++

View File

@ -1,8 +1,7 @@
+++
title = "Kubeflow Overview"
description = "How Kubeflow helps you organize your ML workflow"
title = "Architecture"
description = "An overview of Kubeflow's architecture"
weight = 10
+++
<!--
@ -21,6 +20,7 @@ production-level serving.
## Conceptual overview
Kubeflow is *the ML toolkit for Kubernetes*.
The following diagram shows Kubeflow as a platform for arranging the
components of your ML system on top of Kubernetes:
@ -93,7 +93,7 @@ To learn more, read the following guides to the Kubeflow components:
[Jupyter notebooks](/docs/components/notebooks/). Use notebooks for interactive data
science and experimenting with ML workflows.
* [Kubeflow Pipelines](/docs/components/pipelines/introduction/) is a platform for
* [Kubeflow Pipelines](/docs/components/pipelines/) is a platform for
building, deploying, and managing multi-step ML workflows based on Docker
containers.
@ -144,5 +144,4 @@ sets of reference documentation:
## Next steps
See how to [install Kubeflow](/docs/started/getting-started/) depending on
your chosen environment (local, cloud, or on-premises).
* Follow [Installing Kubeflow](/docs/started/installing-kubeflow/) to set up your environment and install Kubeflow.

View File

@ -1,13 +1,13 @@
+++
title = "Installing Kubeflow"
description = "Overview of installation choices for Kubeflow"
description = "Deployment options for Kubeflow"
weight = 20
+++
Kubeflow is an end-to-end Machine Learning (ML) platform for Kubernetes, it provides components for each stage in the ML lifecycle, from exploration through to training and deployment.
Operators can choose what is best for their users, there is no requirement to deploy every component.
To read more about the components and architecture of Kubeflow, please see the <a href="/docs/started/kubeflow-overview/">Kubeflow Overview</a> page.
To read more about the components and architecture of Kubeflow, please see the <a href="/docs/started/architecture/">Kubeflow Architecture</a> page.
There are two pathways to get up and running with Kubeflow, you may either:
1. Use a [packaged distribution](#packaged-distributions)

View File

@ -1,9 +1,7 @@
+++
title = "Introduction to Kubeflow"
title = "Introduction"
description = "An introduction to Kubeflow"
weight = 1
aliases = ["/docs/", "/docs/about/", "/docs/kubeflow/"]
+++
The Kubeflow project is dedicated to making deployments of machine learning (ML)
@ -14,11 +12,11 @@ you are running Kubernetes, you should be able to run Kubeflow.
## Getting started with Kubeflow
Read the [Kubeflow overview](/docs/started/kubeflow-overview/) for an
introduction to the Kubeflow architecture and to see how you can use Kubeflow
Read the [architecture overview](/docs/started/architecture/) for an
introduction to the architecture of Kubeflow and to see how you can use Kubeflow
to manage your ML workflow.
Follow the [getting-started guide](/docs/started/getting-started/) to set up
Follow [Installing Kubeflow](/docs/started/installing-kubeflow/) to set up
your environment and install Kubeflow.
Watch the following video which provides an introduction to Kubeflow.
@ -27,7 +25,7 @@ Watch the following video which provides an introduction to Kubeflow.
## What is Kubeflow?
Kubeflow is _the machine learning toolkit for Kubernetes_. Learn about [Kubeflow use cases](/docs/about/use-cases/).
Kubeflow is _the machine learning toolkit for Kubernetes_.
To use Kubeflow, the basic workflow is:
@ -37,14 +35,16 @@ To use Kubeflow, the basic workflow is:
environment.
You can adapt the configuration to choose the platforms and services that you
want to use for each stage of the ML workflow: data preparation, model training,
prediction serving, and service management.
want to use for each stage of the ML workflow:
1. data preparation
2. model training,
3. prediction serving
4. service management
You can choose to deploy your Kubernetes workloads locally, on-premises, or to
a cloud environment.
Read the [Kubeflow overview](/docs/started/kubeflow-overview/) for more details.
## The Kubeflow mission
Our goal is to make scaling machine learning (ML) models and deploying them to
@ -68,7 +68,8 @@ configure based on the cluster it deploys into.
## History
Kubeflow started as an open sourcing of the way Google ran [TensorFlow](https://www.tensorflow.org/) internally, based on a pipeline called [TensorFlow Extended](https://www.tensorflow.org/tfx/). It began as just a simpler way to run TensorFlow jobs on Kubernetes, but has since expanded to be a multi-architecture, multi-cloud framework for running end-to-end machine learning workflows.
Kubeflow started as an open sourcing of the way Google ran [TensorFlow](https://www.tensorflow.org/) internally, based on a pipeline called [TensorFlow Extended](https://www.tensorflow.org/tfx/).
It began as just a simpler way to run TensorFlow jobs on Kubernetes, but has since expanded to be a multi-architecture, multi-cloud framework for running end-to-end machine learning workflows.
## Roadmaps
@ -80,11 +81,9 @@ The following components also have roadmaps:
- [KF Serving](https://github.com/kubeflow/kfserving/blob/master/ROADMAP.md)
- [Katib](https://github.com/kubeflow/katib/blob/master/ROADMAP.md)
- [Training Operator](https://github.com/kubeflow/common/blob/master/ROADMAP.md)
- [Kubeflow Notebooks](https://github.com/kubeflow/kubeflow/issues/5978)
## Getting involved
There are many ways to contribute to Kubeflow, and we welcome contributions!
Read the [contributor's guide](/docs/about/contributing) to get started on the
code, and get to know the community in the
[community guide](/docs/about/community).
Read the [contributor's guide](/docs/about/contributing/) to get started on the code, and learn about the community on the [community page](/docs/about/community/).

View File

@ -1,8 +1,7 @@
+++
title = "Examples"
description = "Examples that demonstrate machine learning with Kubeflow"
weight = 30
weight = 99
+++
{{% alert title="Warning" color="warning" %}}

View File

@ -1,7 +1,7 @@
+++
title = "Support"
description = "Where to go with questions and suggestions"
weight = 110
title = "Get Support"
description = "Where to get support for Kubeflow"
weight = 80
+++
This page describes the Kubeflow resources and support options that you can
@ -107,7 +107,7 @@ You can ask questions and make suggestions in the following places:
* **Slack** for online chat and messaging. See details of Kubeflow's
[Slack workspace and channels](/docs/about/community/#slack).
* **Kubeflow discuss** for email-based group discussion. Join the
[kubeflow-discuss](https://groups.google.com/forum/#!forum/kubeflow-discuss)
[kubeflow-discuss](/docs/about/community/#mailing-list)
group.
* **Kubeflow documentation** for overviews and how-to guides. In particular,
refer to the following documents when troubleshooting a problem: