tff.framework.Selection
Stay organized with collections
Save and categorize content based on your preferences.
A selection by name or index from a struct-typed value in TFF's language.
Inherits From: ComputationBuildingBlock, TypedObject
tff.framework.Selection(
source: tff.framework.ComputationBuildingBlock,
name: Optional[str] = None,
index: Optional[int] = None
)
The concise syntax for selections is foo.bar (selecting a named bar from
the value of expression foo), and foo[n] (selecting element at index n
from the value of foo).
Args |
|---|
source
|
The source value to select from (an instance of
ComputationBuildingBlock).
|
name
|
A string name of the element to be selected.
|
index
|
A numeric index of the element to be selected.
|
Raises |
|---|
TypeError
|
if arguments are of the wrong types.
|
ValueError
|
if the name is empty or index is negative, or the name/index
is not compatible with the type signature of the source, or neither or
both are defined (not None).
|
Attributes |
|---|
index
|
|
name
|
|
proto
|
Returns a serialized form of this object as a pb.Computation instance.
|
source
|
|
type_signature
|
Returns the TFF type of this object (an instance of tff.Type).
|
Methods
as_index
View source
as_index() -> int
children
View source
children() -> Iterator[tff.framework.ComputationBuildingBlock]
Returns an iterator yielding immediate child building blocks.
compact_representation
View source
compact_representation()
Returns the compact string representation of this building block.
View source
formatted_representation()
Returns the formatted string representation of this building block.
from_proto
View source
@classmethod
from_proto(
computation_proto: pb.Computation
) -> 'Selection'
Returns an instance of a derived class based on 'computation_proto'.
| Args |
|---|
computation_proto
|
An instance of pb.Computation.
|
| Returns |
|---|
|
An instance of a class that implements 'ComputationBuildingBlock' and
that contains the deserialized logic from in 'computation_proto'.
|
| Raises |
|---|
NotImplementedError
|
if computation_proto contains a kind of computation
for which deserialization has not been implemented yet.
|
ValueError
|
if deserialization failed due to the argument being invalid.
|
structural_representation
View source
structural_representation()
Returns the structural string representation of this building block.
__eq__
View source
__eq__(
other: object
) -> bool
Return self==value.
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.Selection\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\nA selection by name or index from a struct-typed value in TFF's language.\n\nInherits From: [`ComputationBuildingBlock`](../../tff/framework/ComputationBuildingBlock), [`TypedObject`](../../tff/TypedObject) \n\n tff.framework.Selection(\n source: ../../tff/framework/ComputationBuildingBlock,\n name: Optional[str] = None,\n index: Optional[int] = None\n )\n\nThe concise syntax for selections is `foo.bar` (selecting a named `bar` from\nthe value of expression `foo`), and `foo[n]` (selecting element at index `n`\nfrom the value of `foo`).\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|----------|----------------------------------------------------------------------------|\n| `source` | The source value to select from (an instance of ComputationBuildingBlock). |\n| `name` | A string name of the element to be selected. |\n| `index` | A numeric index of the element to be selected. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `TypeError` | if arguments are of the wrong types. |\n| `ValueError` | if the name is empty or index is negative, or the name/index is not compatible with the type signature of the source, or neither or both are defined (not None). |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Attributes ---------- ||\n|------------------|------------------------------------------------------------------------------------------|\n| `index` | \u003cbr /\u003e \u003cbr /\u003e |\n| `name` | \u003cbr /\u003e \u003cbr /\u003e |\n| `proto` | Returns a serialized form of this object as a pb.Computation instance. |\n| `source` | \u003cbr /\u003e \u003cbr /\u003e |\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### `as_index`\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 as_index() -\u003e int\n\n### `children`\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 children() -\u003e Iterator[../../tff/framework/ComputationBuildingBlock]\n\nReturns an iterator yielding immediate child building blocks.\n\n### `compact_representation`\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 compact_representation()\n\nReturns the compact string representation of this building block.\n\n### `formatted_representation`\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 formatted_representation()\n\nReturns the formatted string representation of this building block.\n\n### `from_proto`\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 @classmethod\n from_proto(\n computation_proto: pb.Computation\n ) -\u003e 'Selection'\n\nReturns an instance of a derived class based on 'computation_proto'.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ||\n|---------------------|--------------------------------|\n| `computation_proto` | An instance of pb.Computation. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ||\n|---|---|\n| An instance of a class that implements 'ComputationBuildingBlock' and that contains the deserialized logic from in 'computation_proto'. ||\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ||\n|-----------------------|-------------------------------------------------------------------------------------------------------------|\n| `NotImplementedError` | if computation_proto contains a kind of computation for which deserialization has not been implemented yet. |\n| `ValueError` | if deserialization failed due to the argument being invalid. |\n\n\u003cbr /\u003e\n\n### `structural_representation`\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 structural_representation()\n\nReturns the structural string representation of this building block.\n\n### `__eq__`\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 __eq__(\n other: object\n ) -\u003e bool\n\nReturn self==value."]]
View source on GitHub