Skip to content

Commit 871cc7d

Browse files
markurtzdsikka
andauthored
Add citation information both in README as well as native GitHub file support (#1527)
SUMMARY: Add citation information both in README as well as native GitHub file support to enable standard citations within research papers and the general ML community. Fixes #1523 TEST PLAN: Manual verification of the formats, more info here: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files --------- Signed-off-by: Mark Kurtz <mark.j.kurtz@gmail.com> Co-authored-by: Dipika Sikka <dipikasikka1@gmail.com>
1 parent 5375f18 commit 871cc7d

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

CITATION.cff

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software, please cite it as below."
3+
authors:
4+
- name: Red Hat AI
5+
- name: vLLM Project
6+
title: "LLM Compressor"
7+
date-released: 2024-08-08
8+
url: https://github.com/vllm-project/llm-compressor

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,3 +120,17 @@ output = model.generate("My name is")
120120

121121
- If you have any questions or requests open an [issue](https://github.com/vllm-project/llm-compressor/issues) and we will add an example or documentation.
122122
- We appreciate contributions to the code, examples, integrations, and documentation as well as bug reports and feature requests! [Learn how here](CONTRIBUTING.md).
123+
124+
## Citation
125+
126+
If you find LLM Compressor useful in your research or projects, please consider citing it:
127+
128+
```bibtex
129+
@software{llmcompressor2024,
130+
title={{LLM Compressor}},
131+
author={Red Hat AI and vLLM Project},
132+
year={2024},
133+
month={8},
134+
url={https://github.com/vllm-project/llm-compressor},
135+
}
136+
```

0 commit comments

Comments
 (0)