-
Notifications
You must be signed in to change notification settings - Fork 775
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
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
1ccc2fd
docs(kfp): compatibility matrix with TFX
Bobgy 31af7b1
address feedback
Bobgy f73d4e7
update
Bobgy e571c43
second version
Bobgy 1b9031f
update
Bobgy ddcebf7
reformat table
Bobgy dce5ca1
fix format
Bobgy 948b836
update troubleshooting doc
Bobgy 9ed9974
address feedback again
Bobgy dcac7b6
improve format
Bobgy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
14 changes: 14 additions & 0 deletions
14
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,14 @@ | ||
| +++ | ||
| title = "Compatibility Matrix" | ||
| description = "Kubeflow Pipelines compatibility matrix with related software" | ||
| weight = 50 | ||
| +++ | ||
|
|
||
| ## Kubeflow Pipelines Backend and TFX compatibility | ||
|
|
||
| | Kubeflow Pipelines Backend & [TFX](https://www.tensorflow.org/tfx) Version | <=0.30.0 | 1.0.0 | 1.2.0 | | ||
| | ---- | ---- | ---- | --- | | ||
| | <=1.6 | Compatible | Not fully compatible[1] | Not fully compatible[1]️ | | ||
| | >=1.7 | Not fully compatible[1] | Not fully compatible[1] | Compatible | | ||
|
|
||
| [1] Kubeflow Pipelines UI integration with TFDV, TFMA visualizations and ML Metadata does not work properly. Because of [a bug in TFX 1.0.0](https://github.com/kubeflow/pipelines/issues/6138#issuecomment-899917056), TFX 1.0.0 does not work with any Kubeflow Pipelines backend versions. Besides UI integration, any version of TFX runs on Kubeflow Pipelines. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it possible to add HTML to DOCSY?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, that's possible too. Let think take a look
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I decided to not do this, because
I ended up writing the top left cell as "TFX \ KFP Backend", which I think also conveys the information very well with minimal overhead. What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good, agree with the points you have mentioned.
One thing I would like to say is that we probably want to put the TFX to each row along with the version.
So it is like:
I imagine this matrix to expand in the future, so each row might mean different dependencies, so putting dependency name and version closer to each other helps readability. For example the future will look like :
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the suggestion!
I was planning to add a different table for each dependency, because as you can see there have to be some paragraphs introducing general information about KFP and this dependency.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good on having different tables, thank you Yuan!