Commit 443c3079 authored by Alykhan Tejani's avatar Alykhan Tejani Committed by GitHub
Browse files

Update docstring for svhn (#267)

update SVHN docs to note label change for digit 0
parent 918fdffd
...@@ -176,6 +176,10 @@ STL10 ...@@ -176,6 +176,10 @@ STL10
SVHN SVHN
~~~~ ~~~~
Note: The SVHN dataset assigns the label `10` to the digit `0`. However, in this Dataset,
we assign the label `0` to the digit `0` to be compatible with PyTorch loss functions which
expect the class labels to be in the range `[0, C-1]`
``dset.SVHN(root, split='train', transform=None, target_transform=None, download=False)`` ``dset.SVHN(root, split='train', transform=None, target_transform=None, download=False)``
- ``root`` : root directory of dataset where there is folder ``SVHN`` - ``root`` : root directory of dataset where there is folder ``SVHN``
......
...@@ -9,6 +9,9 @@ from .utils import download_url, check_integrity ...@@ -9,6 +9,9 @@ from .utils import download_url, check_integrity
class SVHN(data.Dataset): class SVHN(data.Dataset):
"""`SVHN <http://ufldl.stanford.edu/housenumbers/>`_ Dataset. """`SVHN <http://ufldl.stanford.edu/housenumbers/>`_ Dataset.
Note: The SVHN dataset assigns the label `10` to the digit `0`. However, in this Dataset,
we assign the label `0` to the digit `0` to be compatible with PyTorch loss functions which
expect the class labels to be in the range `[0, C-1]`
Args: Args:
root (string): Root directory of dataset where directory root (string): Root directory of dataset where directory
......
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