Skip to content

Commit

Permalink
Adding citation info
Browse files Browse the repository at this point in the history
  • Loading branch information
frthjf committed Jan 3, 2018
1 parent 9e6dc85 commit 64445b2
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 6 deletions.
13 changes: 13 additions & 0 deletions CITATION.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Gressmann, F., Király, F. J., Mateen, B., & Oberhauser, H. (2018). Probabilistic supervised learning. ArXiv:1801.00753 [Cs, Math, Stat]. Retrieved from http://arxiv.org/abs/1801.00753 ::

@article{skpro,
archivePrefix = {arXiv},
eprinttype = {arxiv},
eprint = {1801.00753},
primaryClass = {cs, math, stat},
title = {Probabilistic Supervised Learning},
url = {http://arxiv.org/abs/1801.00753},
urldate = {2018-01-03},
date = {2018-01-02},
author = {Gressmann, Frithjof and Király, Franz J. and Mateen, Bilal and Oberhauser, Harald}
}
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@ Installation is easy using Python's package manager

$ pip install skpro

### Contributing
### Contributing & Citation

We welcome contributions to the skpro project. Please read our [contribution guide](/CONTRIBUTING.md).

If you use skpro in a scientific publication, we would appreciate [citations](CITATION.rst).


16 changes: 12 additions & 4 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
Contributing
************
Contributing & Citation
***********************

We welcome any contribution to the skpro project.
Contributing guide
------------------

Please read our `contribution guide <https://github.com/alan-turing-institute/skpro/blob/master/CONTRIBUTING.md>`_ on Github.
We welcome any contribution to the skpro project. Please read our `contribution guide <https://github.com/alan-turing-institute/skpro/blob/master/CONTRIBUTING.md>`_ on Github.

Cite skpro
----------

If you use skpro in a scientific publication, we would appreciate citations to the following paper:

.. include:: ../CITATION.rst
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Contents
API Reference <api/modules>
Changelog <changes>
Authors <authors>
Contributing <contributing>
Contributing & Citation <contributing>
License <license>


Expand Down

0 comments on commit 64445b2

Please sign in to comment.