Skip to content

Commit 01626c5

Browse files
committed
Explicit param description
1 parent 51a66d4 commit 01626c5

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

tensorflow_datasets/core/dataset_info.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,12 @@ def __init__(self,
109109
features: `tfds.features.FeaturesDict`, Information on the feature dict
110110
of the `tf.data.Dataset()` object from the `builder.as_dataset()`
111111
method.
112-
supervised_keys: `tuple`, Specifies the input feature and the label for
113-
supervised learning, if applicable for the dataset.
112+
supervised_keys: `tuple` of size two, optional. The first item is
113+
the key from `features` corresponding to a single feature
114+
representing the input, the second item is the key of the
115+
"feature" containing the label for supervised learning,
116+
if applicable for the dataset. Used for transforming the dataset in
117+
`tfds.core.DatasetBuilder.as_dataset()`.
114118
urls: `list(str)`, optional, the homepage(s) for this dataset.
115119
citation: `str`, optional, the citation to use for this dataset.
116120
metadata: `tfds.core.Metadata`, additonal object which will be

0 commit comments

Comments
 (0)