tff.structure.to_odict_or_tuple
Stay organized with collections
Save and categorize content based on your preferences.
Returns struct
as an collections.OrderedDict
or tuple
, if possible.
tff.structure.to_odict_or_tuple(
struct: Struct[_T], recursive: bool = True
) -> Union[collections.OrderedDict[str, _T], tuple[_T, ...]]
If all elements of struct
have names, convert struct
to an
collections.OrderedDict
. If no element has a name, convert struct
to a
tuple
. If
struct
has both named and unnamed elements, raise an error.
Args |
struct
|
A Struct .
|
recursive
|
Whether to convert nested Struct s recursively.
|
Raises |
ValueError
|
If struct (or any nested Struct when recursive=True )
contains both named and unnamed elements.
|
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_odict_or_tuple\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\nReturns `struct` as an `collections.OrderedDict` or `tuple`, if possible. \n\n tff.structure.to_odict_or_tuple(\n struct: Struct[_T], recursive: bool = True\n ) -\u003e Union[collections.OrderedDict[str, _T], tuple[_T, ...]]\n\nIf all elements of `struct` have names, convert `struct` to an\n`collections.OrderedDict`. If no element has a name, convert `struct` to a\n`tuple`. If\n`struct` has both named and unnamed elements, raise an error.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|-------------|--------------------------------------------------|\n| `struct` | A `Struct`. |\n| `recursive` | Whether to convert nested `Struct`s recursively. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|--------------|------------------------------------------------------------------------------------------------------|\n| `ValueError` | If `struct` (or any nested `Struct` when `recursive=True`) contains both named and unnamed elements. |\n\n\u003cbr /\u003e"]]