Add citation entry for repository #2825
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shuningjin
force-pushed
the
cite-repo
branch
from
a50a378 to
02e810e
Compare
shuningjin
requested review from
A9isha,
RissyRan,
bvandermoon,
gagika,
gobbleturk,
jacoguzo,
jiangjy1982,
richjames0,
shralex and
vipannalla
as code owners
RissyRan
reviewed
Dec 13, 2025
README.md
Outdated
|
|
||
| To cite the MaxText repository: | ||
| ``` | ||
| @misc{maxtext2023github, |
Collaborator
There was a problem hiding this comment.
I didn't find good alignment on the repo. Shall we use @software instead of @misc. Do you have a source?
I see different examples:
- https://github.com/google-deepmind/dm-haiku - software, same as JAX
- https://github.com/NVIDIA/Megatron-LM?tab=readme-ov-file#citation - article
Collaborator
Author
There was a problem hiding this comment.
@article might not be proper without actual paper. megatron has a arxiv preprint.
@misc can be used for anything, the most generic category.
Yes, we can use @software to be more specific and align with JAX and Haiku.
RissyRan
reviewed
Dec 13, 2025
| To cite the MaxText repository: | ||
| ``` | ||
| @misc{maxtext2023github, | ||
| author = {{Google Cloud AI Hypercomputer}}, |
Collaborator
There was a problem hiding this comment.
Let's discuss more offline.
shralex
reviewed
Dec 13, 2025
README.md
Outdated
| ``` | ||
| @misc{maxtext2023github, | ||
| author = {{Google Cloud AI Hypercomputer}}, | ||
| title = {{M}ax{T}ext: A simple, performant and scalable {JAX} {LLM}}, |
Collaborator
There was a problem hiding this comment.
add "training framework" ?
Collaborator
Author
There was a problem hiding this comment.
Thanks for the suggestion! Title updated.
shuningjin
force-pushed
the
cite-repo
branch
from
02e810e to
640423a
Compare
shuningjin
force-pushed
the
cite-repo
branch
from
640423a to
be93494
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add repo citation, similar to jax and jiant.
Tests
latex preview: https://screenshot.googleplex.com/5g5WFzTbvRRuEJP
Checklist
Before submitting this PR, please make sure (put X in square brackets):
gemini-reviewlabel.