Skip to content

Commit 789330e

Browse files
authored
Add citation in README (open-mmlab#995)
1 parent 8177ef2 commit 789330e

File tree

3 files changed

+34
-0
lines changed

3 files changed

+34
-0
lines changed

CITATION.cff

+8
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: "MMEngine Contributors"
5+
title: "OpenMMLab Foundational Library for Training Deep Learning Models"
6+
date-released: 2022-09-01
7+
url: "https://github.com/open-mmlab/mmengine"
8+
license: Apache-2.0

README.md

+13
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,19 @@ runner.train()
308308

309309
We appreciate all contributions to improve MMEngine. Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for the contributing guideline.
310310

311+
## Citation
312+
313+
If you find this project useful in your research, please consider cite:
314+
315+
```
316+
@article{mmengine2022,
317+
title = {{MMEngine}: OpenMMLab Foundational Library for Training Deep Learning Models},
318+
author = {MMEngine Contributors},
319+
howpublished = {\url{https://github.com/open-mmlab/mmengine}},
320+
year={2022}
321+
}
322+
```
323+
311324
## License
312325

313326
This project is released under the [Apache 2.0 license](LICENSE).

README_zh-CN.md

+13
Original file line numberDiff line numberDiff line change
@@ -294,6 +294,19 @@ runner.train()
294294

295295
我们感谢所有的贡献者为改进和提升 MMEngine 所作出的努力。请参考[贡献指南](CONTRIBUTING_zh-CN.md)来了解参与项目贡献的相关指引。
296296

297+
## 引用
298+
299+
如果您觉得 MMEngine 对您的研究有所帮助,请考虑引用它:
300+
301+
```
302+
@article{mmengine2022,
303+
title = {{MMEngine}: OpenMMLab Foundational Library for Training Deep Learning Models},
304+
author = {MMEngine Contributors},
305+
howpublished = {\url{https://github.com/open-mmlab/mmengine}},
306+
year={2022}
307+
}
308+
```
309+
297310
## 开源许可证
298311

299312
该项目采用 [Apache 2.0 license](LICENSE) 开源许可证。

0 commit comments

Comments
 (0)