tfr.data.build_ranking_dataset

Builds a ranking tf.dataset with a standard data format.

tfr.data.build_ranking_dataset(
    file_pattern,
    data_format,
    batch_size,
    context_feature_spec,
    example_feature_spec,
    list_size=None,
    size_feature_name=None,
    mask_feature_name=None,
    shuffle_examples=False,
    seed=None,
    **kwargs
)

file_pattern See build_ranking_dataset_with_parsing_fn.
data_format See make_parsing_fn.
batch_size See build_ranking_dataset_with_parsing_fn.
context_feature_spec See make_parsing_fn.
example_feature_spec See make_parsing_fn.
list_size See make_parsing_fn.
size_feature_name (str) Name of feature for example list sizes. Populates the feature dictionary with a tf.int32 Tensor of shape [batch_size] for this feature name. If None, which is default, this feature is not generated.
mask_feature_name (str) Name of feature for example list masks. Populates the feature dictionary with a tf.bool Tensor of shape [batch_size, list_size] for this feature name. If None, which is default, this feature is not generated.
shuffle_examples (bool) A boolean to indicate whether examples within a list are shuffled before the list is trimmed down to list_size elements (when list has more than list_size elements).
seed (int) A seed passed onto random_ops.uniform() to shuffle examples.
**kwargs The kwargs passed to build_ranking_dataset_with_parsing_fn.

See build_ranking_dataset_with_parsing_fn.