Skip to content

Commit 1670050

Browse files
authored
adding config file to user guide (#931)
* adding config file to user guide * finished requested changes
1 parent e5dcaf0 commit 1670050

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

doc/usage.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,35 @@ the OpenML Python connector, followed up by a simple example.
2929

3030
* `Introduction <examples/introduction_tutorial.html>`_
3131

32+
~~~~~~~~~~~~~
33+
Configuration
34+
~~~~~~~~~~~~~
35+
36+
The configuration file resides in a directory ``.openml`` in the home
37+
directory of the user and is called config. It consists of ``key = value`` pairs
38+
which are separated by newlines. The following keys are defined:
39+
40+
* apikey:
41+
* required to access the server. The `OpenML setup <https://openml.github.io/openml-python/master/examples/20_basic/introduction_tutorial.html#authentication>`_ describes how to obtain an API key.
42+
43+
* server:
44+
* default: ``http://www.openml.org``. Alternatively, use ``test.openml.org`` for the test server.
45+
46+
* cachedir:
47+
* if not given, will default to ``~/.openml/cache``
48+
49+
* avoid_duplicate_runs:
50+
* if set to ``True``, when ``run_flow_on_task`` or similar methods are called a lookup is performed to see if there already exists such a run on the server. If so, download those results instead.
51+
* if not given, will default to ``True``.
52+
53+
* connection_n_retries:
54+
* number of connection retries.
55+
* default: 2. Maximum number of retries: 20.
56+
57+
* verbosity:
58+
* 0: normal output
59+
* 1: info output
60+
* 2: debug output
3261

3362
~~~~~~~~~~~~
3463
Key concepts

0 commit comments

Comments
 (0)