kedro.extras.datasets.matplotlib.MatplotlibWriter¶
-
class
kedro.extras.datasets.matplotlib.
MatplotlibWriter
(filepath, fs_args=None, credentials=None, save_args=None, version=None)[source]¶ Bases:
kedro.io.core.AbstractVersionedDataSet
MatplotlibWriter
saves matplotlib objects to image file(s) in an underlying filesystem (e.g. local, S3, GCS).Example:
import matplotlib.pyplot as plt from kedro.extras.datasets.matplotlib import MatplotlibWriter # Saving single plot plt.plot([1, 2, 3], [4, 5, 6]) single_plot_writer = MatplotlibWriter( filepath="matplot_lib_single_plot.png" ) plt.close() single_plot_writer.save(plt) # Saving dictionary of plots plots_dict = dict() for colour in ["blue", "green", "red"]: plots_dict[colour] = plt.figure() plt.plot([1, 2, 3], [4, 5, 6], color=colour) plt.close("all") dict_plot_writer = MatplotlibWriter( filepath="matplotlib_dict" ) dict_plot_writer.save(plots_dict) # Saving list of plots plots_list = [] for index in range(5): plots_list.append(plt.figure()) plt.plot([1,2,3],[4,5,6]) plt.close("all") list_plot_writer = MatplotlibWriter( filepath="matplotlib_list" ) list_plot_writer.save(plots_list)
Attributes
MatplotlibWriter.DEFAULT_SAVE_ARGS
Methods
MatplotlibWriter.__init__
(filepath[, …])Creates a new instance of MatplotlibWriter
.MatplotlibWriter.exists
()Checks whether a data set’s output already exists by calling the provided _exists() method. MatplotlibWriter.from_config
(name, config[, …])Create a data set instance using the configuration provided. MatplotlibWriter.load
()Loads data by delegation to the provided load method. MatplotlibWriter.release
()Release any cached data. MatplotlibWriter.resolve_load_version
()Compute the version the dataset should be loaded with. MatplotlibWriter.resolve_save_version
()Compute the version the dataset should be saved with. MatplotlibWriter.save
(data)Saves data by delegation to the provided save method. -
DEFAULT_SAVE_ARGS
= {}¶
-
__init__
(filepath, fs_args=None, credentials=None, save_args=None, version=None)[source]¶ Creates a new instance of
MatplotlibWriter
.Parameters: - filepath (
str
) – Filepath in POSIX format to a matplot object file(s) prefixed with a protocol like s3://. If prefix is not provided, file protocol (local filesystem) will be used. The prefix should be any protocol supported byfsspec
. - 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 key 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 wb when saving. - credentials (
Optional
[Dict
[str
,Any
]]) – Credentials required to get access to the underlying filesystem. E.g. forS3FileSystem
it should look like: {‘key’: ‘<id>’, ‘secret’: ‘<key>’}} - save_args (
Optional
[Dict
[str
,Any
]]) – Save args passed to plt.savefig. See https://matplotlib.org/api/_as_gen/matplotlib.pyplot.savefig.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.
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 (
-
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
-