Commit 09468c99 authored by TruscaPetre's avatar TruscaPetre Committed by Facebook GitHub Bot
Browse files

Fix confusing wording in the documentation (#2937)

Summary:
I have spent 2 hours because I read the documentation wrongly and trying to figure out why the I couldn't read the data from the dataset. The initial phrase was very confusing.

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

Reviewed By: mthrok

Differential Revision: D42280738

Pulled By: nateanl

fbshipit-source-id: a48b9bc27d44ca8106bd56f805294a5a0e3ede1b
parent 7b5317b3
...@@ -18,8 +18,8 @@ class LibriMix(Dataset): ...@@ -18,8 +18,8 @@ class LibriMix(Dataset):
r"""*LibriMix* :cite:`cosentino2020librimix` dataset. r"""*LibriMix* :cite:`cosentino2020librimix` dataset.
Args: Args:
root (str or Path): The path to the directory where the directory ``Libri2Mix`` or root (str or Path): The path where the directory ``Libri2Mix`` or
``Libri3Mix`` is stored. ``Libri3Mix`` is stored. Not the path of those directories.
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"``). ``"dev"``, and ``"test"``] (Default: ``"train-360"``).
num_speakers (int, optional): The number of speakers, which determines the directories num_speakers (int, optional): The number of speakers, which determines the directories
......
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