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

Support ModelCardGenerator in Vertex AI #260

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jeongukjae
Copy link
Contributor

@jeongukjae jeongukjae commented Jul 25, 2023

Fixes #259

Changes the ModelCard artifact's TYPE_NAME from "ModelCard" to "tfx_addons.ModelCard" to conform with the Kubeflow V2 schema.

For detailed descriptions of the changes, check out this comment.

In v1.12, there are another errors.

ModelCard artifact does not satisfy the schema title regex (^[a-z][a-z0-9-_]{2,20}[.][A-Z][a-zA-Z0-9-_]{2,49}$, no nested classpath). So ModelCard artifact's TYPE_NAME should be updated.

https://github.com/tensorflow/tfx/blob/2fd4f95ce3e631e7763611fd8ed631d59bc053d8/tfx/orchestration/kubeflow/v2/compiler_utils.py#L302-L335

ModelCard artifact type should be accessible from tfx_addons (top-level module) to be resolved in kubeflow v2's container entrypoint. So tfx-addons should export all artifact types from top-level.

https://github.com/tensorflow/tfx/blob/2fd4f95ce3e631e7763611fd8ed631d59bc053d8/tfx/orchestration/kubeflow/v2/container/kubeflow_v2_entrypoint_utils.py#L219-L234

  • Tests pass
  • Appropriate changes to README are included in PR

@github-actions
Copy link
Contributor

Thanks for the PR! 🚀

Instructions: Approve using /lgtm and mark for automatic merge by using /merge.

@jeongukjae jeongukjae marked this pull request as ready for review July 25, 2023 08:57
@codesue
Copy link
Contributor

codesue commented Jul 26, 2023

Thank you for your contribution, @jeongukjae! Does this pull request introduce any breaking changes?

@hanneshapke, would this resolve your errors in #249?

@jeongukjae
Copy link
Contributor Author

@codesue It's changing the artifact's type, so I think this is a breaking change 🤔 but a small change I think?

@codesue
Copy link
Contributor

codesue commented Jul 27, 2023

It's been a while since I've worked directly with artifacts, so this gave me pause, but it does seem like a small change. We can point people back to this PR if they run into problems, so let's update the description of this PR to also include a brief summary of the changes. Something like

Changes the ModelCard artifact's TYPE_NAME from "ModelCard" to "tfx_addons.ModelCard" to conform with the Kubeflow V2 schema.

Otherwise this LGTM from the ModelCardGenerator side with passing tests.

@jeongukjae
Copy link
Contributor Author

@codesue Great. I updated the PR body!

@codesue
Copy link
Contributor

codesue commented Aug 22, 2023

Hi @rcrowe-google or @casassg, would you please take a look at this PR since Hannes is currently unavailable. 🙏

Copy link
Collaborator

@rcrowe-google rcrowe-google left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes look ok to me, based on my limited knowledge of this code. However I'm not listed as an owner so I don't think I can actually approve this for merging:

Missing approvals for PR. Potential owners: @casassg, @hanneshapke, @codesue, @deutranium, @wihanbooyse, and @BACtaki

@casassg
Copy link
Member

casassg commented Aug 23, 2023

/lgtm

A suggestion: move artifact to a separate file similar to how we have for pkgs so that it avoids triggering all CI

@github-actions
Copy link
Contributor

Approval received from @casassg! ✅

PR is approved. Missing merge command to auto-merge PR!

@casassg
Copy link
Member

casassg commented Aug 23, 2023

Feel free to comment / merge to merge btw

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ModelCardGenerator component cannot run in Vertex AI
4 participants