From 06b1beb7c969cc46b6aa973e45d61cb1a2b23c86 Mon Sep 17 00:00:00 2001 From: Anvitha Date: Mon, 17 Nov 2025 01:40:55 +0530 Subject: [PATCH] fixed few broken links and cleaned up grammar --- docs/details.md | 8 ++++---- docs/extensions.md | 12 ++++++------ docs/index.md | 2 +- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/details.md b/docs/details.md index bf4b0cd2b..c1bb8fa9f 100644 --- a/docs/details.md +++ b/docs/details.md @@ -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 diff --git a/docs/extensions.md b/docs/extensions.md index 858447440..e53ade266 100644 --- a/docs/extensions.md +++ b/docs/extensions.md @@ -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 @@ -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. @@ -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] @@ -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 diff --git a/docs/index.md b/docs/index.md index 1058c3956..5a1d698f3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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.