kedro.extras.datasets.networkx.NetworkXDataSet¶
-
class
kedro.extras.datasets.networkx.
NetworkXDataSet
(filepath, load_args=None, save_args=None, version=None, credentials=None, fs_args=None, layer=None)[source]¶ Bases:
kedro.io.core.AbstractVersionedDataSet
NetworkXDataSet
loads and saves graphs to a JSON file using an underlying filesystem (e.g.: local, S3, GCS).NetworkX
is used to create JSON data. See https://networkx.github.io/documentation/stable/tutorial.html for details.Example:
from kedro.extras.datasets.networkx import NetworkXDataSet import networkx as nx graph = nx.complete_graph(100) graph_dataset = NetworkXDataSet(filepath="test.json") graph_dataset.save(graph) reloaded = graph_dataset.load() assert nx.is_isomorphic(graph, reloaded)
Attributes
NetworkXDataSet.DEFAULT_LOAD_ARGS
NetworkXDataSet.DEFAULT_SAVE_ARGS
Methods
NetworkXDataSet.__init__
(filepath[, …])Creates a new instance of NetworkXDataSet
.NetworkXDataSet.exists
()Checks whether a data set’s output already exists by calling the provided _exists() method. NetworkXDataSet.from_config
(name, config[, …])Create a data set instance using the configuration provided. NetworkXDataSet.get_last_load_version
()Versioned datasets should override this property to return last loaded version NetworkXDataSet.get_last_save_version
()Versioned datasets should override this property to return last saved version. NetworkXDataSet.invalidate_cache
()Invalidate underlying filesystem caches. NetworkXDataSet.load
()Loads data by delegation to the provided load method. NetworkXDataSet.release
()Release any cached data. NetworkXDataSet.save
(data)Saves data by delegation to the provided save method. -
DEFAULT_LOAD_ARGS
= {}¶
-
DEFAULT_SAVE_ARGS
= {}¶
-
__init__
(filepath, load_args=None, save_args=None, version=None, credentials=None, fs_args=None, layer=None)[source]¶ Creates a new instance of
NetworkXDataSet
.Parameters: - filepath (
str
) – The path to the NetworkX graph JSON file. - load_args (
Optional
[Dict
[str
,Any
]]) – Arguments passed on to`networkx.node_link_graph
. See the details in https://networkx.github.io/documentation/networkx-1.9.1/reference/generated/networkx.readwrite.json_graph.node_link_graph.html - save_args (
Optional
[Dict
[str
,Any
]]) – Arguments passed on to`networkx.node_link_data
. See the details in https://networkx.github.io/documentation/networkx-1.9.1/reference/generated/networkx.readwrite.json_graph.node_link_data.html - version (
Optional
[Version
]) – If specified, should be an instance ofkedro.io.core.Version
. If itsload
attribute is None, the latest version will be loaded. If itssave
attribute is None, save version will be autogenerated. - credentials (
Optional
[Dict
[str
,Any
]]) – Credentials required to get access to the underlying filesystem. E.g. forGCSFileSystem
it should look like {“token”: None}. - fs_args (
Optional
[Dict
[str
,Any
]]) – Extra arguments to pass into underlying filesystem class. E.g. forGCSFileSystem
class: {“project”: “my-project”, …} - layer (
Optional
[str
]) – The data layer according to the data engineering convention: https://kedro.readthedocs.io/en/stable/06_resources/01_faq.html#what-is-data-engineering-convention
Return type: None
- filepath (
-
exists
()¶ Checks whether a data set’s output already exists by calling the provided _exists() method.
Return type: bool
Returns: Flag indicating whether the output already exists. Raises: DataSetError
– when underlying exists method raises error.
-
classmethod
from_config
(name, config, load_version=None, save_version=None)¶ Create a data set instance using the configuration provided.
Parameters: - name (
str
) – Data set name. - config (
Dict
[str
,Any
]) – Data set config dictionary. - load_version (
Optional
[str
]) – Version string to be used forload
operation if the data set is versioned. Has no effect on the data set if versioning was not enabled. - save_version (
Optional
[str
]) – Version string to be used forsave
operation if the data set is versioned. Has no effect on the data set if versioning was not enabled.
Return type: AbstractDataSet
Returns: An instance of an
AbstractDataSet
subclass.Raises: DataSetError
– When the function fails to create the data set from its config.- name (
-
get_last_load_version
()¶ Versioned datasets should override this property to return last loaded version
Return type: Optional
[str
]
-
get_last_save_version
()¶ Versioned datasets should override this property to return last saved version.
Return type: Optional
[str
]
-
load
()¶ Loads data by delegation to the provided load method.
Return type: Any
Returns: Data returned by the provided load method. Raises: DataSetError
– When underlying load method raises error.
-
release
()¶ Release any cached data.
Raises: DataSetError
– when underlying exists method raises error.Return type: None
-
save
(data)¶ Saves data by delegation to the provided save method.
Parameters: data ( Any
) – the value to be saved by provided save method.Raises: DataSetError
– when underlying save method raises error.Return type: None
-