# tff.framework.CardinalityFreeDataDescriptor

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) 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) |

Represent data-yielding computations with unspecified cardinalities.

Inherits From: [`Ingestable`](https://www.tensorflow.org/federated/api_docs/python/tff/framework/Ingestable), [`TypedObject`](https://www.tensorflow.org/federated/api_docs/python/tff/TypedObject)

    tff.framework.CardinalityFreeDataDescriptor(
        comp: Optional[https://www.tensorflow.org/federated/api_docs/python/tff/Computation],
        arg: object,
        arg_type: https://www.tensorflow.org/federated/api_docs/python/tff/types/Type
    )

Instances of this class are objects that may combine a federated computation
that returns federated data and an argument to be supplied as input to this
computation, or alternatively the argument alone. These objects are designed
to be recognized by the runtime. When ingesting those objects (e.g., as they
are passed as arguments to a computation invocation), the runtime ingests
the argument, and (if provided) invokes the computation contained
in this descriptor on this argument to cause the data to materialize within
the runtime (but without marshaling it out and returning it to user).

In the typical usage of this helper class, the embedded argument is a set of
handles, and the embedded computation transforms those handles into physical
[`tf.data.Dataset`](https://www.tensorflow.org/api_docs/python/tf/data/Dataset) instances. This transformation occurs on the clients (i.e.,
in the TFF runtime worker processes).

Alternatively, the argument itself may consist of computations to be locally
executed on the clients. In this case, the computation can be omitted.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `comp` | The computation that materializes the data, of some type `(T -> U)` where `T` is the type of the argument `arg` and `U` is the type of the materialized data that's being produced. This can be `None`, in which case it's assumed to be an identity function (and `T` in that case must be identical to `U`). |
| `arg` | The argument to be passed as input to `comp` if `comp` is not `None`, or to be treated as the computed result. Must be recognized by the TFF runtime as a payload of type `T`. |
| `arg_type` | The type of the argument (`T` references above). An instance of [`tff.Type`](https://www.tensorflow.org/federated/api_docs/python/tff/types/Type). |

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| `ValueError` | if the arguments don't satisfy the constraints listed above. |

<br />

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `type_signature` | Returns the TFF type of this object (an instance of [`tff.Type`](https://www.tensorflow.org/federated/api_docs/python/tff/types/Type)). |

<br />

## Methods

### `ingest`

[View source](https://github.com/tensorflow/federated/blob/v0.87.0
Version 2.0, January 2004
Licensed under the Apache License, Version 2.0 (the)

    ingest(
        executor
    )

Causes this object to ingest itself into the given executor.

<br />

<br />

<br />

| Args ||
|---|---|
| `executor` | An instance of `executor_base.Executor` to ingest into. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| An instance of `executor_value_base.ExecutorValue` returned by the executor. ||

<br />