Update template pages #25
Conversation
NetZissou
force-pushed
the
feature/templates
branch
from
1efbccb to
d1c1368
Compare
egrace479
left a comment
egrace479
left a comment
There was a problem hiding this comment.
A couple preliminary suggestions. I want it to be clear that these are two distinct cards in each category (one for Imageomics and one for ABC) so they pay attention to copy the right one.
|
I know we currently have a redirect to raw under the download links, but @NetZissou, can you try to get an actual download link for these? Otherwise, point to it on GitHub so they have a download button there. If linking to GH, then I'd also update the link to say "Download template from GitHub". Thanks!
|
egrace479
left a comment
egrace479
left a comment
There was a problem hiding this comment.
I updated the description on the template intro page to include ABC as well. Please read it over before merging.
Co-authored-by: Graham Taylor <[email protected]>
| ## Citation | ||
| [More Information Needed] | ||
|
|
||
| **BibTeX:** | ||
| <!-- | ||
| If you want to include BibTex, replace "<>"s with your info | ||
| **Data** | ||
| ``` | ||
| @misc{<ref_code>, | ||
| author = {<author1 and author2>}, | ||
| title = {<title>}, | ||
| year = {<year>}, | ||
| url = {https://huggingface.co/datasets/ABC-Center/<dataset_name>}, | ||
| doi = {<doi once generated>}, | ||
| publisher = {Hugging Face} | ||
| } | ||
| ``` | ||
| -for an associated paper: | ||
| **Paper** | ||
| ``` | ||
| @article{<ref_code>, | ||
| title = {<title>}, | ||
| author = {<author1 and author2>}, | ||
| journal = {<journal_name>}, | ||
| year = <year>, | ||
| url = {<DOI_URL>}, | ||
| doi = {<DOI>} | ||
| } | ||
| ``` | ||
| --> | ||
|
|
||
| <!--- | ||
| If the data is modified from another source, add the following. | ||
| Please be sure to also cite the original data source(s): | ||
| <citation> | ||
| --> |
There was a problem hiding this comment.
I noticed we are using BibTeX for citation (which is what I am used to). But I learned about the CITATION.cff file from the Imageomics Guide, specifically the GitHub Repo Guide. Does it make sense to standardize to one or the other, or have you already considered this?
There was a problem hiding this comment.
I did not realize that CITATION.cff worked on Hugging Face, but it seems (Select "Cite this dataset" under the DOI on this repo) that including one may override the auto-generated DOI citation (e.g., on TOL-10M). In which case, I think it's a good idea to include for HF as well.
I still think including the BibTeX is useful since it will provide pre-formatted version of all citations (the actual repo, paper(s), references, etc.), but if simply including a CITATION.cff ensures proper citation dropdown when a DOI is generated, that's great.
There was a problem hiding this comment.
Interesting!
I agree that including the BibTeX is still useful.
Summary
Note
The "Download Template" link for ABC templates will only become functional after this merge because the templates do not currently exist in the
mainbranch.Linked Issue
Closes #16