Skip to content

Commit dcc80dc

Browse files
another minor update to the integrations docs
1 parent 46de152 commit dcc80dc

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
11
# Pytorch extension for OpenML python
22

3-
Pytorch extension for [openml-python API](https://github.com/openml/openml-python).
3+
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.
4+
5+
For a more native experience, PyTorch itself provides OpenML integrations for some tasks. You can find more information [here](<Integrations of OpenML in PyTorch.md>).
46

57
#### Installation Instructions:
68

79
`pip install openml-pytorch`
810

911
PyPi link https://pypi.org/project/openml-pytorch/
1012

13+
Set the API key for OpenML from the command line:
14+
```bash
15+
openml configure apikey <your API key>
16+
```
17+
1118
#### Usage
1219
Import openML libraries
1320
```python

docs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ PyPi link https://pypi.org/project/openml-pytorch/
1414
## Usage
1515
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.
1616

17+
Set the API key for OpenML from the command line:
18+
```bash
19+
openml configure apikey <your API key>
20+
```
21+
1722
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.
1823

1924
Import openML libraries

0 commit comments

Comments
 (0)