From bf6d010ad7c681e94b8fb8323314c42b4b81b607 Mon Sep 17 00:00:00 2001 From: Lennart Purucker Date: Fri, 18 Oct 2024 09:57:32 +0200 Subject: [PATCH] docs: fix borken links after openml.org rework (#1376) --- doc/index.rst | 2 +- doc/usage.rst | 2 +- examples/40_paper/2015_neurips_feurer_example.py | 4 ++-- openml/datasets/functions.py | 2 +- openml/runs/functions.py | 6 ++---- 5 files changed, 7 insertions(+), 9 deletions(-) diff --git a/doc/index.rst b/doc/index.rst index a3b13c9e8..4ab56f5c3 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -71,7 +71,7 @@ Further information * `OpenML documentation `_ * `OpenML client APIs `_ -* `OpenML developer guide `_ +* `OpenML developer guide `_ * `Contact information `_ * `Citation request `_ * `OpenML blog `_ diff --git a/doc/usage.rst b/doc/usage.rst index 8c713b586..f6476407e 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -118,7 +118,7 @@ this should be repeated several times. Also, the task defines a target metric for which a flow should be optimized. Below you can find our tutorial regarding tasks and if you want to know more -you can read the `OpenML guide `_: +you can read the `OpenML guide `_: * :ref:`sphx_glr_examples_30_extended_tasks_tutorial.py` diff --git a/examples/40_paper/2015_neurips_feurer_example.py b/examples/40_paper/2015_neurips_feurer_example.py index 3960c3852..ae59c9ced 100644 --- a/examples/40_paper/2015_neurips_feurer_example.py +++ b/examples/40_paper/2015_neurips_feurer_example.py @@ -49,14 +49,14 @@ # this does not allow reproducibility (unclear splitting). Please do not use datasets but the # respective tasks as basis for a paper and publish task IDS. This example is only given to # showcase the use of OpenML-Python for a published paper and as a warning on how not to do it. -# Please check the `OpenML documentation of tasks `_ if you +# Please check the `OpenML documentation of tasks `_ if you # want to learn more about them. #################################################################################################### # This lists both active and inactive tasks (because of ``status='all'``). Unfortunately, # this is necessary as some of the datasets contain issues found after the publication and became # deactivated, which also deactivated the tasks on them. More information on active or inactive -# datasets can be found in the `online docs `_. +# datasets can be found in the `online docs `_. tasks = openml.tasks.list_tasks( task_type=openml.tasks.TaskType.SUPERVISED_CLASSIFICATION, status="all", diff --git a/openml/datasets/functions.py b/openml/datasets/functions.py index 0901171d6..61577d9a2 100644 --- a/openml/datasets/functions.py +++ b/openml/datasets/functions.py @@ -861,7 +861,7 @@ def status_update(data_id: int, status: Literal["active", "deactivated"]) -> Non Updates the status of a dataset to either 'active' or 'deactivated'. Please see the OpenML API documentation for a description of the status and all legal status transitions: - https://docs.openml.org/#dataset-status + https://docs.openml.org/concepts/data/#dataset-status Parameters ---------- diff --git a/openml/runs/functions.py b/openml/runs/functions.py index b16af0b80..46b46b751 100644 --- a/openml/runs/functions.py +++ b/openml/runs/functions.py @@ -74,8 +74,7 @@ def run_model_on_task( # noqa: PLR0913 ---------- model : sklearn model A model which has a function fit(X,Y) and predict(X), - all supervised estimators of scikit learn follow this definition of a model - (https://scikit-learn.org/stable/tutorial/statistical_inference/supervised_learning.html) + all supervised estimators of scikit learn follow this definition of a model. task : OpenMLTask or int or str Task to perform or Task id. This may be a model instead if the first argument is an OpenMLTask. @@ -199,8 +198,7 @@ def run_flow_on_task( # noqa: C901, PLR0912, PLR0915, PLR0913 flow : OpenMLFlow A flow wraps a machine learning model together with relevant information. The model has a function fit(X,Y) and predict(X), - all supervised estimators of scikit learn follow this definition of a model - (https://scikit-learn.org/stable/tutorial/statistical_inference/supervised_learning.html) + all supervised estimators of scikit learn follow this definition of a model. task : OpenMLTask Task to perform. This may be an OpenMLFlow instead if the first argument is an OpenMLTask. avoid_duplicate_runs : bool, optional (default=True)