Add model card to a Repository
The model-card.md can be used to provide details about the model such as the intended use, and libraries and datasets used. Provide the model-card.md in the root of your Repository (or the selected contract folder via the contractPath attribute), like the structure below.
repository (or contract path)
|__ model-card.md
...
There are various templates available for model cards. Deeploy does not impose a specific template, allowing you to choose the one that best suits your needs. To assist you in making a choice, we have compiled some resources to guide you in the right direction, among which our Deeploy Model Card template:
- Deeploy Model Card Template
- Kaggle tutorial on creating model cards
- HuggingFace model cards writing tool.
Examples of model cards: