Skip to content

Commit ccb3e8e

Browse files
authored
Fix outdated docstring for list_tasks function (#1149)
1 parent a8d96d5 commit ccb3e8e

2 files changed

Lines changed: 3 additions & 19 deletions

File tree

doc/progress.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Changelog
88

99
0.13.0
1010
~~~~~~
11+
* MAINT#1104: Fix outdated docstring for ``list_task``.
1112
* FIX#1030: ``pre-commit`` hooks now no longer should issue a warning.
1213
* FIX#1110: Make arguments to ``create_study`` and ``create_suite`` that are defined as optional by the OpenML XSD actually optional.
1314
* FIX#1147: ``openml.flow.flow_exists`` no longer requires an API key.

openml/tasks/functions.py

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -135,15 +135,7 @@ def list_tasks(
135135
it is used as task_type in the task description, but it is named
136136
type when used as a filter in list tasks call.
137137
task_type : TaskType, optional
138-
ID of the task type as detailed `here <https://www.openml.org/search?type=task_type>`_.
139-
- Supervised classification: 1
140-
- Supervised regression: 2
141-
- Learning curve: 3
142-
- Supervised data stream classification: 4
143-
- Clustering: 5
144-
- Machine Learning Challenge: 6
145-
- Survival Analysis: 7
146-
- Subgroup Discovery: 8
138+
Refers to the type of task.
147139
offset : int, optional
148140
the number of tasks to skip, starting from the first
149141
size : int, optional
@@ -196,16 +188,7 @@ def _list_tasks(task_type=None, output_format="dict", **kwargs):
196188
it is used as task_type in the task description, but it is named
197189
type when used as a filter in list tasks call.
198190
task_type : TaskType, optional
199-
ID of the task type as detailed
200-
`here <https://www.openml.org/search?type=task_type>`_.
201-
- Supervised classification: 1
202-
- Supervised regression: 2
203-
- Learning curve: 3
204-
- Supervised data stream classification: 4
205-
- Clustering: 5
206-
- Machine Learning Challenge: 6
207-
- Survival Analysis: 7
208-
- Subgroup Discovery: 8
191+
Refers to the type of task.
209192
output_format: str, optional (default='dict')
210193
The parameter decides the format of the output.
211194
- If 'dict' the output is a dict of dict

0 commit comments

Comments
 (0)