Skip to content

Commit

Permalink
minor mkdocs fix
Browse files Browse the repository at this point in the history
  • Loading branch information
SubhadityaMukherjee committed Oct 21, 2024
1 parent e84dabd commit a250189
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 5 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ dist/
openml_pytorch.egg-info/

datasets/
docs/Examples/datasets/

dist/

Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ 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.

Then, follow one of the examples in the [Examples](./Examples) folder to see how to use this extension for your type of data.
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
```python
Expand Down Expand Up @@ -71,7 +71,7 @@ run = openml.runs.run_model_on_task(model, task, avoid_duplicate_runs=False)
run.publish()
print('URL for run: %s/run/%d' % (openml.config.server, run.run_id))
```
Note: The input layer of the network should be compatible with OpenML data output shape. Please check [examples](/examples/) for more information.
Note: The input layer of the network should be compatible with OpenML data output shape. Please check [examples](./Examples/Create%20Dataset%20and%20Task.ipynb) for more information.

Additionally, if you want to publish the run with onnx file, then you must call ```openml_pytorch.add_onnx_to_run()``` immediately before ```run.publish()```.

Expand Down
4 changes: 1 addition & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,13 @@ plugins:

nav:
- Home: "index.md"
- "API Reference":
- API reference/index.md
- API Reference:
- "Callbacks": "API reference/Callbacks.md"
- "Custom Datasets": "API reference/Custom Datasets.md"
- "Metrics" : "API reference/Metrics.md"
- "OpenML Connection" : "API reference/OpenML Connection.md"
- "Trainer" : "API reference/Trainer.md"
- Examples:
- Examples/index.md
- "Create Dataset and Task" : "Examples/Create Dataset and Task.ipynb"
- "Image Classification Task" : "Examples/Image Classification Task.ipynb"
- "Pretrained Transformer Image Classification Task" : "Examples/Pretrained Transformer Image Classification Task.ipynb"
Expand Down

0 comments on commit a250189

Please sign in to comment.