tokenizers icon indicating copy to clipboard operation
tokenizers copied to clipboard

add Zenodo DOI Badge

Open SaulLu opened this issue 3 years ago • 3 comments

Proposal to add the Zenodo DOI Badge in the README.

The DOI used here corresponds to the Concept DOI (versus the Version DOIs), which represents the concept of the software package and all the versions of the given software package.

Currently, the Concept DOI links to the landing page for the latest version of our package. Note that in the future Zenodo plans to change this to create a landing page specifically representing the concept behind the record and all its versions.

SaulLu avatar May 25 '21 07:05 SaulLu

You can addd citations informations in the README at the bottom of the readme as well

thomwolf avatar May 25 '21 08:05 thomwolf

With pleasure!

We would like to put the link to the Concept DOI or the Version DOI (specific to the release v0.10.3)?

In the case of the Concept DOI, its last citation is not automatically populated on Zenodo. Would my proposal below be suitable?

@misc{hftokenizers2019,
  author = {Anthony MOI and
                  Pierric Cistac and
                  Nicolas Patry and
                  Evan P. Walsh and
                  Funtowicz Morgan and
                  Sebastian Pütz and
                  Thomas Wolf and
                  Sylvain Gugger and
                  Clément Delangue and
                  Julien Chaumond and
                  Lysandre Debut and
                  Patrick von Platen},
  title = {Hugging Face Tokenizers library},
  year = {2019},
  publisher = {GitHub},
  journal = {GitHub repository},
  doi = {10.5281/zenodo.4784271},
  howpublished = {\url{https://github.com/huggingface/tokenizers}}
}

SaulLu avatar May 25 '21 08:05 SaulLu

Looks good to me, but I'm no expert (maybe @thomwolf knows better). Feel free to add it to the readme, and we'll merge this :slightly_smiling_face:

n1t0 avatar Jun 02 '21 10:06 n1t0