Skip to content

Commit 6cc374a

Browse files
finalize text on docu page
1 parent b6986e6 commit 6cc374a

4 files changed

Lines changed: 86 additions & 161 deletions

File tree

docs/details.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Advanced User Guide
2+
3+
This document highlights some of the more advanced features of
4+
`openml-python`.
5+
6+
## Configuration
7+
8+
The configuration file resides in a directory `.config/openml` in the
9+
home directory of the user and is called config (More specifically, it
10+
resides in the [configuration directory specified by the XDGB Base
11+
Directory
12+
Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)).
13+
It consists of `key = value` pairs which are separated by newlines. The
14+
following keys are defined:
15+
16+
- apikey: required to access the server.
17+
- server: the server to connect to (default: `http://www.openml.org`).
18+
For connection to the test server, set this to `test.openml.org`.
19+
- cachedir: the root folder where the cache file directories should be created.
20+
If not given, will default to `~/.openml/cache`
21+
- avoid_duplicate_runs: if set to `True` (default), when certain functions
22+
are called a lookup is performed to see if there already
23+
exists such a run on the server. If so, download those
24+
results instead.
25+
- retry_policy: Defines how to react when the server is unavailable or
26+
experiencing high load. It determines both how often to
27+
attempt to reconnect and how quickly to do so. Please don't
28+
use `human` in an automated script that you run more than
29+
one instance of, it might increase the time to complete your
30+
jobs and that of others. One of:
31+
- human (default): For people running openml in interactive
32+
fashion. Try only a few times, but in quick succession.
33+
- robot: For people using openml in an automated fashion. Keep
34+
trying to reconnect for a longer time, quickly increasing
35+
the time between retries.
36+
37+
- connection_n_retries: number of times to retry a request if they fail.
38+
Default depends on retry_policy (5 for `human`, 50 for `robot`)
39+
- verbosity: the level of output:
40+
- 0: normal output
41+
- 1: info output
42+
- 2: debug output
43+
44+
This file is easily configurable by the `openml` command line interface.
45+
To see where the file is stored, and what its values are, use openml
46+
configure none.
47+
48+
## Docker
49+
50+
It is also possible to try out the latest development version of
51+
`openml-python` with docker:
52+
53+
``` bash
54+
docker run -it openml/openml-python
55+
```
56+
57+
See the [openml-python docker
58+
documentation](https://github.com/openml/openml-python/blob/main/docker/readme.md)
59+
for more information.
60+
61+
## Key concepts
62+
63+
OpenML contains several key concepts which it needs to make machine
64+
learning research shareable. A machine learning experiment consists of
65+
one or several **runs**, which describe the performance of an algorithm
66+
(called a **flow** in OpenML), its hyperparameter settings (called a
67+
**setup**) on a **task**. A **Task** is the combination of a
68+
**dataset**, a split and an evaluation metric. In this user guide we
69+
will go through listing and exploring existing **tasks** to actually
70+
running machine learning algorithms on them. In a further user guide we
71+
will examine how to search through **datasets** in order to curate a
72+
list of **tasks**.
73+
74+
A further explanation is given in the [OpenML user
75+
guide](https://openml.github.io/OpenML/#concepts).
76+

docs/index.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ the collaborative machine learning platform
88
OpenML-Python can download or upload data from OpenML, such as datasets
99
and machine learning experiment results.
1010

11+
If you are new to OpenML, we recommend checking out the [OpenML documentation](https://docs.openml.org/)
12+
to get familiar with the concepts and features of OpenML. In particular, we recommend
13+
reading more about the [OpenML concepts](https://docs.openml.org/concepts/).
14+
1115
## :joystick: Minimal Examples
1216

1317
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/):
@@ -43,7 +47,7 @@ Find more examples in the navbar at the top.
4347

4448
## :magic_wand: Installation
4549

46-
OpenML-Python is supported on Python 3.8 - 3.13 and is available on Linux, MacOS, and Windows.
50+
OpenML-Python is available on Linux, MacOS, and Windows.
4751

4852
You can install OpenML-Python with:
4953

@@ -65,9 +69,10 @@ For more advanced installation information, please see the
6569
- [OpenML blog](https://medium.com/open-machine-learning)
6670
- [OpenML twitter account](https://twitter.com/open_ml)
6771

72+
6873
## Contributing
6974

70-
Contribution to the OpenML package is highly appreciated. Please see the
75+
Contributing to the OpenML package is highly appreciated. Please see the
7176
["Contributing"](contributing) page for more information.
7277

7378
## Citing OpenML-Python

docs/usage.md

Lines changed: 0 additions & 155 deletions
This file was deleted.

mkdocs.yml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,11 @@ extra_css:
4242

4343
nav:
4444
- index.md
45-
- Code Reference: reference/
4645
- Examples: examples/
47-
- Usage: usage.md
48-
- Contributing: contributing.md
4946
- Extensions: extensions.md
50-
- Changelog: progress.md
47+
- Details: details.md
48+
- API: reference/
49+
- Contributing: contributing.md
5150

5251
markdown_extensions:
5352
- pymdownx.highlight:

0 commit comments

Comments
 (0)