Skip to content

Commit

Permalink
Apply Docs Restructure to v1.2-branch = update v1.2-branch to cur…
Browse files Browse the repository at this point in the history
…rent `master` v2 (#2612)

* Create "Distributions" with kfctl + Kubeflow Operator (#2492)

* Create methods folder == section

* Move /operator under /methods

* Update links on Operator

* Add 'kfctl' folder == section

* mv kfctl specific minikube docs under /kfctl

* Update links on minikube

* mv kustomize from other-guides to /kfctl

* fix links for kustomize change

* delete outdated redirect

* move istio-dex-auth to /kfctl + rename to multi-user

* fix links after name change

* move kfctl install under /kfctl + rename to deployment

* fix links after move

* Add OWNERS for accountability

Update kfctl description

Update content/en/docs/methods/_index.md

* Add redirects for Operator

* Add redirects for kfctl

* Rename "methods" to "distributions"

* update redirects to distributions as folder name

* doc: Add instructions to access cluster with IBM Cloud vpc-gen2. (#2530)

* doc, Add instructions to access cluster with IBM Cloud vpc-gen2.

* added extra steps.

* Improved formatting

* Added details for creating cluster against existing VPC

* Apply suggestions from code review

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Formatting fixes, as per the review.

* Added a note about security.

* Choose between a classic or vpc-gen2 provider.

* added a note

* formatting fixes

* Apply suggestions from code review

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Document split up.

* Cleanup.

* Apply suggestions from code review

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Tommy Li <Tommy.chaoping.li@ibm.com>

* Formatting improvements and cleanup.

* format fixes

* Apply suggestions from code review

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>
Co-authored-by: Tommy Li <Tommy.chaoping.li@ibm.com>

* Add RFMVasconcelos to OWNERS/approvers (#2539)

* Deletes old redirects - pages do not exist anymore (#2552)

* Move `AWS` platform under /distributions (#2551)

* move /aws under /distributions

* fix AWS redirects + add catch-all

* update broken link (#2557)

* UPDATE fix broken links to tensoflorw serving (#2558)

* Move `Google` platform under /distributions (#2547)

* move /gke folder to under /distributions

* update redirects

* Move `Azure` platform under /distributions (#2548)

* mv /azure to /distributions

* add catch-all azure to redirects

* KFP - Update Python function-based component doc with param naming rules (#2544)

* Describe pipeline param naming

Adds notes on how the KFP SDK updates param names to describe the data instead of the implementation. Updates passing data by value to indicate that users can pass lists and dictionaries.

* Update auto-gen Markdown 

Updates python-function-components.md with changes to python-function-components.ipynb.

* Move `Openshift` platform under /distributions (#2550)

* move /openshift to under /distributions

* add openshift catch-all to redirects

* Move `IBM` platform under /distributions (#2549)

* move /ibm to under /distributions

* Add IBM catch-all to redirects

* [IBM] Update openshift kubeflow installation (#2560)

* Make kfctl first distribution (#2562)

* Move getting started on K8s page to under kfctl distribution (#2569)

* mv overview to under kfctl

* delete empty getting started with k8s section

* Add redirect to catch traffic

* Update GCP distribution OWNERS (#2574)

* Update KFP shortcodes OWNERS (#2575)

* Move MicroK8s to distributions (#2577)

* create microk8s folder in distributions

* move microk8s docs to distributions

* update title

* Add redirect for MicroK8s move - missed on #2577 (#2579)

* Add Charmed Kubeflow Operators to list of available Kubeflow distributions (#2578)

* Uplevel clouds for a level playing field

* Add Owners + Index of Charmed Kubeflow

* Add install page to Charmed Kubeflow distribution

* Link to Charmed Kubeflow docs

* Naming corrections

* Update content/en/docs/distributions/charmed/install-kubeflow.md

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Update content/en/docs/distributions/charmed/install-kubeflow.md

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Update content/en/docs/distributions/charmed/install-kubeflow.md

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Update content/en/docs/distributions/charmed/install-kubeflow.md

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Update content/en/docs/distributions/charmed/install-kubeflow.md

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Update content/en/docs/distributions/charmed/install-kubeflow.md

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Update content/en/docs/distributions/charmed/install-kubeflow.md

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Update content/en/docs/distributions/charmed/install-kubeflow.md

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Update content/en/docs/distributions/charmed/install-kubeflow.md

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Update content/en/docs/distributions/charmed/install-kubeflow.md

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Update content/en/docs/distributions/charmed/install-kubeflow.md

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Update content/en/docs/distributions/charmed/install-kubeflow.md

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Update content/en/docs/distributions/charmed/install-kubeflow.md

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Update content/en/docs/distributions/charmed/install-kubeflow.md

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Update content/en/docs/distributions/charmed/install-kubeflow.md

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* final fixes

Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

* Fix broken link (#2581)

* IBM Cloud docs: update pipelines SDK setup for single-user (#2571)

Made the following changes to the instructions for setting
up the pipelines SDK for single-user.

* append '/pipeline' to the host string
* add client.list_experiments to make sure the setup is working,
consistent with the multi-user example in section 2
* add a note about KUBEFLOW_PUBLIC_ENDPOINT_URL since the user
may or may not have exposed the endpoint as a LoadBalancer

Signed-off-by: Chin Huang <chhuang@us.ibm.com>

* update broken links / tweak names (#2583)

* Move MiniKF to distributions (#2576)

* create minikf folde + index

* move minikf docs to minikf folder

* Add redirects for external links

* Change naming according to request

* update description minikf

* Clean up "Frameworks for training" + rename to "Training Operators" (#2584)

* Remove outdated banners from Pytorch and TF

* delete chainer

* order TF and pyT up

* rename "Frameworks for training" to "Training operators"

* Fix broken link (#2580)

* Remove "outdated" banners from MPI + MXnet operators (#2585)

* docs: Update MPI and MXNet operator pages (#2586)

Signed-off-by: terrytangyuan <terrytangyuan@gmail.com>

* Pin the version of kustomize, v4 is not supported. (#2572)

* Pin the version of kustomize, v4 is not supported.

There are issues installing Kubeflow with version v4. 

Note: 
#2570
https://github.com/kubeflow/kubeflow/issues/5755

* Add refrence to manifest repo version.

* Default to 3.2.0

* Update gke/anthos.md (#2591)

* fix broken link (#2603)

Co-authored-by: Prashant Sharma <prashsh1@in.ibm.com>
Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>
Co-authored-by: Tommy Li <Tommy.chaoping.li@ibm.com>
Co-authored-by: Mathew Wicks <thesuperzapper@users.noreply.github.com>
Co-authored-by: JohanWork <39947546+JohanWork@users.noreply.github.com>
Co-authored-by: Joe Liedtke <joeliedtke@google.com>
Co-authored-by: Mofizur Rahman <moficodes@gmail.com>
Co-authored-by: Yuan (Bob) Gong <4957653+Bobgy@users.noreply.github.com>
Co-authored-by: Chin Huang <chhuang@us.ibm.com>
Co-authored-by: brett koonce <koonce@gmail.com>
Co-authored-by: Yuan Tang <terrytangyuan@gmail.com>
Co-authored-by: drPytho <filip@voiapp.io>
Co-authored-by: Ihor Sychevskyi <arhell333@gmail.com>
  • Loading branch information
14 people committed Apr 20, 2021
1 parent 4dda8b2 commit 4e2602b
Show file tree
Hide file tree
Showing 144 changed files with 947 additions and 239 deletions.
7 changes: 3 additions & 4 deletions OWNERS
Expand Up @@ -2,16 +2,15 @@ approvers:
- animeshsingh
- Bobgy
- joeliedtke
- RFMVasconcelos
reviewers:
- 8bitmp3
- aronchick
- berndverst
- dansanche
- dsdinter
- Jeffwan
- jinchihe
- jinchihe
- nickchase
- pdmack
- RFMVasconcelos
- terrytangyuan

- terrytangyuan
55 changes: 41 additions & 14 deletions content/en/_redirects
Expand Up @@ -34,22 +34,22 @@
/docs/pipelines/tutorials/pipelines-tutorial/ /docs/components/pipelines/tutorials/cloud-tutorials/
/docs/gke/pipelines-tutorial/ /docs/components/pipelines/tutorials/cloud-tutorials/
/docs/gke/pipelines/pipelines-tutorial/ /docs/components/pipelines/tutorials/cloud-tutorials/
/docs/gke/authentication-pipelines/ /docs/gke/pipelines/authentication-pipelines/
/docs/gke/authentication-pipelines/ /docs/distributions/gke/pipelines/authentication-pipelines/

/docs/pipelines/metrics/ /docs/components/pipelines/sdk/pipelines-metrics/
/docs/pipelines/metrics/pipelines-metrics/ /docs/components/pipelines/sdk/pipelines-metrics/
/docs/pipelines/metrics/output-viewer/ /docs/components/pipelines/sdk/output-viewer/
/docs/pipelines/pipelines-overview/ /docs/components/pipelines/overview/pipelines-overview/
/docs/pipelines/enable-gpu-and-tpu/ /docs/gke/pipelines/enable-gpu-and-tpu/
/docs/pipelines/sdk/enable-gpu-and-tpu/ /docs/gke/pipelines/enable-gpu-and-tpu/
/docs/pipelines/sdk/gcp/enable-gpu-and-tpu/ /docs/gke/pipelines/enable-gpu-and-tpu/
/docs/pipelines/preemptible/ /docs/gke/pipelines/preemptible/
/docs/pipelines/sdk/gcp/preemptible/ /docs/gke/pipelines/preemptible/
/docs/pipelines/enable-gpu-and-tpu/ /docs/distributions/gke/pipelines/enable-gpu-and-tpu/
/docs/pipelines/sdk/enable-gpu-and-tpu/ /docs/distributions/gke/pipelines/enable-gpu-and-tpu/
/docs/pipelines/sdk/gcp/enable-gpu-and-tpu/ /docs/distributions/gke/pipelines/enable-gpu-and-tpu/
/docs/pipelines/preemptible/ /docs/distributions/gke/pipelines/preemptible/
/docs/pipelines/sdk/gcp/preemptible/ /docs/distributions/gke/pipelines/preemptible/
/docs/pipelines/reusable-components/ /docs/examples/shared-resources/
/docs/pipelines/sdk/reusable-components/ /docs/examples/shared-resources/

# Moved the guide to monitoring GKE deployments.
/docs/other-guides/monitoring/ /docs/gke/monitoring/
/docs/other-guides/monitoring/ /docs/distributions/gke/monitoring/

# Created a new section for pipeline concepts.
/docs/pipelines/pipelines-concepts/ /docs/components/pipelines/concepts/
Expand Down Expand Up @@ -88,24 +88,20 @@ docs/started/requirements/ /docs/started/getting-started/
# Restructured the getting-started and other-guides sections.
/docs/started/getting-started-k8s/ /docs/started/k8s/
/docs/started/getting-started-minikf/ /docs/started/workstation/getting-started-minikf/
/docs/started/getting-started-minikube/ /docs/started/workstation/minikube-linux/
/docs/started/getting-started-minikube/ /docs/started/distributions/kfctl/minikube/
/docs/other-guides/virtual-dev/getting-started-minikf/ /docs/started/workstation/getting-started-minikf/
/docs/started/getting-started-multipass/ /docs/started/workstation/getting-started-multipass/
/docs/other-guides/virtual-dev/getting-started-multipass/ /docs/started/workstation/getting-started-multipass/
/docs/other-guides/virtual-dev/ /docs/started/workstation/
/docs/started/getting-started-aws/ /docs/started/cloud/getting-started-aws/
/docs/started/getting-started-azure/ /docs/started/cloud/getting-started-azure/
/docs/started/getting-started-gke/ /docs/started/cloud/getting-started-gke/
/docs/started/getting-started-iks/ /docs/started/cloud/getting-started-iks/

/docs/use-cases/kubeflow-on-multinode-cluster/ /docs/other-guides/kubeflow-on-multinode-cluster/
/docs/use-cases/job-scheduling/ /docs/other-guides/job-scheduling/

# Remove Kubeflow installation on existing EKS cluster
/docs/aws/deploy/existing-cluster/ /docs/aws/deploy/install-kubeflow/
/docs/aws/deploy/existing-cluster/ /docs/distributions/aws/deploy/install-kubeflow/

# Move the kustomize guide to the config section
/docs/components/misc/kustomize/ /docs/other-guides/kustomize/
/docs/components/misc/kustomize/ /docs/distributions/kfctl/kustomize/

# Merged the UIs page with the new central dashboard page
/docs/other-guides/accessing-uis/ /docs/components/central-dash/overview/
Expand All @@ -116,16 +112,47 @@ docs/started/requirements/ /docs/started/getting-started/
# Rename TensorRT Inference Server to Triton Inference Server
/docs/components/serving/trtinferenceserver /docs/components/serving/tritoninferenceserver

# Kubeflow Operator move to under distributions
/docs/operator /docs/distributions/operator
/docs/operator/introduction /docs/distributions/operator/introduction
/docs/operator/install-operator /docs/distributions/operator/install-operator
/docs/operator/install-kubeflow /docs/distributions/operator/install-kubeflow
/docs/operator/uninstall-kubeflow /docs/distributions/operator/uninstall-kubeflow
/docs/operator/uninstall-operator /docs/distributions/operator/uninstall-operator
/docs/operator/troubleshooting /docs/distributions/operator/troubleshooting

# kfctl move to under distributions
/docs/started/workstation/minikube-linux /docs/distributions/kfctl/minikube
/docs/other-guides/kustomize /docs/distributions/kfctl/kustomize
/docs/started/k8s/kfctl-istio-dex /docs/distributions/kfctl/multi-user
/docs/started/k8s/kfctl-k8s-istio /docs/distributions/kfctl/deployment

# Moved Job scheduling under Training
/docs/other-guides/job-scheduling/ /docs/components/training/job-scheduling/

# Moved KFServing
/docs/components/serving/kfserving/ /docs/components/kfserving

# Moved MicroK8s to distributions
/docs/started/workstation/kubeflow-on-microk8s /docs/distributions/microk8s/kubeflow-on-microk8s

# Moved K8s deployment overview to under kfctl
/docs/started/k8s/overview /docs/distributions/kfctl/overview

# Moved MiniKF to distributions
/docs/started/workstation/getting-started-minikf /docs/distributions/getting-started-minikf
/docs/started/workstation/minikf-aws /docs/distributions/minikf-aws
/docs/started/workstation/minikf-gcp /docs/distributions/minikf-gcp

# ===============
# IMPORTANT NOTE:
# Catch-all redirects should be added at the end of this file as redirects happen from top to bottom
# ===============
/docs/guides/* /docs/:splat
/docs/pipelines/concepts/* /docs/components/pipelines/overview/concepts/:splat
/docs/pipelines/* /docs/components/pipelines/:splat
/docs/aws/* /docs/distributions/aws/:splat
/docs/azure/* /docs/distributions/azure/:splat
/docs/gke/* /docs/distributions/gke/:splat
/docs/ibm/* /docs/distributions/ibm/:splat
/docs/openshift/* /docs/distributions/openshift/:splat
2 changes: 1 addition & 1 deletion content/en/docs/components/central-dash/overview.md
Expand Up @@ -74,7 +74,7 @@ Port-forwarding typically does not work if any of the following are true:
with the [CLI deployment](/docs/gke/deploy/deploy-cli/). (If you want to
use port forwarding, you must deploy Kubeflow on an existing Kubernetes
cluster using the [`kfctl_k8s_istio`
configuration](/docs/started/k8s/kfctl-k8s-istio/).)
configuration](/docs/methods/kfctl/deployment).)

* You've configured the Istio ingress to only accept
HTTPS traffic on a specific domain or IP address.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/components/katib/experiment.md
Expand Up @@ -755,7 +755,7 @@ kubectl apply -f <your-path/your-experiment-config.yaml>
- (Optional) Katib's experiments don't work with
[Istio sidecar injection](https://istio.io/latest/docs/setup/additional-setup/sidecar-injection/#automatic-sidecar-injection).
If you install Kubeflow using
[Istio config](https://www.kubeflow.org/docs/started/k8s/kfctl-k8s-istio/),
[Istio config](https://www.kubeflow.org/docs/methods/kfctl/deployment),
you have to disable sidecar injection. To do that, specify this annotation:
`sidecar.istio.io/inject: "false"` in your experiment's trial template. For
examples on how to do it for `Job`, `TFJob` (TensorFlow) or
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/components/katib/hyperparameter.md
Expand Up @@ -141,7 +141,7 @@ an experiment using the random algorithm example:
1. (Optional) **Note:** Katib's experiments don't work with
[Istio sidecar injection](https://istio.io/latest/docs/setup/additional-setup/sidecar-injection/#automatic-sidecar-injection).
If you installed Kubeflow using
[Istio config](/docs/started/k8s/kfctl-k8s-istio/),
[Istio config](/docs/methods/kfctl/deployment),
you have to disable sidecar injection. To do that, specify this annotation:
`sidecar.istio.io/inject: "false"` in your experiment's trial template.

Expand Down Expand Up @@ -394,7 +394,7 @@ the Kubeflow's TensorFlow training job operator, TFJob:
1. (Optional) **Note:** Katib's experiments don't work with
[Istio sidecar injection](https://istio.io/latest/docs/setup/additional-setup/sidecar-injection/#automatic-sidecar-injection).
If you installed Kubeflow using
[Istio config](/docs/started/k8s/kfctl-k8s-istio/),
[Istio config](/docs/methods/kfctl/deployment),
you have to disable sidecar injection. To do that, specify this annotation:
`sidecar.istio.io/inject: "false"` in your experiment's trial template.
For the provided `TFJob` example check
Expand Down Expand Up @@ -438,7 +438,7 @@ using Kubeflow's PyTorch training job operator, PyTorchJob:
1. (Optional) **Note:** Katib's experiments don't work with
[Istio sidecar injection](https://istio.io/latest/docs/setup/additional-setup/sidecar-injection/#automatic-sidecar-injection).
If you installed Kubeflow using
[Istio config](/docs/started/k8s/kfctl-k8s-istio/),
[Istio config](/docs/methods/kfctl/deployment),
you have to disable sidecar injection. To do that, specify this annotation:
`sidecar.istio.io/inject: "false"` in your experiment's trial template.
For the provided `PyTorchJob` example setting the annotation should be similar to
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/components/katib/overview.md
Expand Up @@ -133,7 +133,7 @@ You can use the following interfaces to interact with Katib:

- **kfctl** is the Kubeflow CLI that you can use to install and configure
Kubeflow. Learn about kfctl in the guide to
[configuring Kubeflow](/docs/other-guides/kustomize/).
[configuring Kubeflow](/docs/methods/kfctl/kustomize/).

- The Kubernetes CLI, **kubectl**, is useful for running commands against your
Kubeflow cluster. Learn about kubectl in the [Kubernetes
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/components/multi-tenancy/design.md
Expand Up @@ -53,7 +53,7 @@ master should share the same identity management.

## Supported platforms
* Kubeflow multi-tenancy is enabled by default if you deploy Kubeflow on GCP with [IAP](/docs/gke/deploy).
* If you are not on GCP, you can deploy multi-tenancy to [your existing cluster](/docs/started/k8s/kfctl-istio-dex/).
* If you are not on GCP, you can deploy multi-tenancy to [your existing cluster](/docs/methods/kfctl/multi-user).

## Next steps

Expand Down
Expand Up @@ -56,7 +56,7 @@ A _pipeline component_ is a self-contained set of user code, packaged as a
performs one step in the pipeline. For example, a component can be responsible
for data preprocessing, data transformation, model training, and so on.

See the conceptual guides to [pipelines](/docs/components/pipelines/concepts/pipeline/)
See the conceptual guides to [pipelines](/docs/components/pipelines/overview/concepts/pipeline/)
and [components](/docs/components/pipelines/concepts/component/).

## Example of a pipeline
Expand Down
Expand Up @@ -5,7 +5,7 @@ weight = 140

+++

You can use the [KFP-Tekton SDK](https://github.com/kubeflow/kfp-tekton/sdk)
You can use the [KFP-Tekton SDK](https://github.com/kubeflow/kfp-tekton/tree/master/sdk)
to compile, upload and run your Kubeflow Pipeline DSL Python scripts on a
[Kubeflow Pipelines with Tekton backend](https://github.com/kubeflow/kfp-tekton/tree/master/tekton_kfp_guide.md).

Expand Down
Expand Up @@ -287,14 +287,55 @@
" storage service. Kubeflow Pipelines passes parameters to your component by\n",
" file, by passing their paths as a command-line argument.\n",
"\n",
"<a name=\"parameter-names\"></a>\n",
"#### Input and output parameter names\n",
"\n",
"When you use the Kubeflow Pipelines SDK to convert your Python function to a\n",
"pipeline component, the Kubeflow Pipelines SDK uses the function's interface\n",
"to define the interface of your component in the following ways.\n",
"\n",
"* Some arguments define input parameters.\n",
"* Some arguments define output parameters.\n",
"* The function's return value is used as an output parameter. If the return\n",
" value is a [`collections.namedtuple`][named-tuple], the named tuple is used\n",
" to return several small values. \n",
"\n",
"Since you can pass parameters between components as a value or as a path, the\n",
"Kubeflow Pipelines SDK removes common parameter suffixes that leak the\n",
"component's expected implementation. For example, a Python function-based\n",
"component that ingests data and outputs CSV data may have an output argument\n",
"that is defined as `csv_path: comp.OutputPath(str)`. In this case, the output\n",
"is the CSV data, not the path. So, the Kubeflow Pipelines SDK simplifies the\n",
"output name to `csv`.\n",
"\n",
"The Kubeflow Pipelines SDK uses the following rules to define the input and\n",
"output parameter names in your component's interface:\n",
"\n",
"* If the argument name ends with `_path` and the argument is annotated as an\n",
" [`kfp.components.InputPath`][input-path] or\n",
" [`kfp.components.OutputPath`][output-path], the parameter name is the\n",
" argument name with the trailing `_path` removed.\n",
"* If the argument name ends with `_file`, the parameter name is the argument\n",
" name with the trailing `_file` removed.\n",
"* If you return a single small value from your component using the `return`\n",
" statement, the output parameter is named `output`.\n",
"* If you return several small values from your component by returning a \n",
" [`collections.namedtuple`][named-tuple], the Kubeflow Pipelines SDK uses\n",
" the tuple's field names as the output parameter names. \n",
"\n",
"Otherwise, the Kubeflow Pipelines SDK uses the argument name as the parameter\n",
"name.\n",
"\n",
"<a name=\"pass-by-value\"></a>\n",
"#### Passing parameters by value\n",
"\n",
"Python function-based components make it easier to pass parameters between\n",
"components by value (such as numbers, booleans, and short strings), by letting\n",
"you define your component’s interface by annotating your Python function. The\n",
"supported types are `int`, `float`, `bool`, and `string`. If you do not\n",
"annotate your function, these input parameters are passed as strings.\n",
"supported types are `int`, `float`, `bool`, and `str`. You can also pass \n",
"`list` or `dict` instances by value, if they contain small values, such as\n",
"`int`, `float`, `bool`, or `str` values. If you do not annotate your function,\n",
"these input parameters are passed as strings.\n",
"\n",
"If your component returns multiple outputs by value, annotate your function\n",
"with the [`typing.NamedTuple`][named-tuple-hint] type hint and use the\n",
Expand All @@ -320,7 +361,9 @@
"[named-tuple-hint]: https://docs.python.org/3/library/typing.html#typing.NamedTuple\n",
"[named-tuple]: https://docs.python.org/3/library/collections.html#collections.namedtuple\n",
"[kfp-visualize]: https://www.kubeflow.org/docs/components/pipelines/sdk/output-viewer/\n",
"[kfp-metrics]: https://www.kubeflow.org/docs/components/pipelines/sdk/pipelines-metrics/"
"[kfp-metrics]: https://www.kubeflow.org/docs/components/pipelines/sdk/pipelines-metrics/\n",
"[input-path]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/kfp.components.html#kfp.components.InputPath\n",
"[output-path]: https://kubeflow-pipelines.readthedocs.io/en/latest/source/kfp.components.html#kfp.components.OutputPath"
]
},
{
Expand Down

0 comments on commit 4e2602b

Please sign in to comment.