tff.analytics.data_processing.get_capped_elements
Stay organized with collections
Save and categorize content based on your preferences.
Gets the first max_user_contribution elements from the input dataset.
tff.analytics.data_processing.get_capped_elements(
dataset: tf.data.Dataset,
max_user_contribution: int,
batch_size: int = 1,
string_max_bytes: Optional[int] = None
)
The input dataset must yield batched rank-1 tensors. This function reads
each coordinate of the tensor as an individual element and caps the total
number of elements to return. Note either none of the elements in one batch is
added to the returned result, or all the elements are added. This means the
length of the returned list of elements could be less than
max_user_contribution when dataset is capped.
Args |
|---|
dataset
|
A tf.data.Dataset.
|
max_user_contribution
|
The maximum number of elements to return.
|
batch_size
|
The number of elements in each batch of dataset.
|
string_max_bytes
|
The maximum length (in bytes) of strings in the dataset.
Strings longer than string_max_bytes will be truncated. Defaults to
None, which means there is no limit of the string length.
|
Returns |
|---|
A rank-1 Tensor containing the elements of the input dataset after being
capped. If the total number of elements is less than or equal to
max_user_contribution, returns all the elements in dataset.
|
Raises |
|---|
ValueError
|
-- If the shape of elements in dataset is not rank 1.
-- If max_user_contribution is less than 1.
-- If batch_size is less than 1.
-- If string_max_bytes is not None and is less than 1.
|
TypeError
|
If dataset.element_spec.dtype must be tf.string is not
tf.string.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-20 UTC.
[null,null,["Last updated 2024-09-20 UTC."],[],[],null,["# tff.analytics.data_processing.get_capped_elements\n\n\u003cbr /\u003e\n\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/tensorflow/federated/blob/v0.87.0 Version 2.0, January 2004 Licensed under the Apache License, Version 2.0 (the) |\n\nGets the first `max_user_contribution` elements from the input dataset. \n\n tff.analytics.data_processing.get_capped_elements(\n dataset: tf.data.Dataset,\n max_user_contribution: int,\n batch_size: int = 1,\n string_max_bytes: Optional[int] = None\n )\n\nThe input `dataset` must yield batched rank-1 tensors. This function reads\neach coordinate of the tensor as an individual element and caps the total\nnumber of elements to return. Note either none of the elements in one batch is\nadded to the returned result, or all the elements are added. This means the\nlength of the returned list of elements could be less than\n`max_user_contribution` when `dataset` is capped.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `dataset` | A [`tf.data.Dataset`](https://www.tensorflow.org/api_docs/python/tf/data/Dataset). |\n| `max_user_contribution` | The maximum number of elements to return. |\n| `batch_size` | The number of elements in each batch of `dataset`. |\n| `string_max_bytes` | The maximum length (in bytes) of strings in the dataset. Strings longer than `string_max_bytes` will be truncated. Defaults to `None`, which means there is no limit of the string length. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|---|---|\n| A rank-1 Tensor containing the elements of the input dataset after being capped. If the total number of elements is less than or equal to `max_user_contribution`, returns all the elements in `dataset`. ||\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ValueError` | -- If the shape of elements in `dataset` is not rank 1. -- If `max_user_contribution` is less than 1. -- If `batch_size` is less than 1. -- If `string_max_bytes` is not `None` and is less than 1. |\n| `TypeError` | If `dataset.element_spec.dtype` must be [`tf.string`](https://www.tensorflow.org/api_docs/python/tf#string) is not [`tf.string`](https://www.tensorflow.org/api_docs/python/tf#string). |\n\n\u003cbr /\u003e"]]
View source on GitHub