Skip to content

Commit

Permalink
Updated related docs
Browse files Browse the repository at this point in the history
Signed-off-by: Elena Khaustova <[email protected]>
  • Loading branch information
ElenaKhaustova committed Jan 15, 2025
1 parent 3df7213 commit f6bc42b
Showing 1 changed file with 6 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ class PartitionedDataset(AbstractDataset[dict[str, Any], dict[str, Callable[[],
sep: '\\t'
index: true
filename_suffix: '.dat'
save_lazily: True
Example usage for the
`Python API <https://docs.kedro.org/en/stable/data/\
Expand All @@ -93,6 +94,7 @@ class PartitionedDataset(AbstractDataset[dict[str, Any], dict[str, Callable[[],
... path=str(tmp_path / "df_with_partition"),
... dataset="pandas.CSVDataset",
... filename_suffix=".csv",
... save_lazily=False
... )
>>> # This will create a folder `df_with_partition` and save multiple files
>>> # with the dict key + filename_suffix as filename, i.e. 1.csv, 2.csv etc.
Expand Down Expand Up @@ -192,8 +194,10 @@ def __init__( # noqa: PLR0913
fs_args: Extra arguments to pass into underlying filesystem class constructor
(e.g. `{"project": "my-project"}` for ``GCSFileSystem``).
overwrite: If True, any existing partitions will be removed.
save_lazily: If True, lazy saving is enabled. Meaning that if callable object is passed,
the partition’s data will not be materialised until it is time to write.
save_lazily: If True, lazy saving is enabled. Meaning that if callable object is passed
as data to save, the partition’s data will not be materialised until it is time to write.
Lazy saving example:
https://docs.kedro.org/en/stable/data/kedro_io.html#partitioned-dataset-lazy-saving
metadata: Any arbitrary metadata.
This is ignored by Kedro, but may be consumed by users or external plugins.
Expand Down

0 comments on commit f6bc42b

Please sign in to comment.