docs(kfp): compatibility matrix with TFX #2893
Conversation
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Bobgy The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
|
||
| ## 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 | |
There was a problem hiding this comment.
Is it possible to add HTML to DOCSY?
| 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 |
There was a problem hiding this comment.
Yes, that's possible too. Let think take a look
There was a problem hiding this comment.
I decided to not do this, because
- the empty block under "Kubeflow Pipelines Backend" also looks a little ugly
- maintainability of html is worse than markdown
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.
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:
| [KFP Backend] | <= 1.5 | >= 1.7 |
|---|---|---|
| TFX <= 0.28.0 | Fully Compatible ✅ | Metadata UI not compatible |
| TFX 0.29.0, 0.30.0 | Visualizations not compatible | Metadata UI not compatible |
| TFX 1.0.0 | Metadata UI not compatible | Metadata UI not compatible |
| TFX >= 1.2.0 | Metadata UI not compatible | Fully Compatible ✅ |
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 :
| [KFP Backend] | <= 1.5 | >= 1.7 |
|---|---|---|
| TFX <= 0.28.0 | Fully Compatible ✅ | Metadata UI not compatible |
| TFX 0.29.0, 0.30.0 | Visualizations not compatible | Metadata UI not compatible |
| TFX 1.0.0 | Metadata UI not compatible | Metadata UI not compatible |
| TFX >= 1.2.0 | Metadata UI not compatible | Fully Compatible ✅ |
| TFDA 0.X.X | compatible | compatible |
| TFMA 0.X.X | compatible | compatible |
| TFMA > 1.0.0 | compatible | compatible |
| PyTorch 0.X.X | compatible | compatible |
| PyTorch >= 1.0.0 | compatible | Compatible |
There was a problem hiding this comment.
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.
Sounds good on having different tables, thank you Yuan!
|
I don't think this convey's the information in sufficient depth. How about this. Let's have the the table be for KFP 1.7 On the Rows list the following features:
Then for the columns go with <= 0.30.0, 1.0.0, and 1.2.0 In the cells you can specify for TFDV and TFMA that visualizations don't work |
|
@kramachandran Good point for adding more information! I forgot to cover information for tensorflow/tfx#3933. However, for the specific format, I don't quite want to build one table for one KFP version, because it's harder to find compatible pairs in one entire table. I'll try to use different foot notes to make the information more complete. Let me have another update and you can confirm again. |
|
A lot of new comments come from #2895. |
Part of kubeflow/pipelines#6138
Preview: https://deploy-preview-2893--competent-brattain-de2d6d.netlify.app/docs/components/pipelines/installation/compatibility-matrix/