Merge pull request #15 from Benjamin-eecs/Benjamin-eecs-dev-citation

fix(citation): add citation in README
metaopt · May 11, 2022 · 7aa0812 · 7aa0812
2 parents 6820f2d + 5aa6d0d
commit 7aa0812
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 2 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -24,3 +24,7 @@ authors:
     family-names: Yang
     affiliation: Peking University
     email: yaodong.yang@pku.edu.cn
+version: 0.4.1
+date-released: "2022-04-09"
+license: Apache-2.0
+repository-code: "https://github.com/metaopt/TorchOpt"
diff --git a/README.md b/README.md
@@ -183,4 +183,19 @@ python setup.py build_from_source
 - [ ] CPU-acclerated optimizer
 
 ## The Team
-TorchOpt is a work by Jie Ren, Xidong Feng, Bo Liu, [Luo Mai](https://luomai.github.io/) and [Yaodong Yang](https://www.yangyaodong.com/).
+TorchOpt is a work by Jie Ren, Xidong Feng, [Bo Liu](https://github.com/Benjamin-eecs/), [Luo Mai](https://luomai.github.io/) and [Yaodong Yang](https://www.yangyaodong.com/).
+
+## Citing TorchOpt
+
+If you find TorchOpt useful, please cite it in your publications.
+
+```
+@software{TorchOpt,
+  author = {Jie Ren and Xidong Feng and Bo Liu and Luo Mai and Yaodong Yang},
+  title = {TorchOpt},
+  year = {2022},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  howpublished = {\url{https://github.com/metaopt/TorchOpt}},
+}
+```
diff --git a/setup.py b/setup.py
@@ -99,7 +99,7 @@ def __init__(self):
 setup(
     name="TorchOpt",
     version="0.4.1",
-    author="Jie Ren",
+    author="TorchOpt Contributors",
     author_email="jieren9806@gmail.com",
     description="A Jax-style optimizer.",
     license="Apache License Version 2.0",