Commit 94653bf4 authored by Caroline Chen's avatar Caroline Chen Committed by Facebook GitHub Bot
Browse files

Dataset doc fixes (#2426)

Summary: Pull Request resolved: https://github.com/pytorch/audio/pull/2426

Reviewed By: nateanl

Differential Revision: D36791423

Pulled By: carolineechen

fbshipit-source-id: e011147a716c940755032b8c68f5717d11fc91bf
parent 6057d3cf
......@@ -48,7 +48,7 @@ class LibriLightLimited(Dataset):
Args:
root (str or Path): Path to the directory where the dataset is found or downloaded.
subset (str, optional): The subset to use. Options: [``10min`, ``1h``, ``10h``]
subset (str, optional): The subset to use. Options: [``10min``, ``1h``, ``10h``]
(Default: ``10min``).
download (bool, optional):
Whether to download the dataset if it is not found at root path. (default: ``False``).
......
......@@ -14,7 +14,7 @@ class LibriMix(Dataset):
Args:
root (str or Path): The path to the directory where the directory ``Libri2Mix`` or
``Libri3Mix`` is stored.
subset (str, optional): The subset to use. Options: [``train-360`, ``train-100``,
subset (str, optional): The subset to use. Options: [``train-360``, ``train-100``,
``dev``, and ``test``] (Default: ``train-360``).
num_speakers (int, optional): The number of speakers, which determines the directories
to traverse. The Dataset will traverse ``s1`` to ``sN`` directories to collect
......
......@@ -27,10 +27,10 @@ class QUESST14(Dataset):
Args:
root (str or Path): Root directory where the dataset's top level directory is found
subset (str): Subset of the dataset to use. Options: [``"docs"``, ``"dev"``, ``"eval"``].
language (str or None, optional): Language to get dataset for.
Options: [None, ``albanian``, ``basque``, ``czech``, `nnenglish``, ``romanian``, ``slovak``].
(default: ``"nnenglish"``)
subset (str): subset of the dataset to use. Options: ["docs", "dev", "eval"].
Options: [``None``, ``albanian``, ``basque``, ``czech``, ``nnenglish``, ``romanian``, ``slovak``].
If ``None``, dataset consists of all languages. (default: ``"nnenglish"``)
download (bool, optional): Whether to download the dataset if it is not found at root path.
(default: ``False``)
"""
......@@ -38,11 +38,11 @@ class QUESST14(Dataset):
def __init__(
self,
root: Union[str, Path],
subset: str,
language: Optional[str] = "nnenglish",
subset: Optional[str] = None,
download: bool = False,
) -> None:
assert subset is None or subset in ["docs", "dev", "eval"], "`subset` must be one of ['docs', 'dev', 'eval']"
assert subset in ["docs", "dev", "eval"], "`subset` must be one of ['docs', 'dev', 'eval']"
assert language is None or language in _LANGUAGES, f"`language` must be None or one of {str(_LANGUAGES)}"
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment