diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000000..978873013c --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,18 @@ +cff-version: 1.2.0 +message: "If you want to cite the framework, feel free to use this (but only if you loved it 😊)" +title: "PyTorch Lightning" +abstract: "The lightweight PyTorch wrapper for high-performance AI research. Scale your models, not the boilerplate." +date-released: 2019-03-30 +authors: + - family-names: "William" + given-names: "Falcon" + - name: "The PyTorch Lightning team" +version: 1.4 +doi: 10.5281/zenodo.3828935 +license: "Apache-2.0" +url: "https://www.pytorchlightning.ai" +repository-code: "https://github.com/PyTorchLightning/pytorch-lightning" +keywords: + - machine learning + - deep learning + - artificial intelligence diff --git a/MANIFEST.in b/MANIFEST.in index 3f4cb3c8d5..b810937f1a 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -23,6 +23,9 @@ include *.md # Include the license file include LICENSE +# Include the citation info +include *.cff + exclude *.sh exclude *.svg recursive-include pytorch_lightning *.py diff --git a/README.md b/README.md index 83489ce388..7dd5272956 100644 --- a/README.md +++ b/README.md @@ -429,24 +429,3 @@ grid train --grid_gpus 4 my_model.py --learning_rate 'uniform(1e-6, 1e-1, 20)' - The above command will launch (20 * 4) experiments each running on 4 GPUs (320 GPUs!) - by making ZERO changes to your code. - -______________________________________________________________________ - -## Licence - -Please observe the Apache 2.0 license that is listed in this repository. -In addition, the Lightning framework is Patent Pending. - -## BibTeX - -If you want to cite the framework feel free to use this (but only if you loved it 😊) or [zenodo](https://zenodo.org/record/3828935#.YC45Lc9Khqs): - -```bibtex -@article{falcon2019pytorch, - title={PyTorch Lightning}, - author={Falcon, WA, et al.}, - journal={GitHub. Note: https://github.com/PyTorchLightning/pytorch-lightning}, - volume={3}, - year={2019} -} -```