Skip to content

Minor fixes to usage.rst #1090

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.

Sign up for GitHub

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

Merged
PGijsbers merged 1 commit into from
May 31, 2021
Merged

Minor fixes to usage.rst #1090

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions doc/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,18 @@ machine learning algorithms on them and then share the results online.
The following tutorial gives a short introduction on how to install and set up
the OpenML Python connector, followed up by a simple example.

* `:ref:`sphx_glr_examples_20_basic_introduction_tutorial.py`
* :ref:`sphx_glr_examples_20_basic_introduction_tutorial.py`

~~~~~~~~~~~~~
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:
The configuration file resides in a directory ``.config/openml`` in the home
directory of the user and is called config (More specifically, it resides in the
`configuration directory specified by the XDGB Base Directory Specification
<https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_).
It consists of ``key = value`` pairs which are separated by newlines.
The following keys are defined:

* apikey:
* required to access the server. The :ref:`sphx_glr_examples_20_basic_introduction_tutorial.py`
Expand Down