Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
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
8 changes: 4 additions & 4 deletions docs/details.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ This document highlights some of the more advanced features of

## Configuration

The configuration file resides in a directory `.config/openml` in the
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
resides in the [configuration directory specified by the XDG 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.
- server: the server to connect to (default: `http://www.openml.org`).
For connection to the test server, set this to `test.openml.org`.
- server: the server to connect to (default: `https://www.openml.org`).
For connection to the test server, set this to `https://test.openml.org`.
- cachedir: the root folder where the cache file directories should be created.
If not given, will default to `~/.openml/cache`
- avoid_duplicate_runs: if set to `True` (default), when certain functions
Expand Down
12 changes: 6 additions & 6 deletions docs/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ to upload it. However, in order to simplify the process of uploading
flows and runs from a specific library, an additional interface can be
built. The OpenML-Python team does not have the capacity to develop and
maintain such interfaces on its own. For this reason, we have built an
extension interface to allows others to contribute back. Building a
suitable extension for therefore requires an understanding of the
extension interface to allow others to contribute back. Building a
suitable extension therefore requires an understanding of the
current OpenML-Python support.

[This tutorial](../examples/Basics/simple_flows_and_runs_tutorial) shows how the scikit-learn
Expand Down Expand Up @@ -65,8 +65,8 @@ and can be implemented in several lines of code.
Typically, the flow-dependency field is used to check whether
the specific library is present, and no unknown libraries are
present there.
- `can_handle_model`: Similar as
`can_handle_flow`:, except that in
- `can_handle_model`: Similar to
`can_handle_flow`, except that in
this case a Python object is given. As such, in many cases, this
method can be implemented by checking whether this adheres to a
certain base class.
Expand Down Expand Up @@ -138,7 +138,7 @@ Each extension created should be a stand-alone repository, compatible
with the [OpenML-Python repository](https://github.com/openml/openml-python).
The extension repository should work off-the-shelf with *OpenML-Python* installed.

Create a public Github repo with the following directory structure:
Create a public GitHub repo with the following directory structure:

| [repo name]
| |-- [extension name]
Expand All @@ -149,7 +149,7 @@ Create a public Github repo with the following directory structure:
### Recommended

- Test cases to keep the extension up to date with the
Openml-Python upstream changes.
OpenML-Python upstream changes.
- Documentation of the extension API, especially if any new
functionality added to OpenML-Python\'s extension design.
- Examples to show how the new extension interfaces and works with
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,4 +100,4 @@ appreciate a reference to our JMLR-MLOSS paper

Feurer, Matthias, et al.
"OpenML-Python: an extensible Python API for OpenML."
_Journal of Machine Learning Research_ 22.100 (2021):1−5.
_Journal of Machine Learning Research_ 22.100 (2021): 1−5.