Add data card to a Repository
A data card, also known as a dataset card or a datasheet, is a form of documentation for a dataset. Dataset cards offer users a comprehensive view of a dataset's contents, its intended use, its creation process, and any other information users should consider when using the dataset to train or evaluate models.
To add a data card to a Deployments, provide a data-card.md
file in the root of your Repository (or the selected contract folder via the contractPath
attribute), like the structure below:
repository (or contract path)
|__ data-card.md
...
There are various templates available for data 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.
Examples of data cards: