diff --git a/README.md b/README.md index 63e33155b..732085697 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ -[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) +# OpenML-Python A python interface for [OpenML](http://openml.org), an online platform for open science collaboration in machine learning. It can be used to download or upload OpenML data such as datasets and machine learning experiment results. -You can find the documentation on the [openml-python website](https://openml.github.io/openml-python). -If you wish to contribute to the package, please see our [contribution guidelines](https://github.com/openml/openml-python/blob/develop/CONTRIBUTING.md). + +## General + +* [Documentation](https://openml.github.io/openml-python). +* [Contribution guidelines](https://github.com/openml/openml-python/blob/develop/CONTRIBUTING.md). + +[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) Master branch: @@ -16,3 +21,22 @@ Development branch: [![Build Status](https://travis-ci.org/openml/openml-python.svg?branch=develop)](https://travis-ci.org/openml/openml-python) [![Build status](https://ci.appveyor.com/api/projects/status/blna1eip00kdyr25/branch/develop?svg=true)](https://ci.appveyor.com/project/OpenML/openml-python/branch/develop) [![Coverage Status](https://coveralls.io/repos/github/openml/openml-python/badge.svg?branch=develop)](https://coveralls.io/github/openml/openml-python?branch=develop) + +## Citing OpenML-Python + +If you use OpenML-Python in a scientific publication, we would appreciate a reference to the +following paper: + +[Matthias Feurer, Jan N. van Rijn, Arlind Kadra, Pieter Gijsbers, Neeratyoy Mallik, Sahithya Ravi, Andreas Müller, Joaquin Vanschoren, Frank Hutter
+**OpenML-Python: an extensible Python API for OpenML**
+*arXiv:1911.02490 [cs.LG]*](https://arxiv.org/abs/1911.02490) + +Bibtex entry: +```bibtex +@article{feurer-arxiv19a, + 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}, + title = {OpenML-Python: an extensible Python API for OpenML}, + journal = {arXiv:1911.02490}, + year = {2019}, +} +``` diff --git a/doc/index.rst b/doc/index.rst index 8d7cf2243..789979023 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -84,3 +84,25 @@ Contribution to the OpenML package is highly appreciated. The OpenML package currently has a 1/4 position for the development and all help possible is needed to extend and maintain the package, create new examples and improve the usability. Please see the :ref:`contributing` page for more information. + +-------------------- +Citing OpenML-Python +-------------------- + +If you use OpenML-Python in a scientific publication, we would appreciate a +reference to the following paper: + + + `OpenML-Python: an extensible Python API for OpenML + `_, + Feurer *et al.*, arXiv:1911.02490. + + Bibtex entry:: + + @article{feurer-arxiv19a, + 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}, + title = {OpenML-Python: an extensible Python API for OpenML}, + journal = {arXiv:1911.02490}, + year = {2019}, + } +