From 18b0f4c3fa5294f6a4737d83a4e0a66682413b5d Mon Sep 17 00:00:00 2001 From: Avik Pal Date: Tue, 10 Sep 2019 11:49:10 +0530 Subject: [PATCH] Add citation information for the torchgan paper (#117) --- .gitattributes | 1 + CITATION.bib | 8 ++++++ README.md | 39 ++++++++++---------------- docs/source/getting_started/citing.rst | 19 +++++++++++++ docs/source/index.rst | 1 + 5 files changed, 44 insertions(+), 24 deletions(-) create mode 100644 .gitattributes create mode 100644 CITATION.bib create mode 100644 docs/source/getting_started/citing.rst diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..f2f5bd6 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +CITATION.bib linguist-detectable=false diff --git a/CITATION.bib b/CITATION.bib new file mode 100644 index 0000000..dc30e88 --- /dev/null +++ b/CITATION.bib @@ -0,0 +1,8 @@ +@misc{pal2019torchgan, + title={{TorchGAN: A Flexible Framework for GAN Training and Evaluation}}, + author={Avik Pal, and Aniket Das}, + year={2019}, + eprint={1909.03410}, + archivePrefix={arXiv}, + primaryClass={cs.LG} +} diff --git a/README.md b/README.md index 12501ea..244c4f9 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,21 @@ The documentation for this package can be generated locally. Now open the corresponding file from `build` directory. +### Supporting and Citing + +This software was developed as part of academic research. If you would like to help support it, please star the repository. If you use this software as part of your research, teaching, or other activities, we would be grateful if you could cite the following: + +``` +@misc{pal2019torchgan, + title={{TorchGAN: A Flexible Framework for GAN Training and Evaluation}}, + author={Avik Pal, and Aniket Das}, + year={2019}, + eprint={1909.03410}, + archivePrefix={arXiv}, + primaryClass={cs.LG} +} +``` + ### Contributing We appreciate all contributions. If you are planning to contribute bug-fixes, please do so without any further discussion. If you plan to contribute new features, utility functions or extensions, please first open an issue and discuss the feature with us. For more detailed guidelines head over to the official documentation. @@ -72,27 +87,3 @@ This project exists thanks to all the people who contribute. - -### Backers - -Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/torchgan#backer)] - - - - -### Sponsors - -Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/torchgan#sponsor)] - - - - - - - - - - - - - diff --git a/docs/source/getting_started/citing.rst b/docs/source/getting_started/citing.rst new file mode 100644 index 0000000..ff1e1d4 --- /dev/null +++ b/docs/source/getting_started/citing.rst @@ -0,0 +1,19 @@ +Supporting and Citing +===================== + +This software was developed as part of academic research. If you would like +to help support it, please star the repository. If you use this software as +part of your research, teaching, or other activities, we would be grateful +if you could cite the following: + +.. code:: + + @misc{pal2019torchgan, + title={{TorchGAN: A Flexible Framework for GAN Training and Evaluation}}, + author={Avik Pal, and Aniket Das}, + year={2019}, + eprint={1909.03410}, + archivePrefix={arXiv}, + primaryClass={cs.LG} + } + diff --git a/docs/source/index.rst b/docs/source/index.rst index a1b44b5..64d5d5f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -9,6 +9,7 @@ The :mod:`torchgan` package consists of various generative adversarial networks :maxdepth: 2 getting_started/installation + getting_started/citing getting_started/dependencies getting_started/philosophy getting_started/contributing