tff.simulation.datasets.load_and_parse_sql_client_data
Stay organized with collections
Save and categorize content based on your preferences.
Load a ClientData
arises by parsing a serialized SqlClientData
.
tff.simulation.datasets.load_and_parse_sql_client_data(
database_filepath: str,
element_spec: Mapping[str, tf.TensorSpec],
split_name: Optional[str] = None
) -> tff.simulation.datasets.ClientData
Args |
database_filepath
|
A str filepath of the SQL database. This function will
first fetch the SQL database to a local temporary directory if
database_filepath is a remote directory.
|
element_spec
|
The element_spec of the local dataset. This is used to parse
the serialized tff.simulation.datasets.SqlClientData . The element_spec
must be of type Mapping[str, TensorSpec] .
|
split_name
|
An optional str identifier for the split of the database to
use. This filters clients and examples based on the split_name column. A
value of None means no filtering, selecting all examples.
|
Raises |
FileNotFoundError
|
if database_filepath does not exist.
|
ElementSpecCompatibilityError
|
if the element_spec of datasets are not of
type Mapping[str, TensorSpec] .
|
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-20 UTC."],[],[],null,["# tff.simulation.datasets.load_and_parse_sql_client_data\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\nLoad a `ClientData` arises by parsing a serialized `SqlClientData`. \n\n tff.simulation.datasets.load_and_parse_sql_client_data(\n database_filepath: str,\n element_spec: Mapping[str, tf.TensorSpec],\n split_name: Optional[str] = None\n ) -\u003e ../../../tff/simulation/datasets/ClientData\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `database_filepath` | A `str` filepath of the SQL database. This function will first fetch the SQL database to a local temporary directory if `database_filepath` is a remote directory. |\n| `element_spec` | The `element_spec` of the local dataset. This is used to parse the serialized [`tff.simulation.datasets.SqlClientData`](../../../tff/simulation/datasets/SqlClientData). The `element_spec` must be of type `Mapping[str, TensorSpec]`. |\n| `split_name` | An optional `str` identifier for the split of the database to use. This filters clients and examples based on the `split_name` column. A value of `None` means no filtering, selecting all examples. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|---|---|\n| A [`tff.simulation.datasets.ClientData`](../../../tff/simulation/datasets/ClientData) instance arised from parsing a [`tff.simulation.datasets.SqlClientData`](../../../tff/simulation/datasets/SqlClientData). ||\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|---------------------------------|-------------------------------------------------------------------------------|\n| `FileNotFoundError` | if database_filepath does not exist. |\n| `ElementSpecCompatibilityError` | if the `element_spec` of datasets are not of type `Mapping[str, TensorSpec]`. |\n\n\u003cbr /\u003e"]]