kedro.contrib.io.matplotlib.MatplotlibS3Writer

class kedro.contrib.io.matplotlib.MatplotlibS3Writer(filepath, bucket_name, s3fs_args=None, credentials=None, save_args=None)[source]

Bases: kedro.io.core.AbstractDataSet

MatplotlibS3Writer saves matplotlib objects to an image file in S3.

Example:

import matplotlib.pyplot as plt
from kedro.contrib.io.matplotlib import MatplotlibS3Writer

# Saving single plot
plt.plot([1, 2, 3], [4, 5, 6])
single_plot_writer = MatplotlibS3Writer(
    bucket="my-super-great-bucket", filepath="matplot_lib_single_plot.png"
)
single_plot_writer.save(plt)
plt.close()

# 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()
dict_plot_writer = MatplotlibS3Writer(
    bucket="my-super-great-bucket", 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], color=colour)
list_plot_writer = MatplotlibS3Writer(
    bucket="my-super-great-bucket", filepath="matplotlib_list"
)
list_plot_writer.save(plots_list)

Methods

MatplotlibS3Writer.__init__(filepath, …[, …]) Creates a new instance of MatplotlibS3Writer.
MatplotlibS3Writer.exists() Checks whether a data set’s output already exists by calling the provided _exists() method.
MatplotlibS3Writer.from_config(name, config) Create a data set instance using the configuration provided.
MatplotlibS3Writer.get_last_load_version() Versioned datasets should override this property to return last loaded version
MatplotlibS3Writer.get_last_save_version() Versioned datasets should override this property to return last saved version.
MatplotlibS3Writer.load() Loads data by delegation to the provided load method.
MatplotlibS3Writer.release() Release any cached data.
MatplotlibS3Writer.save(data) Saves data by delegation to the provided save method.
__init__(filepath, bucket_name, s3fs_args=None, credentials=None, save_args=None)[source]

Creates a new instance of MatplotlibS3Writer.

Parameters:
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.

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