Add a model card

#Model card

Model card is a README.md file that accompanies the model to describe handy information with additional model metadata. Under the hood, a Model card is associated with every model instance of a model. It is an crucial for reproducibility, sharing and discoverability. We highly recommend adding a model card README.md file when preparing your model used in VDP.

In a model card, you can provide information about:

  • the model itself
  • its use cases and limitations
  • the datasets used to train the model
  • the training experiments and configuration
  • benchmarking and evaluation results
  • reference materials

After importing a model into VDP, the model card will be rendered in the Console on the Model page. Here shows a model card example of a model imported from a GitHub repository model-mobilenetv2.

Model card in VDP Console

INFO

Try our Import GitHub models guideline to import a model from GitHub

#Model card metadata

You can insert Front Matter in a model card to define the model metadata. Start with three --- at the top, then include all the metadata and close the section with --- like the example below.

README.md
Copy

---
Task: "any VDP supported CV Task valid identifier"
Tags:
- tag1
- tag2
- tag3
---

#Specify a CV Task

TIP

Technically, you can assign different CV Task to model instances of the same model. However, this is strongly discouraged. Model instances of a model should be designed to solve the same CV Task.

When importing the model, VDP will detect the Task in the model card and verify if output of the model fulfils the CV Task requirements. If the model is verified, VDP will automatically convert the model output into format of the corresponding standardised CV Task format whenever using the model. Please check the supported standarised CV Tasks and the corresponding output format for each task.

image-classification
object-detection
keypoint-detection
Copy

Task: Classification

If not specified, the model will be recognised with Unspecified CV Task, and the raw model output will be wrapped in a standard format.

❓ How to know if the CV Task metadata is correctly recognised?

If you include valid CV Task metadata, they will show on the Model page of the Console like this:

Model CV Task label in VDP Console

Last updated: 8/15/2022, 8:15:31 AM