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

Model Card Component to generate reports about pushed models #82

Open
hanneshapke opened this issue Sep 29, 2021 · 2 comments
Open

Model Card Component to generate reports about pushed models #82

hanneshapke opened this issue Sep 29, 2021 · 2 comments

Comments

@hanneshapke
Copy link
Contributor

Expected Component Behavior

The purpose of this component is to use schemaGen and StatisticsGen output and generate an html version of a model card for the produced model version after the model was pushed to its destination.

The component is acting as a wrapper for model_card_toolkit.ModelCardToolkit.
Key parameters for ModelCardToolkit like model_card.model_parameters.data.train.graphics.description, model_card.model_parameters.data.eval.graphics.description, and/or model_card.quantitative_analysis.graphics.description are passed to the component as args as they won't change between pipeline runs.

ModelCardToolkit connects with the MLMD for dynamic information like data statistics. With all information about the pipeline run, ModelCardToolkit generates an html page (based on mct.export_format() and tf.io.write_file) and then saves the html page to a provided path and registers the component output with the MLMD.

A component stub based on TFX 0.2X exists and could be used as a starting point.

  • Model cards [link]
@shuklak13
Copy link
Contributor

Hi Hannes. It was great meeting with you last week! I've put together a design proposal for the project below. Would love to get your input on this.

https://docs.google.com/document/d/12RaFDQqkOpeWVvZfJo1s1-HKCW0nupJGQxTSWBdZLi0/edit?usp=sharing&resourcekey=0-0g2JkX-m-NJPy8xwNvBR5Q

@hanneshapke
Copy link
Contributor Author

Hi @shuklak13, Thank you for sharing the detailed design doc.
I left a few comments in the design doc. Happy to chat more about it if you like. Sync or async.

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

No branches or pull requests

3 participants