Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding config file to user guide #931

Merged
merged 2 commits into from
Jul 14, 2020
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions doc/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,37 @@ the OpenML Python connector, followed up by a simple example.

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

~~~~~~~~~~~~~
Configuration
~~~~~~~~~~~~~

The configuration file resides in a directory ``.openml`` in the home
directory of the user and is called config. It consists of ``key = value`` pairs
which are separated by newlines. The following keys are defined:

* apikey:
* required to access the server
marcoslbueno marked this conversation as resolved.
Show resolved Hide resolved

* server:
* default: ``http://www.openml.org``
marcoslbueno marked this conversation as resolved.
Show resolved Hide resolved

* cachedir:
* if not given, will default to ``file.path(tempdir(), "cache")``.
marcoslbueno marked this conversation as resolved.
Show resolved Hide resolved

* avoid_duplicate_runs:
* if not given, will default to ``True``.
marcoslbueno marked this conversation as resolved.
Show resolved Hide resolved

* connection_n_retries:
* default: 2. Maximum number of retries: 20.
marcoslbueno marked this conversation as resolved.
Show resolved Hide resolved

* verbosity:
* 0: normal output
* 1: info output
* 2: debug output

* arff.reader:
marcoslbueno marked this conversation as resolved.
Show resolved Hide resolved
* ``RWeka``: This is the standard Java parser used in Weka.
* ``farff``: The `farff package <http://www.github.com/mlr-org/farff>`_ lives below the mlr-org and is a newer, faster parser without Java.

~~~~~~~~~~~~
Key concepts
Expand Down