Skip to content

Commit cad1da9

Browse files
Fix docstring of inspect_dataset (#4438)
* Fix docstring of inspect_dataset * Fix **download_kwargs * Fix links and rephrase
1 parent a82f65a commit cad1da9

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

src/datasets/inspect.py

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -102,19 +102,21 @@ def list_metrics(with_community_metrics=True, with_details=False):
102102

103103

104104
def inspect_dataset(path: str, local_path: str, download_config: Optional[DownloadConfig] = None, **download_kwargs):
105-
r"""
105+
"""
106106
Allow inspection/modification of a dataset script by copying on local drive at local_path.
107107
108108
Args:
109-
path (``str``): path to the dataset processing script with the dataset builder. Can be either:
110-
111-
- a local path to processing script or the directory containing the script (if the script has the same name as the directory),
112-
e.g. ``'./dataset/squad'`` or ``'./dataset/squad/squad.py'``
113-
- a dataset identifier on the Hugging Face Hub (list all available datasets and ids with ``datasets.list_datasets()``)
114-
e.g. ``'squad'``, ``'glue'`` or ``'openai/webtext'``
115-
local_path (``str``): path to the local folder to copy the datset script to.
116-
download_config (Optional ``datasets.DownloadConfig``: specific download configuration parameters.
117-
**download_kwargs: optional attributes for DownloadConfig() which will override the attributes in download_config if supplied.
109+
path (`str`): Path to the dataset processing script with the dataset builder. Can be either:
110+
111+
- a local path to processing script or the directory containing the script (if the script has the same name
112+
as the directory),
113+
e.g. ``'./dataset/squad'`` or ``'./dataset/squad/squad.py'``.
114+
- a dataset identifier on the Hugging Face Hub (list all available datasets and ids with [`list_datasets`])
115+
e.g. ``'squad'``, ``'glue'`` or ``'openai/webtext'``.
116+
local_path (`str`): Path to the local folder to copy the dataset script to.
117+
download_config ([`DownloadConfig`], *optional*): Specific download configuration parameters.
118+
**download_kwargs (additional keyword arguments): Optional arguments for [`DownloadConfig`] which will override
119+
the attributes of `download_config` if supplied.
118120
"""
119121
dataset_module = dataset_module_factory(
120122
path, download_config=download_config, force_local_path=local_path, **download_kwargs

0 commit comments

Comments
 (0)