kedro_datasets.networkx.GMLDataset

class kedro_datasets.networkx.GMLDataset(*, filepath, load_args=None, save_args=None, version=None, credentials=None, fs_args=None, metadata=None)

GMLDataset loads and saves graphs to a GML file using an underlying filesystem (e.g.: local, S3, GCS). NetworkX is used to create GML data. See https://networkx.org/documentation/stable/tutorial.html for details.

Example:

from kedro_datasets.networkx import GMLDataset
import networkx as nx
graph = nx.complete_graph(100)
graph_dataset = GMLDataset(filepath=tmp_path / "test.gml")
graph_dataset.save(graph)
reloaded = graph_dataset.load()
assert nx.is_isomorphic(graph, reloaded)

Attributes

DEFAULT_FS_ARGS
DEFAULT_LOAD_ARGS
DEFAULT_SAVE_ARGS

Methods

exists()	Checks whether a dataset's output already exists by calling the provided _exists() method.
from_config(name, config[, load_version, ...])	Create a dataset instance using the configuration provided.
load()	Loads data by delegation to the provided load method.
release()	Release any cached data.
resolve_load_version()	Compute the version the dataset should be loaded with.
resolve_save_version()	Compute the version the dataset should be saved with.
save(data)	Saves data by delegation to the provided save method.

DEFAULT_FS_ARGS: dict[str, Any] = {'open_args_load': {'mode': 'rb'}, 'open_args_save': {'mode': 'wb'}}

DEFAULT_LOAD_ARGS: dict[str, Any] = {}

DEFAULT_SAVE_ARGS: dict[str, Any] = {}

__init__(*, filepath, load_args=None, save_args=None, version=None, credentials=None, fs_args=None, metadata=None)

Creates a new instance of GMLDataset.

Parameters:

• filepath (str) – Filepath in POSIX format to the NetworkX GML file.

• load_args (Optional[dict[str, Any]]) – Arguments passed on to networkx.read_gml. See the details in https://networkx.org/documentation/stable/reference/readwrite/generated/networkx.readwrite.gml.read_gml.html

• save_args (Optional[dict[str, Any]]) – Arguments passed on to networkx.write_gml. See the details in https://networkx.org/documentation/stable/reference/readwrite/generated/networkx.readwrite.gml.write_gml.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 rb when loading and to wb when saving.

• metadata (Optional[dict[str, Any]]) – Any arbitrary metadata. This is ignored by Kedro, but may be consumed by users or external plugins.

exists()

Checks whether a dataset’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 dataset 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 dataset is versioned. Has no effect on the dataset if versioning was not enabled.

• save_version (Optional[str]) – Version string to be used for save operation if the dataset is versioned. Has no effect on the dataset if versioning was not enabled.

Return type:

AbstractDataset

Returns:

An instance of an AbstractDataset subclass.

Raises:

DatasetError – When the function fails to create the dataset from its config.

load()

Loads data by delegation to the provided load method.

Return type:

Graph

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 (Graph) – the value to be saved by provided save method.

Raises:

• DatasetError – when underlying save method raises error.

• FileNotFoundError – when save method got file instead of dir, on Windows.

• NotADirectoryError – when save method got file instead of dir, on Unix.

Return type:

None