-
Notifications
You must be signed in to change notification settings - Fork 775
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(kfp): compatibility matrix with TFX (#2893)
* docs(kfp): compatibility matrix with TFX * address feedback * update * second version * update * reformat table * fix format * update troubleshooting doc * address feedback again * improve format
- Loading branch information
Showing
2 changed files
with
39 additions
and
4 deletions.
There are no files selected for viewing
35 changes: 35 additions & 0 deletions
35
content/en/docs/components/pipelines/installation/compatibility-matrix.md
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,35 @@ | ||
+++ | ||
title = "Compatibility Matrix" | ||
description = "Kubeflow Pipelines compatibility matrix with TensorFlow Extended (TFX)" | ||
weight = 50 | ||
+++ | ||
|
||
## Kubeflow Pipelines Backend and TFX compatibility | ||
|
||
Pipelines written in any version of [TensorFlow Extended (TFX)](https://www.tensorflow.org/tfx) will execute on any version of Kubeflow Pipelines (KFP) backend. However, some UI features may not be functioning properly if the TFX and Kubeflow Pipelines Backend versions are not compatible. | ||
|
||
The following table shows UI feature compatibility for TFX and Kubeflow Pipelines Backend versions: | ||
|
||
| [TFX] \ [KFP Backend] | [KFP Backend] <= 1.5 | [KFP Backend] >= 1.7 | | ||
| --------------------- | ------------------------------------------------- | ---------------------------------------------- | | ||
| [TFX] <= 0.28.0 | Fully Compatible ✅ | Metadata UI not compatible<sup>[2](#fn2)</sup> | | ||
| [TFX] 0.29.0, 0.30.0 | Visualizations not compatible<sup>[1](#fn1)</sup> | Metadata UI not compatible<sup>[2](#fn2)</sup> | | ||
| [TFX] 1.0.0 | Metadata UI not compatible<sup>[2](#fn2)</sup> | Metadata UI not compatible<sup>[2](#fn2)</sup> | | ||
| [TFX] >= 1.2.0 | Metadata UI not compatible<sup>[2](#fn2)</sup> | Fully Compatible ✅ | | ||
|
||
Detailed explanations: | ||
|
||
<a name="fn1">1.</a> **Visualizations not compatible**: Kubeflow Pipelines UI and TFDV, TFMA visualizations is not compatible. Visualizations throw an error in Kubeflow Pipelines UI. | ||
|
||
<a name="fn2">2.</a> **Metadata UI not compatible**: Kubeflow Pipelines UI and TFX recorded ML Metadata is not compatible. ML Metadata tab in run details page shows error message "Corresponding ML Metadata not found". As a result, visualizations based on ML Metadata do not show up in visualizations tab either. | ||
|
||
<!-- | ||
Issues that caused the incompatibilities: | ||
* TFX 1.0.0+ | ||
* https://github.com/kubeflow/pipelines/issues/6138#issuecomment-898190223 | ||
* https://github.com/kubeflow/pipelines/issues/6138#issuecomment-899917056 | ||
* TFX 0.29.0 https://github.com/tensorflow/tfx/issues/3933 | ||
--> | ||
|
||
[TFX]: https://github.com/tensorflow/tfx/releases | ||
[KFP Backend]: https://github.com/kubeflow/pipelines/releases |
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