From 5b925ee214a5090c4faf4315346adccf2caa87d6 Mon Sep 17 00:00:00 2001 From: Ryan Sepassi Date: Fri, 18 Jan 2019 01:33:53 -0800 Subject: [PATCH] Update doc re ds_info to clarify that it covers the entire dataset PiperOrigin-RevId: 229892151 --- tensorflow_datasets/core/registered.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tensorflow_datasets/core/registered.py b/tensorflow_datasets/core/registered.py index 4a860b3925c..7050f993229 100644 --- a/tensorflow_datasets/core/registered.py +++ b/tensorflow_datasets/core/registered.py @@ -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