Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(kfp): compatibility matrix with TFX #2893

Merged
merged 10 commits into from
Aug 27, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
8 changes: 4 additions & 4 deletions content/en/docs/components/pipelines/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ description = "Finding and fixing problems in your Kubeflow Pipelines deployment
weight = 65

+++
{{% alert title="Out of date" color="warning" %}}
This guide contains outdated information pertaining to Kubeflow 1.0. This guide
needs to be updated for Kubeflow 1.1.
{{% /alert %}}

This page presents some hints for troubleshooting specific problems that you
may encounter.
Expand Down Expand Up @@ -89,3 +85,7 @@ You can resolve this issue by using one of the following options:
Then restart your terminal session or run `source ~/.bashrc`.
* Run the `kfp` and `dsl-compile` commands as `~/.local/bin/kfp` and
`~/.local/bin/dsl-compile`.

## TFX visualizations do not show up or throw an error

Confirm your Kubeflow Pipelines backend version is compatible with your TFX version, refer to [Kubeflow Pipelines Compatibility Matrix](/docs/components/pipelines/installation/compatibility-matrix/).