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

Add citation file #76

Merged
merged 1 commit into from
Jul 30, 2021
Merged

Add citation file #76

merged 1 commit into from
Jul 30, 2021

Conversation

pcuenca
Copy link
Collaborator

@pcuenca pcuenca commented Jul 29, 2021

As suggested by Khalid

@khalidsaifullaah
Copy link
Collaborator

So the issue with Github's CITATION.cff is, it generates a BibTex but it's quite broken in a sense that it messes up the authors names. For example, for the .cff above, we get a BibTex as the following:

@misc{Dayma_DALL·E_Mini_2021,
author = {Dayma, Boris and Patil, Suraj and Cuenca, Pedro and Saifullah, Khalid and Abraham, Tanishq and Lê Khắc, Phúc and Melas, Luke and Ghosh, Ritobrata},
month = {7},
title = {DALL·E Mini},
url = {https://github.com/borisdayma/dalle-mini},
year = {2021}
}

Now, we can either use this or go with creating our own BibTex (with zenodo maybe) and add it in our repo's README (seems like almost all repos do it that way).

So, what's your opinion on this? @pcuenca @borisdayma

@pcuenca
Copy link
Collaborator Author

pcuenca commented Jul 30, 2021

@khalidsaifullaah what's wrong with that BibTex?

I just wanted to test what the new official citation support looked like. The nice thing about it is that it appears in a dedicated section, so I suppose it would be harder to ignore. But I don't particularly care for this too much anyway, so if you think another method is better we can close this one.

@khalidsaifullaah
Copy link
Collaborator

Yeah, I also think using this recent feature is a good idea, most of the users will start using it from now on. The , in the wrong places of author section are what makes the BibTex are a bit weird. But if we use our own generated BibTex, in that case, we won't be able to use this GitHub feature, which is a bummer. So, whatever you guys think, but I'm thinking let's just use this BibTex the way it is, maybe it's not that big of a deal.

@lkhphuc
Copy link
Collaborator

lkhphuc commented Jul 30, 2021

That Dayma, Boris and Last, First name and ... is actually the correct format @khalidsaifullaah . The final output in the paper will be determine by the specific paper template.

@khalidsaifullaah
Copy link
Collaborator

Oh, I see, thanks for your insight @lkhphuc!
I and Boris were stressing over this naming format, but if it's the right format then I guess we can go ahead with this option!

@borisdayma borisdayma merged commit c91f919 into main Jul 30, 2021
Copy link
Collaborator

@khalidsaifullaah khalidsaifullaah left a comment

Choose a reason for hiding this comment

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

I think we can go ahead with this option after making those minimal changes...

- "zero-shot"
- JAX
license: "Apache-2.0"
message: "If you use this software, please cite it using these metadata."
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could you just include the DOI that @borisdayma has generated for our repo, you can just add it here by the following:
doi: 10.5281/zenodo.1234

- "zero-shot"
- JAX
license: "Apache-2.0"
message: "If you use this software, please cite it using these metadata."
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we say here Project or DALL·E Mini or something else instead of software?
Or we must use the software term here...?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants