[depends on #280] Add method for rendering model cards #281
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.
What does this pull request do?
Adds a method for rendering model cards. This allows you to render a model card by calling
model_card.render()
without first having to first create aModelCardToolkit
object and scaffold assets (which copies default template files and creates a model card proto). Additionally, saving the rendered model card document to a file is optional with this method.Current usage:
With this change:
Relates to #276.
How did you test this change?
Added unit tests and ran
pytest model_card_toolkit
.Example notebook: https://colab.research.google.com/gist/codesue/e315e2d79d564ed60a454b8509ca3c31/dev.ipynb
How did you document this change?
Docstrings
Before submitting
Before submitting a pull request, please be sure to do the following: