Skip to content

Commit c02096b

Browse files
authored
Add cite me (openml#874)
* Ask users to cite us * improve reference * Remove linebreak from bibtex block.
1 parent fb1c1d9 commit c02096b

2 files changed

Lines changed: 49 additions & 3 deletions

File tree

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1-
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
1+
# OpenML-Python
22

33
A python interface for [OpenML](http://openml.org), an online platform for open science collaboration in machine learning.
44
It can be used to download or upload OpenML data such as datasets and machine learning experiment results.
5-
You can find the documentation on the [openml-python website](https://openml.github.io/openml-python).
6-
If you wish to contribute to the package, please see our [contribution guidelines](https://github.com/openml/openml-python/blob/develop/CONTRIBUTING.md).
5+
6+
## General
7+
8+
* [Documentation](https://openml.github.io/openml-python).
9+
* [Contribution guidelines](https://github.com/openml/openml-python/blob/develop/CONTRIBUTING.md).
10+
11+
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
712

813
Master branch:
914

@@ -16,3 +21,22 @@ Development branch:
1621
[![Build Status](https://travis-ci.org/openml/openml-python.svg?branch=develop)](https://travis-ci.org/openml/openml-python)
1722
[![Build status](https://ci.appveyor.com/api/projects/status/blna1eip00kdyr25/branch/develop?svg=true)](https://ci.appveyor.com/project/OpenML/openml-python/branch/develop)
1823
[![Coverage Status](https://coveralls.io/repos/github/openml/openml-python/badge.svg?branch=develop)](https://coveralls.io/github/openml/openml-python?branch=develop)
24+
25+
## Citing OpenML-Python
26+
27+
If you use OpenML-Python in a scientific publication, we would appreciate a reference to the
28+
following paper:
29+
30+
[Matthias Feurer, Jan N. van Rijn, Arlind Kadra, Pieter Gijsbers, Neeratyoy Mallik, Sahithya Ravi, Andreas Müller, Joaquin Vanschoren, Frank Hutter<br/>
31+
**OpenML-Python: an extensible Python API for OpenML**<br/>
32+
*arXiv:1911.02490 [cs.LG]*](https://arxiv.org/abs/1911.02490)
33+
34+
Bibtex entry:
35+
```bibtex
36+
@article{feurer-arxiv19a,
37+
author = {Matthias Feurer and Jan N. van Rijn and Arlind Kadra and Pieter Gijsbers and Neeratyoy Mallik and Sahithya Ravi and Andreas Müller and Joaquin Vanschoren and Frank Hutter},
38+
title = {OpenML-Python: an extensible Python API for OpenML},
39+
journal = {arXiv:1911.02490},
40+
year = {2019},
41+
}
42+
```

doc/index.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,25 @@ Contribution to the OpenML package is highly appreciated. The OpenML package
8484
currently has a 1/4 position for the development and all help possible is
8585
needed to extend and maintain the package, create new examples and improve
8686
the usability. Please see the :ref:`contributing` page for more information.
87+
88+
--------------------
89+
Citing OpenML-Python
90+
--------------------
91+
92+
If you use OpenML-Python in a scientific publication, we would appreciate a
93+
reference to the following paper:
94+
95+
96+
`OpenML-Python: an extensible Python API for OpenML
97+
<https://arxiv.org/abs/1911.02490>`_,
98+
Feurer *et al.*, arXiv:1911.02490.
99+
100+
Bibtex entry::
101+
102+
@article{feurer-arxiv19a,
103+
author = {Matthias Feurer and Jan N. van Rijn and Arlind Kadra and Pieter Gijsbers and Neeratyoy Mallik and Sahithya Ravi and Andreas Müller and Joaquin Vanschoren and Frank Hutter},
104+
title = {OpenML-Python: an extensible Python API for OpenML},
105+
journal = {arXiv:1911.02490},
106+
year = {2019},
107+
}
108+

0 commit comments

Comments
 (0)