Skip to content

Commit 7aa0812

Browse files
authored
Merge pull request #15 from Benjamin-eecs/Benjamin-eecs-dev-citation
fix(citation): add citation in README
2 parents 6820f2d + 5aa6d0d commit 7aa0812

File tree

3 files changed

+21
-2
lines changed

3 files changed

+21
-2
lines changed

CITATION.cff

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,7 @@ authors:
2424
family-names: Yang
2525
affiliation: Peking University
2626
email: yaodong.yang@pku.edu.cn
27+
version: 0.4.1
28+
date-released: "2022-04-09"
29+
license: Apache-2.0
30+
repository-code: "https://github.com/metaopt/TorchOpt"

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,4 +183,19 @@ python setup.py build_from_source
183183
- [ ] CPU-acclerated optimizer
184184

185185
## The Team
186-
TorchOpt is a work by Jie Ren, Xidong Feng, Bo Liu, [Luo Mai](https://luomai.github.io/) and [Yaodong Yang](https://www.yangyaodong.com/).
186+
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/).
187+
188+
## Citing TorchOpt
189+
190+
If you find TorchOpt useful, please cite it in your publications.
191+
192+
```
193+
@software{TorchOpt,
194+
author = {Jie Ren and Xidong Feng and Bo Liu and Luo Mai and Yaodong Yang},
195+
title = {TorchOpt},
196+
year = {2022},
197+
publisher = {GitHub},
198+
journal = {GitHub repository},
199+
howpublished = {\url{https://github.com/metaopt/TorchOpt}},
200+
}
201+
```

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ def __init__(self):
9999
setup(
100100
name="TorchOpt",
101101
version="0.4.1",
102-
author="Jie Ren",
102+
author="TorchOpt Contributors",
103103
author_email="jieren9806@gmail.com",
104104
description="A Jax-style optimizer.",
105105
license="Apache License Version 2.0",

0 commit comments

Comments
 (0)