Skip to content

Commit d1c1368

Browse files
committed
Ref #25: update model & data cards
Ref #16: added dataset and model cards from ABC Ref #16: added collapsible widgets and download links for dataset & model cards
1 parent bb26085 commit d1c1368

File tree

4 files changed

+38
-6
lines changed

4 files changed

+38
-6
lines changed

docs/wiki-guide/HF_DatasetCard_Template_ABC.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ NOTE: Add more tags (your particular animal, type of model and use-case, etc.).
1818
1919
As with your GitHub Project repo, it is important to choose an appropriate license for your dataset. The default license is [CC0](https://creativecommons.org/publicdomain/zero/1.0/) (public domain dedication, see [Dryad's explanation of why to use CC0](https://blog.datadryad.org/2023/05/30/good-data-practices-removing-barriers-to-data-reuse-with-cc0-licensing/)). Alongside the appropriate stakeholders (eg., your PI, co-authors), select a license that is [Open Source Initiative](https://opensource.org/licenses) (OSI) compliant.
2020
For more information on how to choose a license and why it matters, see [Choose A License](https://choosealicense.com) and [A Quick Guide to Software Licensing for the Scientist-Programmer](https://doi.org/10.1371/journal.pcbi.1002598) by A. Morin, et al.
21+
2122
See the [ABC Global Center policy for licensing](https://docs.google.com/document/d/1SlITG-r7kdJB6C8f4FCJ9Z7o7ccwldZoSRJKjhRAWVA/edit#heading=h.c1sxg0wsiqru) for more information.
2223
2324
See more options for the above information by clicking "edit dataset card" on your repo.
@@ -59,8 +60,7 @@ Escape underscores ("_") with a "\". Example: image\_RGB
5960
<!-- Provide a longer summary of what this dataset is. -->
6061
[More Information Needed]
6162

62-
<!--This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1), and further altered to suit ABC Global Center needs.-->
63-
63+
<!--This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1), and further altered to suit ABC Global Center needs.-->
6464

6565
### Supported Tasks and Leaderboards
6666
[More Information Needed]
@@ -249,6 +249,7 @@ Please be sure to also cite the original data source(s):
249249

250250
This work was supported by the [AI and Biodiversity Change (ABC) Global Center](http://abcresearchcenter.org/), which is funded by the US National Science Foundation under Award No. 2330423 and Natural Sciences and Engineering Research Council of Canada under Award No. 585136. This dataset draws on research supported by the Social Sciences and Humanities Research Council. Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation, Natural Sciences and Engineering Research Council of Canada, or Social Sciences and Humanities Research Council.
251251

252+
252253
<!-- You may also want to credit the source of your data, i.e., if you went to a museum or nature preserve to collect it. -->
253254

254255
## Glossary
Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,22 @@
11
# Dataset Card Template
22

3-
Below is the **HF_DatasetCard_Template_Imageomics.md**. You can copy this content and paste it into a new Markdown file to create a new dataset card.
3+
Below is the Dataset Card Template for Imageomics and ABC. You can download or copy this content and paste it into a new Markdown file to create a new dataset card.
4+
5+
<details>
6+
<summary>Imageomics</summary>
7+
</br>
8+
<b><a href="https://github.com/Imageomics/Imageomics-guide/raw/main/docs/wiki-guide/HF_DatasetCard_Template_Imageomics.md" target="_blank">Download Template</a></b>
49

5-
[Download Template](https://github.com/Imageomics/Imageomics-guide/raw/main/docs/wiki-guide/HF_DatasetCard_Template_Imageomics.md)
610

711
{{ include_file_as_code("docs/wiki-guide/HF_DatasetCard_Template_Imageomics.md") }}
12+
13+
</details>
14+
15+
<details>
16+
<summary>ABC</summary>
17+
</br>
18+
<b><a href="https://github.com/Imageomics/Imageomics-guide/raw/main/docs/wiki-guide/HF_DatasetCard_Template_ABC.md" target="_blank">Download Template</a></b>
19+
20+
{{ include_file_as_code("docs/wiki-guide/HF_DatasetCard_Template_ABC.md") }}
21+
22+
</details>

docs/wiki-guide/HF_ModelCard_Template_ABC.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ NOTE: Add more tags (your particular animal, type of model and use-case, etc.).
1818
1919
As with your GitHub Project repo, it is important to choose an appropriate license for your model. Alongside the appropriate stakeholders (eg., your PI, co-authors), select a license that is [Open Source Initiative](https://opensource.org/licenses) (OSI) compliant. You may also wish to consider adding a [RAIL license](https://www.licenses.ai/ai-licenses), which addresses responsible use.
2020
For more information on how to choose a license and why it matters, see [Choose A License](https://choosealicense.com) and [A Quick Guide to Software Licensing for the Scientist-Programmer](https://doi.org/10.1371/journal.pcbi.1002598) by A. Morin, et al.
21+
2122
See the [ABC Global Center policy for licensing](https://docs.google.com/document/d/1SlITG-r7kdJB6C8f4FCJ9Z7o7ccwldZoSRJKjhRAWVA/edit#heading=h.c1sxg0wsiqru) for more information.
2223
2324
License tags (for the `yaml` above) can be found [here](https://hf.co/docs/hub/repositories-licenses).
Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,22 @@
11
# Model Card Template
22

3-
Below is the **HF_ModelCard_Template_Imageomics.md**. You can copy this content and paste it into a new Markdown file to create a new dataset card.
3+
Below is the Model Card Template for Imageomics and ABC. You can download or copy this content and paste it into a new Markdown file to create a new dataset card.
4+
5+
<details>
6+
<summary>Imageomics</summary>
7+
</br>
8+
<b><a href="https://github.com/Imageomics/Imageomics-guide/raw/main/docs/wiki-guide/HF_ModelCard_Template_Imageomics.md" target="_blank">Download Template</a></b>
49

5-
[Download Template](https://github.com/Imageomics/Imageomics-guide/raw/main/docs/wiki-guide/HF_ModelCard_Template_Imageomics.md)
610

711
{{ include_file_as_code("docs/wiki-guide/HF_ModelCard_Template_Imageomics.md") }}
12+
13+
</details>
14+
15+
<details>
16+
<summary>ABC</summary>
17+
</br>
18+
<b><a href="https://github.com/Imageomics/Imageomics-guide/raw/main/docs/wiki-guide/HF_ModelCard_Template_ABC.md" target="_blank">Download Template</a></b>
19+
20+
{{ include_file_as_code("docs/wiki-guide/HF_ModelCard_Template_ABC.md") }}
21+
22+
</details>

0 commit comments

Comments
 (0)