Skip to content

Commit ec24894

Browse files
aaudibertensorflower-gardener
authored andcommitted
[tf.data] Improve SplitProvider class-level doc.
PiperOrigin-RevId: 367489489 Change-Id: Icfeffb52217c2df9ef54e8a4f47b3f9e2a156351
1 parent f6c24a2 commit ec24894

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

tensorflow/core/framework/dataset.h

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -317,8 +317,16 @@ class Runner {
317317
static Runner* get();
318318
};
319319

320-
// A class which provides a sequence of splits. Iterators created with a split
321-
// provider will iterate over only the splits provided by the split provider.
320+
// A class which provides a sequence of splits. Splits represent subdivisions of
321+
// a dataset, e.g. filenames or ranges within files. We use splitting to
322+
// partition input data into smaller pieces for distributed processing (see
323+
// go/tf-data-splitting-design).
324+
//
325+
// Datasets provide a `MakeSplitProvider` method to expose a listing of their
326+
// splits.
327+
//
328+
// Iterators created with a split provider will only iterate over the splits
329+
// provided by the split provider.
322330
class SplitProvider {
323331
public:
324332
virtual ~SplitProvider() {}

0 commit comments

Comments
 (0)