From 4107cc489eba9c25a1ddbfd1314be4a3a80de197 Mon Sep 17 00:00:00 2001 From: Joe Cummings Date: Mon, 14 Oct 2024 14:46:31 -0400 Subject: [PATCH] Create CITATION.cff (#1756) --- CITATION.cff | 9 +++++++++ README.md | 18 +++++++++++++++++- 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000000..dd5bf558c3 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,9 @@ +cff-version: 1.2.0 +title: "torchtune: PyTorch's finetuning library" +message: "If you use this software, please cite it as below." +type: software +authors: + - given-names: "torchtune maintainers and contributors" +url: "https//github.com/pytorch/torchtune" +license: "BSD-3-Clause" +date-released: "2024-04-14" diff --git a/README.md b/README.md index a66d3ded4c..2b702dc529 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ ![Recipe Integration Test](https://github.com/pytorch/torchtune/actions/workflows/recipe_test.yaml/badge.svg) [![](https://dcbadge.vercel.app/api/server/4Xsdn8Rr9Q?style=flat)](https://discord.gg/4Xsdn8Rr9Q) -[**Introduction**](#introduction) | [**Installation**](#installation) | [**Get Started**](#get-started) | [**Documentation**](https://pytorch.org/torchtune/main/index.html) | [**Community**](#community) | [**License**](#license) +[**Introduction**](#introduction) | [**Installation**](#installation) | [**Get Started**](#get-started) | [**Documentation**](https://pytorch.org/torchtune/main/index.html) | [**Community**](#community) | [**License**](#license) | [**Citing torchtune**](#citing-torchtune) > [!IMPORTANT] > 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: ## License 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. + + +## Citing torchtune + +If you find the torchtune library useful, please cite it in your work as below. + +```bibtex +@software{torchtune, + title = {torchtune: PyTorch's finetuning library}, + author = {torchtune maintainers and contributors}, + url = {https//github.com/pytorch/torchtune}, + license = {BSD-3-Clause}, + month = apr, + year = {2024} +} +```