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)

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.load()	Loads data by delegation to the provided load method.
NetworkXDataSet.release()	Release any cached data.
NetworkXDataSet.resolve_load_version()	Compute the version the dataset should be loaded with.
NetworkXDataSet.resolve_save_version()	Compute the version the dataset should be saved with.
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)

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 of kedro.io.core.Version. If its load attribute is None, the latest version will be loaded. If its save attribute is None, save version will be autogenerated.
• credentials (Optional[Dict[str, Any]]) – Credentials required to get access to the underlying filesystem. E.g. for GCSFileSystem it should look like {“token”: None}.
• fs_args (Optional[Dict[str, Any]]) – Extra arguments to pass into underlying filesystem class constructor (e.g. {“project”: “my-project”} for GCSFileSystem), as well as to pass to the filesystem’s open method through nested keys open_args_load and open_args_save. Here you can find all available arguments for open: https://filesystem-spec.readthedocs.io/en/latest/api.html#fsspec.spec.AbstractFileSystem.open All defaults are preserved, except mode, which is set to r when loading and to w when saving.

Return type:

None

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 for load 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 for save 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.

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 release method raises error. Return type:None

resolve_load_version()

Compute the version the dataset should be loaded with.

Return type:Optional[str]

resolve_save_version()

Compute the version the dataset should be saved with.

Return type:Optional[str]

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