Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding BibTeX entry for TorchVision #6690

Merged
merged 3 commits into from
Nov 28, 2022
Merged

Conversation

datumbox
Copy link
Contributor

@datumbox datumbox commented Oct 4, 2022

Resolving pytorch/pytorch#4126 (comment)

Following the format as proposed here.

Copy link
Collaborator

@pmeier pmeier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GH has a custom format for defining the citation info: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

TL;DR you add a CITATION.cff file to the root of the project and GH adds a button on the top right column of the project home like they have in PyTorch core

Screenshot from 2022-10-04 11-34-54

PyTorch core just defines a CITATION file, which is why there is no information rendered directly. If you follow their protocol, the prompt looks like

Screenshot from 2022-10-04 11-36-39

I would prefer us to use this protocol. I can also send a PR to core. Of course we can also put the info in the README.

@datumbox datumbox merged commit 678300d into pytorch:main Nov 28, 2022
@datumbox datumbox deleted the docs/citation branch November 28, 2022 08:13
@pmeier pmeier mentioned this pull request Nov 28, 2022
facebook-github-bot pushed a commit that referenced this pull request Nov 28, 2022
Summary:
* Adding BibTeX entry for TorchVision

* Adding CITATION.cff file

Reviewed By: jdsgomes

Differential Revision: D41548201

fbshipit-source-id: c18820b059442b29de3370f0bb45e978758737b9
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants