-
-
Notifications
You must be signed in to change notification settings - Fork 199
doc: README Rework #1361
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: README Rework #1361
Changes from all commits
e214e34
d0fb4a0
45dd837
82b96cc
c121c42
6117f24
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,76 @@ | ||
| # OpenML-Python | ||
| <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> | ||
| [](#contributors-) | ||
| <!-- ALL-CONTRIBUTORS-BADGE:END --> | ||
|
|
||
| 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. | ||
|
|
||
| ## General | ||
| <div align="center"> | ||
|
|
||
| * [Documentation](https://openml.github.io/openml-python). | ||
| * [Contribution guidelines](https://github.com/openml/openml-python/blob/develop/CONTRIBUTING.md). | ||
| <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) | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Contrib should maybe point to https://openml.github.io/openml-python/main/contributing.html, though that page is also 💩
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would rather want to point to the github 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 | ||
|
|
||
| ## Citing OpenML-Python | ||
| 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") | ||
| ``` | ||
|
|
||
| If you use OpenML-Python in a scientific publication, we would appreciate a reference to the | ||
| following paper: | ||
| 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) | ||
LennartPurucker marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| dataset = task.get_dataset() | ||
| X, y, categorical_indicator, attribute_names = dataset.get_data(target=task.target_name) | ||
LennartPurucker marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| # 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/> | ||
|
|
@@ -35,23 +89,3 @@ Bibtex entry: | |
| url = {http://jmlr.org/papers/v22/19-920.html} | ||
| } | ||
| ``` | ||
|
|
||
| ## Contributors ✨ | ||
|
|
||
| Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-disable --> | ||
| <table> | ||
| <tr> | ||
| <td align="center"><a href="https://github.com/a-moadel"><img src="https://avatars0.githubusercontent.com/u/46557866?v=4" width="100px;" alt=""/><br /><sub><b>a-moadel</b></sub></a><br /><a href="https://github.com/openml/openml-python/commits?author=a-moadel" title="Documentation">📖</a> <a href="#example-a-moadel" title="Examples">💡</a></td> | ||
| <td align="center"><a href="https://github.com/Neeratyoy"><img src="https://avatars2.githubusercontent.com/u/3191233?v=4" width="100px;" alt=""/><br /><sub><b>Neeratyoy Mallik</b></sub></a><br /><a href="https://github.com/openml/openml-python/commits?author=Neeratyoy" title="Code">💻</a> <a href="https://github.com/openml/openml-python/commits?author=Neeratyoy" title="Documentation">📖</a> <a href="#example-Neeratyoy" title="Examples">💡</a></td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <!-- markdownlint-enable --> | ||
| <!-- prettier-ignore-end --> | ||
| <!-- ALL-CONTRIBUTORS-LIST:END --> | ||
|
|
||
| This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! | ||
Uh oh!
There was an error while loading. Please reload this page.