| Name | openml JSON |
| Version |
0.15.1
JSON |
| download |
| home_page | None |
| Summary | Python API for OpenML |
| upload_time | 2025-01-25 10:56:28 |
| maintainer | None |
| docs_url | None |
| author | Jan van Rijn, Arlind Kadra, Pieter Gijsbers, Neeratyoy Mallik, Sahithya Ravi, Andreas Müller, Joaquin Vanschoren , Frank Hutter |
| requires_python | >=3.8 |
| license | BSD 3-Clause License
Copyright (c) 2014-2019, Matthias Feurer, Jan van Rijn, Andreas Müller,
Joaquin Vanschoren and others.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License of the files CONTRIBUTING.md, ISSUE_TEMPLATE.md and
PULL_REQUEST_TEMPLATE.md:
Those files are modifications of the respecting templates in scikit-learn and
they are licensed under a New BSD license:
New BSD License
Copyright (c) 2007–2018 The scikit-learn developers.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
a. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
b. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
c. Neither the name of the Scikit-learn Developers nor the names of
its contributors may be used to endorse or promote products
derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.
|
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<div id="user-content-toc">
<ul align="center" style="list-style: none;">
<summary>
<img src="https://github.com/openml/openml.org/blob/master/app/public/static/svg/logo.svg" width="50" alt="OpenML Logo"/>
<h1>OpenML-Python</h1>
<img src="https://github.com/openml/docs/blob/master/docs/img/python.png" width="50" alt="Python Logo"/>
</summary>
</ul>
</div>
## The Python API for a World of Data and More :dizzy:
[](https://github.com/openml/openml-python/releases)
[](https://pypi.org/project/openml/)
[](https://pepy.tech/project/openml)
[](https://opensource.org/licenses/BSD-3-Clause)
<!-- Add green badges for CI and precommit -->
[Installation](https://openml.github.io/openml-python/main/#how-to-get-openml-for-python) | [Documentation](https://openml.github.io/openml-python) | [Contribution guidelines](https://github.com/openml/openml-python/blob/develop/CONTRIBUTING.md)
</div>
OpenML-Python provides an easy-to-use and straightforward Python interface for [OpenML](http://openml.org), an online platform for open science collaboration in machine learning.
It can download or upload data from OpenML, such as datasets and machine learning experiment results.
## :joystick: Minimal Example
Use the following code to get the [credit-g](https://www.openml.org/search?type=data&sort=runs&status=active&id=31) [dataset](https://docs.openml.org/concepts/data/):
```python
import openml
dataset = openml.datasets.get_dataset("credit-g") # or by ID get_dataset(31)
X, y, categorical_indicator, attribute_names = dataset.get_data(target="class")
```
Get a [task](https://docs.openml.org/concepts/tasks/) for [supervised classification on credit-g](https://www.openml.org/search?type=task&id=31&source_data.data_id=31):
```python
import openml
task = openml.tasks.get_task(31)
dataset = task.get_dataset()
X, y, categorical_indicator, attribute_names = dataset.get_data(target=task.target_name)
# get splits for the first fold of 10-fold cross-validation
train_indices, test_indices = task.get_train_test_split_indices(fold=0)
```
Use an [OpenML benchmarking suite](https://docs.openml.org/concepts/benchmarking/) to get a curated list of machine-learning tasks:
```python
import openml
suite = openml.study.get_suite("amlb-classification-all") # Get a curated list of tasks for classification
for task_id in suite.tasks:
task = openml.tasks.get_task(task_id)
```
## :magic_wand: Installation
OpenML-Python is supported on Python 3.8 - 3.13 and is available on Linux, MacOS, and Windows.
You can install OpenML-Python with:
```bash
pip install openml
```
## :page_facing_up: 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<br/>
**OpenML-Python: an extensible Python API for OpenML**<br/>
Journal of Machine Learning Research, 22(100):1−5, 2021](https://www.jmlr.org/papers/v22/19-920.html)
Bibtex entry:
```bibtex
@article{JMLR:v22:19-920,
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 = {Journal of Machine Learning Research},
year = {2021},
volume = {22},
number = {100},
pages = {1--5},
url = {http://jmlr.org/papers/v22/19-920.html}
}
```
Raw data
{
"_id": null,
"home_page": null,
"name": "openml",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Jan van Rijn, Arlind Kadra, Pieter Gijsbers, Neeratyoy Mallik, Sahithya Ravi, Andreas M\u00fcller, Joaquin Vanschoren , Frank Hutter",
"author_email": "Matthias Feurer <feurerm@informatik.uni-freiburg.de>",
"download_url": "https://files.pythonhosted.org/packages/88/9b/729dc6377bbfdbf0828d5567a335670d4e7c2866065ca4593ab525a5809c/openml-0.15.1.tar.gz",
"platform": null,
"description": "\n\n<div align=\"center\">\n\n<div id=\"user-content-toc\">\n <ul align=\"center\" style=\"list-style: none;\">\n <summary>\n <img src=\"https://github.com/openml/openml.org/blob/master/app/public/static/svg/logo.svg\" width=\"50\" alt=\"OpenML Logo\"/> \n <h1>OpenML-Python</h1>\n <img src=\"https://github.com/openml/docs/blob/master/docs/img/python.png\" width=\"50\" alt=\"Python Logo\"/>\n </summary>\n </ul>\n</div>\n\n## The Python API for a World of Data and More :dizzy:\n\n[](https://github.com/openml/openml-python/releases)\n[](https://pypi.org/project/openml/)\n[](https://pepy.tech/project/openml)\n[](https://opensource.org/licenses/BSD-3-Clause)\n<!-- Add green badges for CI and precommit -->\n\n[Installation](https://openml.github.io/openml-python/main/#how-to-get-openml-for-python) | [Documentation](https://openml.github.io/openml-python) | [Contribution guidelines](https://github.com/openml/openml-python/blob/develop/CONTRIBUTING.md)\n</div>\n\nOpenML-Python provides an easy-to-use and straightforward Python interface for [OpenML](http://openml.org), an online platform for open science collaboration in machine learning.\nIt can download or upload data from OpenML, such as datasets and machine learning experiment results.\n\n## :joystick: Minimal Example\n\nUse the following code to get the [credit-g](https://www.openml.org/search?type=data&sort=runs&status=active&id=31) [dataset](https://docs.openml.org/concepts/data/):\n\n```python\nimport openml\n\ndataset = openml.datasets.get_dataset(\"credit-g\") # or by ID get_dataset(31)\nX, y, categorical_indicator, attribute_names = dataset.get_data(target=\"class\")\n```\n\nGet a [task](https://docs.openml.org/concepts/tasks/) for [supervised classification on credit-g](https://www.openml.org/search?type=task&id=31&source_data.data_id=31):\n\n```python\nimport openml\n\ntask = openml.tasks.get_task(31)\ndataset = task.get_dataset()\nX, y, categorical_indicator, attribute_names = dataset.get_data(target=task.target_name)\n# get splits for the first fold of 10-fold cross-validation\ntrain_indices, test_indices = task.get_train_test_split_indices(fold=0)\n```\n\nUse an [OpenML benchmarking suite](https://docs.openml.org/concepts/benchmarking/) to get a curated list of machine-learning tasks:\n```python\nimport openml\n\nsuite = openml.study.get_suite(\"amlb-classification-all\") # Get a curated list of tasks for classification\nfor task_id in suite.tasks:\n task = openml.tasks.get_task(task_id)\n```\n\n## :magic_wand: Installation\n\nOpenML-Python is supported on Python 3.8 - 3.13 and is available on Linux, MacOS, and Windows.\n\nYou can install OpenML-Python with:\n\n```bash\npip install openml\n```\n\n## :page_facing_up: Citing OpenML-Python\n\nIf you use OpenML-Python in a scientific publication, we would appreciate a reference to the following paper:\n\n[Matthias Feurer, Jan N. van Rijn, Arlind Kadra, Pieter Gijsbers, Neeratyoy Mallik, Sahithya Ravi, Andreas M\u00fcller, Joaquin Vanschoren, Frank Hutter<br/>\n**OpenML-Python: an extensible Python API for OpenML**<br/>\nJournal of Machine Learning Research, 22(100):1\u22125, 2021](https://www.jmlr.org/papers/v22/19-920.html)\n\nBibtex entry:\n```bibtex\n@article{JMLR:v22:19-920,\n author = {Matthias Feurer and Jan N. van Rijn and Arlind Kadra and Pieter Gijsbers and Neeratyoy Mallik and Sahithya Ravi and Andreas M\u00fcller and Joaquin Vanschoren and Frank Hutter},\n title = {OpenML-Python: an extensible Python API for OpenML},\n journal = {Journal of Machine Learning Research},\n year = {2021},\n volume = {22},\n number = {100},\n pages = {1--5},\n url = {http://jmlr.org/papers/v22/19-920.html}\n}\n```\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License\n \n Copyright (c) 2014-2019, Matthias Feurer, Jan van Rijn, Andreas M\u00fcller, \n Joaquin Vanschoren and others.\n All rights reserved.\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n \n * Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n \n * Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n \n * Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n \n License of the files CONTRIBUTING.md, ISSUE_TEMPLATE.md and \n PULL_REQUEST_TEMPLATE.md:\n \n Those files are modifications of the respecting templates in scikit-learn and\n they are licensed under a New BSD license:\n \n New BSD License\n \n Copyright (c) 2007\u20132018 The scikit-learn developers.\n All rights reserved.\n \n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n \n a. Redistributions of source code must retain the above copyright notice,\n this list of conditions and the following disclaimer.\n b. Redistributions in binary form must reproduce the above copyright\n notice, this list of conditions and the following disclaimer in the\n documentation and/or other materials provided with the distribution.\n c. Neither the name of the Scikit-learn Developers nor the names of\n its contributors may be used to endorse or promote products\n derived from this software without specific prior written\n permission. \n \n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\n ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR\n ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT\n LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\n OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH\n DAMAGE.\n ",
"summary": "Python API for OpenML",
"version": "0.15.1",
"project_urls": {
"documentation": "https://openml.github.io/openml-python/",
"home": "https://openml.org/",
"source": "https://github.com/openml/openml-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4af3462c16d9e80177d22a036abd3df0f114bf311e566ff906adbb3d82790c20",
"md5": "5897a86264e43db173c164ef3fadf7de",
"sha256": "14d25afb7a3007a70da26b0d1f46cf93df6f5784c31dd76d6a415066c6051961"
},
"downloads": -1,
"filename": "openml-0.15.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5897a86264e43db173c164ef3fadf7de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 160384,
"upload_time": "2025-01-25T10:56:24",
"upload_time_iso_8601": "2025-01-25T10:56:24.840255Z",
"url": "https://files.pythonhosted.org/packages/4a/f3/462c16d9e80177d22a036abd3df0f114bf311e566ff906adbb3d82790c20/openml-0.15.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "889b729dc6377bbfdbf0828d5567a335670d4e7c2866065ca4593ab525a5809c",
"md5": "313f6562219d04bceee8a95aefd38bfc",
"sha256": "58ae3840b6ea736bb6c69bcbb30d587b817f64db070dc691adb9e09b99018816"
},
"downloads": -1,
"filename": "openml-0.15.1.tar.gz",
"has_sig": false,
"md5_digest": "313f6562219d04bceee8a95aefd38bfc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 146141,
"upload_time": "2025-01-25T10:56:28",
"upload_time_iso_8601": "2025-01-25T10:56:28.351245Z",
"url": "https://files.pythonhosted.org/packages/88/9b/729dc6377bbfdbf0828d5567a335670d4e7c2866065ca4593ab525a5809c/openml-0.15.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-25 10:56:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openml",
"github_project": "openml-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "openml"
}
