Skip to content

Commit 7e539da

Browse files
egrace479hlapp
andauthored
Add API accessible description key to HF templates (#18)
* Ref #15, with explanation of utility for API-using apps --------- Co-authored-by: Hilmar Lapp <[email protected]>
1 parent 076be13 commit 7e539da

File tree

4 files changed

+4
-0
lines changed

4 files changed

+4
-0
lines changed

docs/wiki-guide/HF_DatasetCard_Template_ABC.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ tags:
1010
- animals
1111
- CV
1212
size_categories: # ex: n<1K, 1K<n<10K, 10K<n<100K, 100K<n<1M, ...
13+
description: # Add a short description (summary) of your dataset, this will render as part of the CardData object through the API
1314
---
1415

1516
<!--

docs/wiki-guide/HF_DatasetCard_Template_Imageomics.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ tags:
1010
- animals
1111
- CV
1212
size_categories: # ex: n<1K, 1K<n<10K, 10K<n<100K, 100K<n<1M, ...
13+
description: # Add a short description (summary) of your dataset, this will render as part of the CardData object through the API, which can thus be used in applications such as the Imageomics Catalog
1314
---
1415

1516
<!--

docs/wiki-guide/HF_ModelCard_Template_ABC.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ tags:
1010
- animals
1111
datasets: # Adds link if on HF & shows up on sidebar. Ex: Imageomics/TreeOfLife-10M
1212
metrics: # key list: https://hf.co/metrics
13+
model_description: # Add a short description (summary) of your model, this will render as part of the CardData object through the API
1314
---
1415

1516
<!--

docs/wiki-guide/HF_ModelCard_Template_Imageomics.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ tags:
1010
- animals
1111
datasets: # Adds link if on HF & shows up on sidebar. Ex: imageomics/TreeOfLife-10M
1212
metrics: # key list: https://hf.co/metrics
13+
model_description: # Add a short description (summary) of your model, this will render as part of the CardData object through the API, which can thus be used in applications such as the Imageomics Catalog
1314
---
1415

1516
<!--

0 commit comments

Comments
 (0)