diff --git a/README.md b/README.md index 8df63da..f61503b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Pytorch extension for OpenML python -Pytorch extension for [openml-python API](https://github.com/openml/openml-python). +Pytorch extension for [openml-python API](https://github.com/openml/openml-python). This library provides a simple way to run your Pytorch models on OpenML tasks. + +For a more native experience, PyTorch itself provides OpenML integrations for some tasks. You can find more information [here](). #### Installation Instructions: @@ -8,6 +10,11 @@ Pytorch extension for [openml-python API](https://github.com/openml/openml-pytho PyPi link https://pypi.org/project/openml-pytorch/ +Set the API key for OpenML from the command line: +```bash +openml configure apikey +``` + #### Usage Import openML libraries ```python diff --git a/docs/index.md b/docs/index.md index 856498d..5d8e0fc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,6 +14,11 @@ PyPi link https://pypi.org/project/openml-pytorch/ ## Usage To use this extension, you need to have a task from OpenML. You can either browse the [OpenML website](https://openml.org/search?type=task&sort=runs) to find a task (and get it's ID), or follow the [example](./Examples/Create%20Dataset%20and%20Task.ipynb) to create a task from a custom dataset. +Set the API key for OpenML from the command line: +```bash +openml configure apikey +``` + Then, follow one of the examples in the [Examples](./Examples/Create%20Dataset%20and%20Task.ipynb) folder to see how to use this extension for your type of data. Import openML libraries