tff.framework.DataDescriptor
Stay organized with collections
Save and categorize content based on your preferences.
Represents fully-specified data-yielding computations.
Inherits From: CardinalityFreeDataDescriptor, Ingestable, TypedObject, CardinalityCarrying
tff.framework.DataDescriptor(
comp: Optional[tff.Computation],
arg: object,
arg_type: tff.types.Type,
cardinality: Optional[int] = None
)
Similar to CardinalityFreeDataDescriptor, but additionally accepts a
cardinality argument, allowing callers to explcitly specify the number
of clients this data descriptor is intended to represent.
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.
|
cardinality
|
If of federated type, placed at clients, this int specifies
the number of clients represented by this DataDescriptor.
|
Raises |
|---|
ValueError
|
if the arguments don't satisfy the constraints listed above.
|
Attributes |
|---|
cardinality
|
Returns the cardinality information associated with this object.
|
type_signature
|
Returns the TFF type of this object (an instance of tff.Type).
|
Methods
ingest
View source
ingest(
executor
)
Causes this object to ingest itself into the given executor.
| Args |
|---|
executor
|
An instance of executor_base.Executor to ingest into.
|
| Returns |
|---|
An instance of executor_value_base.ExecutorValue returned by the
executor.
|
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.framework.DataDescriptor\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\nRepresents fully-specified data-yielding computations.\n\nInherits From: [`CardinalityFreeDataDescriptor`](../../tff/framework/CardinalityFreeDataDescriptor), [`Ingestable`](../../tff/framework/Ingestable), [`TypedObject`](../../tff/TypedObject), [`CardinalityCarrying`](../../tff/framework/CardinalityCarrying) \n\n tff.framework.DataDescriptor(\n comp: Optional[../../tff/Computation],\n arg: object,\n arg_type: ../../tff/types/Type,\n cardinality: Optional[int] = None\n )\n\nSimilar to CardinalityFreeDataDescriptor, but additionally accepts a\ncardinality argument, allowing callers to explcitly specify the number\nof clients this data descriptor is intended to represent.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `comp` | The computation that materializes the data, of some type `(T -\u003e 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`). |\n| `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`. |\n| `arg_type` | The type of the argument (`T` references above). An instance of [`tff.Type`](../../tff/types/Type). |\n| `cardinality` | If of federated type, placed at clients, this int specifies the number of clients represented by this DataDescriptor. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|--------------|--------------------------------------------------------------|\n| `ValueError` | if the arguments don't satisfy the constraints listed above. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Attributes ---------- ||\n|------------------|------------------------------------------------------------------------------------------|\n| `cardinality` | Returns the cardinality information associated with this object. |\n| `type_signature` | Returns the TFF type of this object (an instance of [`tff.Type`](../../tff/types/Type)). |\n\n\u003cbr /\u003e\n\nMethods\n-------\n\n### `ingest`\n\n[View source](https://github.com/tensorflow/federated/blob/v0.87.0\nVersion 2.0, January 2004\nLicensed under the Apache License, Version 2.0 (the) \n\n ingest(\n executor\n )\n\nCauses this object to ingest itself into the given executor.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ||\n|------------|---------------------------------------------------------|\n| `executor` | An instance of `executor_base.Executor` to ingest into. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ||\n|---|---|\n| An instance of `executor_value_base.ExecutorValue` returned by the executor. ||\n\n\u003cbr /\u003e"]]
View source on GitHub