Skip to content

Commit 4107cc4

Browse files
authored
Create CITATION.cff (#1756)
1 parent 918c053 commit 4107cc4

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed

CITATION.cff

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
cff-version: 1.2.0
2+
title: "torchtune: PyTorch's finetuning library"
3+
message: "If you use this software, please cite it as below."
4+
type: software
5+
authors:
6+
- given-names: "torchtune maintainers and contributors"
7+
url: "https//github.com/pytorch/torchtune"
8+
license: "BSD-3-Clause"
9+
date-released: "2024-04-14"

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
![Recipe Integration Test](https://github.com/pytorch/torchtune/actions/workflows/recipe_test.yaml/badge.svg)
88
[![](https://dcbadge.vercel.app/api/server/4Xsdn8Rr9Q?style=flat)](https://discord.gg/4Xsdn8Rr9Q)
99

10-
[**Introduction**](#introduction) | [**Installation**](#installation) | [**Get Started**](#get-started) | [**Documentation**](https://pytorch.org/torchtune/main/index.html) | [**Community**](#community) | [**License**](#license)
10+
[**Introduction**](#introduction) | [**Installation**](#installation) | [**Get Started**](#get-started) | [**Documentation**](https://pytorch.org/torchtune/main/index.html) | [**Community**](#community) | [**License**](#license) | [**Citing torchtune**](#citing-torchtune)
1111

1212
> [!IMPORTANT]
1313
> Update September 25, 2024: torchtune has support for **Llama 3.2 11B Vision**, **Llama 3.2 3B**, and **Llama 3.2 1B** models! Try them out by following our installation instructions [here](#Installation), then run any of the text configs [here](recipes/configs/llama3_2) or vision configs [here](recipes/configs/llama3_2_vision).
@@ -282,3 +282,19 @@ We also want to acknowledge some awesome libraries and tools from the ecosystem:
282282
## License
283283

284284
torchtune is released under the [BSD 3 license](./LICENSE). However you may have other legal obligations that govern your use of other content, such as the terms of service for third-party models.
285+
286+
287+
## Citing torchtune
288+
289+
If you find the torchtune library useful, please cite it in your work as below.
290+
291+
```bibtex
292+
@software{torchtune,
293+
title = {torchtune: PyTorch's finetuning library},
294+
author = {torchtune maintainers and contributors},
295+
url = {https//github.com/pytorch/torchtune},
296+
license = {BSD-3-Clause},
297+
month = apr,
298+
year = {2024}
299+
}
300+
```

0 commit comments

Comments
 (0)