Improve docstring for split_dataset.
@@ -34,13 +34,13 @@ def split_dataset(
"""Split a dataset into a left half and a right half (e.g. train / test).
Args:
- dataset: A `tf.data.Dataset` object or a list/tuple of arrays with the
+ dataset: A `tf.data.Dataset` object, or a list/tuple of arrays with the
same length.
- left_size: If float, it should be in range `[0, 1]` range and signifies
+ left_size: If float (in the range `[0, 1]`), it signifies
the fraction of the data to pack in the left dataset. If integer, it
signifies the number of samples to pack in the left dataset. If
`None`, it defaults to the complement to `right_size`.
- right_size: If float, it should be in range `[0, 1]` range and signifies
+ right_size: If float (in the range `[0, 1]`), it signifies
the fraction of the data to pack in the right dataset. If integer, it
signifies the number of samples to pack in the right dataset. If
`None`, it defaults to the complement to `left_size`.
@@ -49,6 +49,16 @@ def split_dataset(
Returns:
A tuple of two `tf.data.Dataset` objects: the left and right splits.
+
+ Example:
+
+ >>> data = np.random.random(size=(1000, 4))
+ >>> left_ds, right_ds = tf.keras.utils.split_dataset(data, left_size=0.8)
+ >>> int(left_ds.cardinality())
+ 800
+ >>> int(right_ds.cardinality())
+ 200
+
"""
dataset_type_spec = _get_type_spec(dataset)
