Skip to content
Merged
Prev Previous commit
Next Next commit
Updated the comments for get_dataset and get_datasets to include new …
…parameter
  • Loading branch information
Mohamed Adel committed Jan 12, 2021
commit 611d2bf926cfa14835b9c620a3c242dc34dd5259
1 change: 1 addition & 0 deletions doc/progress.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Changelog
* MAINT #671: Improved the performance of ``check_datasets_active`` by only querying the given list of datasets in contrast to querying all datasets. Modified the corresponding unit test.
* FIX #964 : AValidate `ignore_attribute`, `default_target_attribute`, `row_id_attribute` are set to attributes that exist on the dataset when calling ``create_dataset``.
* DOC #973 : Change the task used in the welcome page example so it no longer fails using numerical dataset.
* ADD #1009 : Give possibility to not download the dataset qualities. The cached version is used even so download attribute is false.
0.11.0
~~~~~~
* ADD #753: Allows uploading custom flows to OpenML via OpenML-Python.
Expand Down
4 changes: 4 additions & 0 deletions openml/datasets/functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,8 @@ def _name_to_id(
error_if_multiple : bool (default=False)
If `False`, if multiple datasets match, return the least recent active dataset.
If `True`, if multiple datasets match, raise an error.
download_qualities : bool, optional
Comment thread
a-moadel marked this conversation as resolved.
Outdated
If `True`, also download qualities.xml file. If false use the file if it was cached.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update this and the other references where it says the cached version is used if false is passed, as this is not the behavior anymore.


Returns
-------
Expand Down Expand Up @@ -326,6 +328,8 @@ def get_datasets(
make the operation noticeably slower. Metadata is also still retrieved.
If False, create the OpenMLDataset and only populate it with the metadata.
The data may later be retrieved through the `OpenMLDataset.get_data` method.
download_qualities : bool, optional
Comment thread
a-moadel marked this conversation as resolved.
Outdated
If True, also download qualities.xml file. If false use the file if it was cached.

Returns
-------
Expand Down