kedro.extras.datasets.networkx.GMLDataSet¶
- class kedro.extras.datasets.networkx.GMLDataSet(filepath, load_args=None, save_args=None, version=None, credentials=None, fs_args=None)[source]¶
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.extras.datasets.networkx import GMLDataSet import networkx as nx graph = nx.complete_graph(100) graph_dataset = GMLDataSet(filepath="test.gml") graph_dataset.save(graph) reloaded = graph_dataset.load() assert nx.is_isomorphic(graph, reloaded)
Attributes
Methods
exists
()Checks whether a data set's output already exists by calling the provided _exists() method.
from_config
(name, config[, load_version, ...])Create a data set instance using the configuration provided.
load
()Loads data by delegation to the provided load method.
release
()Release any cached data.
Compute the version the dataset should be loaded with.
Compute the version the dataset should be saved with.
save
(data)Saves data by delegation to the provided save method.
- 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)[source]¶
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 tonetworkx.read_gml
. See the details in https://networkx.org/documentation/stable/reference/readwrite/generated/networkx.readwrite.gml.read_gml.htmlsave_args (
Optional
[Dict
[str
,Any
]]) – Arguments passed on tonetworkx.write_gml
. See the details in https://networkx.org/documentation/stable/reference/readwrite/generated/networkx.readwrite.gml.write_gml.htmlversion (
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 constructor (e.g. {“project”: “my-project”} forGCSFileSystem
), 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.
- 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
- 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
TypeVar
(_DO
)- 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 (
TypeVar
(_DI
)) – 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