class documentation
class HoloviewsWriter(AbstractVersionedDataSet[
HoloviewsWriter saves Holoviews objects to image file(s) in an underlying filesystem (e.g. local, S3, GCS).
Example:
>>> import holoviews as hv >>> from kedro.extras.datasets.holoviews import HoloviewsWriter >>> >>> curve = hv.Curve(range(10)) >>> holoviews_writer = HoloviewsWriter("/tmp/holoviews") >>> >>> holoviews_writer.save(curve)
Method | __init__ |
Creates a new instance of HoloviewsWriter. |
Constant | DEFAULT |
Undocumented |
Method | _describe |
Undocumented |
Method | _exists |
Undocumented |
Method | _invalidate |
Invalidate underlying filesystem caches. |
Method | _load |
Undocumented |
Method | _release |
Undocumented |
Method | _save |
Undocumented |
Instance Variable | _fs |
Undocumented |
Instance Variable | _fs |
Undocumented |
Instance Variable | _protocol |
Undocumented |
Instance Variable | _save |
Undocumented |
Inherited from AbstractVersionedDataSet
:
Method | exists |
Checks whether a data set's output already exists by calling the provided _exists() method. |
Method | load |
Loads data by delegation to the provided load method. |
Method | resolve |
Compute the version the dataset should be loaded with. |
Method | resolve |
Compute the version the dataset should be saved with. |
Method | save |
Saves data by delegation to the provided save method. |
Method | _fetch |
Undocumented |
Method | _fetch |
Generate and cache the current save version |
Method | _get |
Undocumented |
Method | _get |
Undocumented |
Method | _get |
Undocumented |
Instance Variable | _exists |
Undocumented |
Instance Variable | _filepath |
Undocumented |
Instance Variable | _glob |
Undocumented |
Instance Variable | _version |
Undocumented |
Instance Variable | _version |
Undocumented |
Inherited from AbstractDataSet
(via AbstractVersionedDataSet
):
Class Method | from |
Create a data set instance using the configuration provided. |
Method | __str__ |
Undocumented |
Method | release |
Release any cached data. |
Method | _copy |
Undocumented |
Property | _logger |
Undocumented |
def __init__(self, filepath:
str
, fs_args: Dict[ str, Any]
= None, credentials: Dict[ str, Any]
= None, save_args: Dict[ str, Any]
= None, version: Version
= None):
(source)
¶
Creates a new instance of HoloviewsWriter.
Parameters | |
filepath:str | Filepath in POSIX format to a text file 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 by fsspec.
Note: http(s) doesn't support versioning. |
fsDict[ | 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 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:Dict[ | Credentials required to get access to the underlying filesystem.
E.g. for S3FileSystem it should look like:
{'key': '<id>', 'secret': '<key>'}} |
saveDict[ | Extra save args passed to holoviews.save() . See
https://holoviews.org/reference_manual/holoviews.util.html#holoviews.util.save |
version: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. |