KEMBAR78
Create CITATION.cff by joecummings · Pull Request #1756 · meta-pytorch/torchtune · GitHub
Skip to content

Create CITATION.cff #1756

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Oct 14, 2024
Merged

Create CITATION.cff #1756

merged 3 commits into from
Oct 14, 2024

Conversation

@joecummings
Copy link
Member

👀

@pytorch-bot
Copy link

pytorch-bot bot commented Oct 6, 2024 •
edited
Loading

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/torchtune/1756

Note: Links to docs will display an error until the docs builds have been completed.

✅ No Failures

As of commit 37fd1c0 with merge base a8a64ec (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Oct 6, 2024
SalmanMohammadi
SalmanMohammadi reviewed Oct 6, 2024
View reviewed changes
CITATION.cff Outdated
@@ -0,0 +1,9 @@
cff-version: 1.2.0
title: "torchtune: the PyTorch native finetuning library"
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
title: "torchtune: the PyTorch native finetuning library"
title: "torchtune: a PyTorch native finetuning library"

Copy link
Member Author

Choose a reason for hiding this comment

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

You don't like being THE finetuning library?? 🥹

Copy link
Contributor

Choose a reason for hiding this comment

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

Or we can split the difference and say "PyTorch's finetuning library"

@SalmanMohammadi
Copy link
Contributor

Should we also add a section in the README?

@joecummings
Copy link
Member Author

Should we also add a section in the README?

added

@codecov-commenter
Copy link

codecov-commenter commented Oct 6, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.33%. Comparing base (7cf656b) to head (bcb52ae).
Report is 3 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1756      +/-   ##
==========================================
- Coverage   69.33%   67.33%   -2.00%     
==========================================
  Files         305      305              
  Lines       15892    15961      +69     
==========================================
- Hits        11018    10747     -271     
- Misses       4874     5214     +340

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@SalmanMohammadi
Copy link
Contributor

"a finetuning library" bestows us with a modest sagaciousness

Think we just need to link to the section in the readme heading (https://github.com/pytorch/torchtune/blob/a8a64ec6a99a6ea2be4fdaf0cd5797b03a2567cf/README.md?plain=1#L10)

ebsmothers
ebsmothers approved these changes Oct 7, 2024
View reviewed changes
Copy link
Contributor

@ebsmothers ebsmothers left a comment

Choose a reason for hiding this comment

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

One comment, otherwise looks good

@joecummings joecummings merged commit 4107cc4 into main Oct 14, 2024
16 checks passed
@joecummings joecummings deleted the joecummings-patch-1 branch October 14, 2024 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ebsmothers ebsmothers ebsmothers approved these changes

+1 more reviewer

@SalmanMohammadi SalmanMohammadi SalmanMohammadi approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@joecummings @SalmanMohammadi @codecov-commenter @ebsmothers @facebook-github-bot