@@ -797,18 +797,18 @@ def preserve_chunks(
797797 """Quickly determine optimal chunks close to target size but never splitting
798798 previous_chunks.
799799
800- This takes in a chunks argument potentially containing ``"preserve "`` for several
801- dimensions. This function replaces ``"preserve "`` with concrete dimension sizes that
800+ This takes in a chunks argument potentially containing ``"auto "`` for several
801+ dimensions. This function replaces ``"auto "`` with concrete dimension sizes that
802802 try to get chunks to be close to certain size in bytes, provided by the ``target=``
803- keyword. Any dimensions marked as ``"preserve "`` will potentially be multiplied
803+ keyword. Any dimensions marked as ``"auto "`` will potentially be multiplied
804804 by some factor to get close to the byte target, while never splitting
805805 ``previous_chunks``. If chunks are non-uniform along a particular dimension
806806 then that dimension will always use exactly ``previous_chunks``.
807807
808808 Examples
809809 --------
810810 >>> ChunkManagerEntrypoint.preserve_chunks(
811- ... chunks=("preserve ", "preserve ", "preserve "),
811+ ... chunks=("auto ", "auto ", "auto "),
812812 ... shape=(1280, 1280, 20),
813813 ... target=500 * 1024,
814814 ... typesize=8,
@@ -817,7 +817,7 @@ def preserve_chunks(
817817 (128, 128, 2)
818818
819819 >>> ChunkManagerEntrypoint.preserve_chunks(
820- ... chunks=("preserve ", "preserve ", 1),
820+ ... chunks=("auto ", "auto ", 1),
821821 ... shape=(1280, 1280, 20),
822822 ... target=1 * 1024 * 1024,
823823 ... typesize=8,
@@ -826,7 +826,7 @@ def preserve_chunks(
826826 (128, 1024, 1)
827827
828828 >>> ChunkManagerEntrypoint.preserve_chunks(
829- ... chunks=("preserve ", "preserve ", 1),
829+ ... chunks=("auto ", "auto ", 1),
830830 ... shape=(1280, 1280, 20),
831831 ... target=1 * 1024 * 1024,
832832 ... typesize=8,
@@ -838,7 +838,7 @@ def preserve_chunks(
838838 ----------
839839 chunks: tuple[int | str | tuple[int], ...]
840840 A tuple of either dimensions or tuples of explicit chunk dimensions
841- Some entries should be "preserve ".
841+ Some entries should be "auto ".
842842 shape: tuple[int]
843843 The shape of the array
844844 target: int
0 commit comments