Skip to content

Commit

Permalink
Update doc re ds_info to clarify that it covers the entire dataset
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 229892151
  • Loading branch information
Ryan Sepassi authored and Copybara-Service committed Jan 18, 2019
1 parent 9bf86e4 commit 5b925ee
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion tensorflow_datasets/core/registered.py
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,9 @@ def load(name,
these will be full datasets as `tf.Tensor`s.
ds_info: `tfds.core.DatasetInfo`, if `with_info` is True, then `tfds.load`
will return a tuple `(ds, ds_info)` containing dataset information
(version, features, splits, num_examples,...).
(version, features, splits, num_examples,...). Note that the `ds_info`
object documents the entire dataset, regardless of the `split` requested.
Split-specific information is available in `ds_info.splits`.
"""
if data_dir is None:
data_dir = constants.DATA_DIR
Expand Down

0 comments on commit 5b925ee

Please sign in to comment.