Skip to content

Commit

Permalink
add and apply "not yet supported on KFP orchestrator" shortcode (#3516)
Browse files Browse the repository at this point in the history
  • Loading branch information
connor-mccarthy committed May 18, 2023
1 parent 136c878 commit 88361d5
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 0 deletions.
Expand Up @@ -32,6 +32,8 @@ def my_pipeline():

The [`dsl.ParallelFor`][dsl-parallelfor] context manager allows parallel execution of tasks over a static set of items. The context manager takes three arguments: a required `items`, an optional `parallelism`, and an optional `name`. `items` is the static set of items to loop over and `parallelism` is the maximum number of concurrent iterations permitted while executing the `dsl.ParallelFor` group. `parallelism=0` indicates unconstrained parallelism.

{{% oss-be-unsupported feature_name="Setting `parallelism`" gh_issue_link=https://github.com/kubeflow/pipelines/issues/8718 %}}

In the following pipeline, `train_model` will train a model for 1, 5, 10, and 25 epochs, with no more than two training tasks running at one time:

```python
Expand All @@ -46,6 +48,8 @@ def my_pipeline():
train_model(epochs=epochs)
```

{{% oss-be-unsupported feature_name="`dsl.Collected`" gh_issue_link=https://github.com/kubeflow/pipelines/issues/6161 %}}

Use [`dsl.Collected`](https://kubeflow-pipelines.readthedocs.io/en/latest/source/dsl.html#kfp.dsl.Collected) with `dsl.ParallelFor` to gather outputs from a parallel loop of tasks:

```python
Expand Down
Expand Up @@ -121,6 +121,8 @@ There several special values that may be used in this style, including:
* `dsl.PIPELINE_JOB_SCHEDULE_TIME_UTC_PLACEHOLDER`
* `dsl.PIPELINE_ROOT_PLACEHOLDER`

{{% oss-be-unsupported feature_name="`PIPELINE_JOB_CREATE_TIME_UTC_PLACEHOLDER`, `PIPELINE_JOB_SCHEDULE_TIME_UTC_PLACEHOLDER`, and `PIPELINE_ROOT_PLACEHOLDER`" gh_issue_link=https://github.com/kubeflow/pipelines/issues/6155 %}}

See the [KFP SDK DSL reference docs][dsl-reference-docs] for more information about the data provided by each special input.

### Task configurations
Expand Down Expand Up @@ -163,6 +165,8 @@ The KFP SDK provides the following task methods for setting task-level configura
* `.set_retry`
* `.ignore_upstream_failure`

{{% oss-be-unsupported feature_name="`.ignore_upstream_failure`" gh_issue_link=https://github.com/kubeflow/pipelines/issues/9459 %}}

See the [`PipelineTask` reference documentation][pipelinetask] for more information about these methods.

### Pipelines as components
Expand Down
5 changes: 5 additions & 0 deletions layouts/shortcodes/oss-be-unsupported.html
@@ -0,0 +1,5 @@
<div class="alert alert-warning" role="alert">
<h4 class="alert-heading">Not yet supported</h4>
{{ if .Get "feature_name"}} {{ with .Get "feature_name" }}
{{ . }} {{ end }} {{ else }}This feature {{ end }} is not yet supported by the KFP orchestration backend, but may be supported by other orchestration backends.{{ if .Get "feature_name"}} {{ with .Get "gh_issue_link" }} You can track support for this feature via the <a href="{{ . | safeURL }}">GitHub issue</a></h4>. {{ end }} {{ else }} {{ end }}
</div>

0 comments on commit 88361d5

Please sign in to comment.