Skip to content

Commit

Permalink
another minor update to the integrations docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SubhadityaMukherjee committed Nov 4, 2024
1 parent 46de152 commit dcc80dc
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
# 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](<Integrations of OpenML in PyTorch.md>).

#### Installation Instructions:

`pip install openml-pytorch`

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

Set the API key for OpenML from the command line:
```bash
openml configure apikey <your API key>
```

#### Usage
Import openML libraries
```python
Expand Down
5 changes: 5 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <your API key>
```

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
Expand Down

0 comments on commit dcc80dc

Please sign in to comment.