tff.structure.to_elements
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves the list of (name, value) pairs from a Struct.
tff.structure.to_elements(
struct: Struct[_T]
) -> list[tuple[Optional[str], _T]]
Modeled as a module function rather than a method of Struct to avoid
naming conflicts with the tuple attributes, and so as not to expose the user
to this implementation-oriented functionality.
Args |
|---|
struct
|
An instance of Struct.
|
Returns |
|---|
|
The list of (name, value) pairs in which names can be None. Identical to
the format that's accepted by the tuple constructor.
|
Raises |
|---|
TypeError
|
if the argument is not an Struct.
|
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.structure.to_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\nRetrieves the list of (name, value) pairs from a `Struct`. \n\n tff.structure.to_elements(\n struct: Struct[_T]\n ) -\u003e list[tuple[Optional[str], _T]]\n\nModeled as a module function rather than a method of `Struct` to avoid\nnaming conflicts with the tuple attributes, and so as not to expose the user\nto this implementation-oriented functionality.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|----------|--------------------------|\n| `struct` | An instance of `Struct`. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|---|---|\n| The list of (name, value) pairs in which names can be None. Identical to the format that's accepted by the tuple constructor. ||\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|-------------|-------------------------------------|\n| `TypeError` | if the argument is not an `Struct`. |\n\n\u003cbr /\u003e"]]
View source on GitHub