tff.framework.Intrinsic
Stay organized with collections
Save and categorize content based on your preferences.
A representation of an intrinsic in TFF's internal language.
Inherits From: ComputationBuildingBlock, TypedObject
tff.framework.Intrinsic(
uri: str,
type_signature: tff.types.Type
)
An instrinsic is a symbol known to the TFF's compiler pipeline, represented
as a known URI. It generally appears in expressions with a concrete type,
although all intrinsic are defined with template types. This class does not
deal with parsing intrinsic URIs and verifying their types, it is only a
container. Parsing and type analysis are a responsibility of the components
that manipulate ASTs. See intrinsic_defs.py for the list of known intrinsics.
Args |
|---|
uri
|
The URI of the intrinsic.
|
type_signature
|
A tff.Type, the type of the intrinsic.
|
Raises |
|---|
TypeError
|
if the arguments are of the wrong types.
|
Attributes |
|---|
proto
|
Returns a serialized form of this object as a pb.Computation instance.
|
type_signature
|
Returns the TFF type of this object (an instance of tff.Type).
|
uri
|
|
Methods
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
) -> 'Intrinsic'
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.
|
intrinsic_def
View source
intrinsic_def() -> intrinsic_defs.IntrinsicDef
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.Intrinsic\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 representation of an intrinsic in TFF's internal language.\n\nInherits From: [`ComputationBuildingBlock`](../../tff/framework/ComputationBuildingBlock), [`TypedObject`](../../tff/TypedObject) \n\n tff.framework.Intrinsic(\n uri: str,\n type_signature: ../../tff/types/Type\n )\n\nAn instrinsic is a symbol known to the TFF's compiler pipeline, represented\nas a known URI. It generally appears in expressions with a concrete type,\nalthough all intrinsic are defined with template types. This class does not\ndeal with parsing intrinsic URIs and verifying their types, it is only a\ncontainer. Parsing and type analysis are a responsibility of the components\nthat manipulate ASTs. See intrinsic_defs.py for the list of known intrinsics.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|------------------|------------------------------------------------------------------|\n| `uri` | The URI of the intrinsic. |\n| `type_signature` | A [`tff.Type`](../../tff/types/Type), the type of the intrinsic. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|-------------|------------------------------------------|\n| `TypeError` | if the arguments are of the wrong types. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Attributes ---------- ||\n|------------------|------------------------------------------------------------------------------------------|\n| `proto` | Returns a serialized form of this object as a pb.Computation instance. |\n| `type_signature` | Returns the TFF type of this object (an instance of [`tff.Type`](../../tff/types/Type)). |\n| `uri` | \u003cbr /\u003e \u003cbr /\u003e |\n\n\u003cbr /\u003e\n\nMethods\n-------\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 'Intrinsic'\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### `intrinsic_def`\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 intrinsic_def() -\u003e intrinsic_defs.IntrinsicDef\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