-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
A brief release announcement/note for KFP 1.0 (#4059)
* enable pagination when expanding experiment in both the home page and the archive page * Revert "enable pagination when expanding experiment in both the home page and the archive page" This reverts commit 5b67273. * checkpoint * Revert "checkpoint" This reverts commit 3b17699. * Add a brief kfp 1.0 note, with pointers to our detailed docs * have separate versioning policy file; have more links * partially addressed comments * address comments * address comments * fix a link * fix alpha, beta * address comments
- Loading branch information
1 parent
2f94827
commit 48f3075
Showing
2 changed files
with
94 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Kubeflow Pipelines 1.0 Release Notes | ||
|
|
||
| ## Versioning policy | ||
|
|
||
| Kubeflow Pipelines 1.0 is the first major release of Kubeflow Pipelines. It follows the Kubeflow Pipelines [versioning policy](https://github.com/kubeflow/pipelines/blob/master/docs/releases/versioning-policy.md#kubeflow-pipelines-versioning). | ||
|
|
||
| ## Deployment options | ||
|
|
||
| There are two available ways to [deployment Kubeflow Pipelines](https://www.kubeflow.org/docs/pipelines/installation/overview/). | ||
|
|
||
| * [Standalone Kubeflow Pipelines](https://www.kubeflow.org/docs/pipelines/installation/standalone-deployment/), which allows users the maximum flexibility in configuring the Kubernetes clusters and a Kubeflow Pipelines instance. | ||
|
|
||
| * [AI Platform Pipelines](https://cloud.google.com/ai-platform/pipelines/docs), which minimizes the user effort in deploying a Kubeflow pipelines instance. | ||
|
|
||
| * Note: as of 2020-06-30, the Kubeflow Pipelines 1.0 instance is not available in [the Kubeflow deployment](https://www.kubeflow.org/docs/pipelines/installation/overview/#full-kubeflow) yet. Please use the above two ways | ||
| to deploy the Kubeflow Pipelines 1.0 instance. | ||
|
|
||
| ## Features | ||
|
|
||
| // TODO: make the following link pointing to the file at a particular commit. | ||
|
|
||
| Refer to [the detailed status of Kubeflow Pipelines 1.0 features](https://github.com/kubeflow/pipelines/blob/master/docs/releases/versioning-policy.md#kubeflow-pipelines-feature-status). | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| # Kubeflow Pipelines Versioning | ||
|
|
||
| The Kubeflow Pipelines versioning follows the [semantic versioning policy](https://semver.org/). The Kubeflow Pipelines versions are in the format of X.Y.Z, where X is the major version, Y is the minor version, and Z is the patch version. The major version is incremented for API/feature changes that are new and not backward-compatible; the minor version is incremented for API/feature changes that are new and backward-compatible; and the patch version is for bug fixes between two minor versions. The Kubeflow Pipelines X.Y.Z refers to the version (git tag) of the released Kubeflow Pipelines and it versions all servers and the SDK of the Kubeflow Pipelines. Moreover, if the version number includes an appendix -rcN, where N is a number, the appendix indicates a release candidate, which is a pre-release version of an upcoming release. | ||
|
|
||
| # Kubeflow Pipelines Feature Status | ||
|
|
||
| The features in Kubeflow Pipelines fall into three different phases: general availability, | ||
| alpha and beta. | ||
|
|
||
| - The features in the general availability phase are stable and have active support for bug fixes. | ||
| - The features in beta phase are mostly stable. On a case-by-case basis, they will either | ||
| stay in the maintenance mode or be promoted to general availability in the future. | ||
| - The features in alpha phase are complete but haven't been tested extensively. They are subject to | ||
| future deprecation. | ||
|
|
||
| ## Features in general availability | ||
|
|
||
| ### APIs | ||
|
|
||
| | | Upload | Create | Get | List | Delete | Archive | Unarchive | Enable | Disable | Terminate | Retry | | ||
| |:----------------:|:------:|:------:|:---:|:----:|:------:|:-------:|:---------:|:------:|:-------:|:---------:|:-----:| | ||
| | Pipeline | - [x] | - [x] |- [x]|- [x] | - [x] | | | | ||
| | Pipeline Version | - [x] | - [x] |- [x]|- [x] | - [x] | | | | ||
| | Run | | - [x] |- [x]|- [x] | - [x] | - [x] | - [x] | | | - [x] | - [x] | | ||
| | Experiment | | - [x] |- [x]|- [x] | - [x] | - [x] | - [x] | | ||
|
|
||
| * Refer to the Kubeflow Pipelines [introduction]((https://www.kubeflow.org/docs/pipelines/overview/)) for | ||
| - An [overview](https://www.kubeflow.org/docs/pipelines/overview/pipelines-overview/) and [main concepts](https://www.kubeflow.org/docs/pipelines/overview/concepts/), for example, what is a pipeline or run in Kubeflow Pipelines. | ||
| - How to manage the Kubeflow Pipelines resources via the the [Kubeflow Pipelines UI](https://www.kubeflow.org/docs/pipelines/overview/interfaces/). | ||
| * Refer to the Kubeflow Pipelines [SDK samples and tutorials](https://www.kubeflow.org/docs/pipelines/tutorials/sdk-examples/) | ||
| for how to manage the Kubeflow Pipelines resources via the Kubeflow Pipelines client. | ||
| * A complete API method list and a detailed description of parameters to those API methods are available at the Kubeflow Pipelines [API reference](https://www.kubeflow.org/docs/pipelines/reference/api/kubeflow-pipeline-api-spec/). | ||
|
|
||
| ### SDK | ||
|
|
||
| * Only [ComponentSpec](https://github.com/kubeflow/pipelines/blob/master/sdk/python/kfp/components/structures/components.json_schema.json) in SDK is in general availability phase. | ||
|
|
||
| ## Features in Beta | ||
|
|
||
| * Job API | ||
|
|
||
| | | Upload | Create | Get | List | Delete | Archive | Unarchive | Enable | Disable | Terminate | Retry | | ||
| |:----------------:|:------:|:------:|:---:|:----:|:------:|:-------:|:---------:|:------:|:-------:|:---------:|:-----:| | ||
| | Job | | - [x] |- [x]|- [x] | - [x] | | | - [x] | - [x] | | ||
|
|
||
|
|
||
| * SDK DSL | ||
|
|
||
| * [Upgrade/Reinstall the Kubeflow Pipelines instance](https://www.kubeflow.org/docs/pipelines/upgrade/). | ||
|
|
||
| * [Built-in visualization of selected artifact types](https://www.kubeflow.org/docs/pipelines/sdk/output-viewer/). | ||
|
|
||
|
|
||
| ## Features in Alpha | ||
|
|
||
| * SDK client (that is, the helper functions). The helper functions mainly rely | ||
| on community maintenance. The recommended alternatives are the auto-generated | ||
| client APIs, for example, client.pipelines.list_pipelines(), | ||
| client.runs.list_runs(), client.pipeline_uploads.upload_pipeline(). Refer to | ||
| [more samples](https://www.kubeflow.org/docs/pipelines/tutorials/sdk-examples/) | ||
| on how to use them. | ||
|
|
||
| * [Python based custom visualization](https://www.kubeflow.org/docs/pipelines/sdk/python-based-visualizations/). | ||
|
|
||
| * [Step caching](https://www.kubeflow.org/docs/pipelines/caching/). | ||
|
|
||
| // TODO: lineage explorer and multi-tenant support | ||
|
|
||
|
|
||
|
|
||
|
|