Skip to content

Commit caabba7

Browse files
committed
filters doco
1 parent 2b4d193 commit caabba7

File tree

3 files changed

+7
-2
lines changed

3 files changed

+7
-2
lines changed

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Highlights
1717
* Read an array concurrently from multiple threads or processes.
1818
* Write to an array concurrently from multiple threads or processes.
1919
* Organize arrays into hierarchies via groups.
20+
* Use filters to preprocess data and improve compression.
2021

2122
Status
2223
------

docs/release.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ API docs for more information.
1616
Filters
1717
~~~~~~~
1818

19-
TODO
19+
Support has been added for configuring filters to preprocess chunk data prior
20+
to compression. See the tutorial section on :ref:`tutorial_filters` and the
21+
:mod:`zarr.filters` API docs for more information.
2022

2123
Other changes
2224
~~~~~~~~~~~~~

docs/tutorial.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ To disable compression, set ``compressor=None`` when creating an array.
238238

239239
To disable compression, set ``compression=None`` when creating an array.
240240

241-
.. _tutorial_sync:
241+
.. _tutorial_filters:
242242

243243
Filters
244244
-------
@@ -272,6 +272,8 @@ Zarr comes with implementations of delta, scale-offset, quantize, packbits and
272272
categorize filters. It is also relatively straightforward to implement custom
273273
filters. For more information see the :mod:`zarr.filters` API docs.
274274

275+
.. _tutorial_sync:
276+
275277
Parallel computing and synchronization
276278
--------------------------------------
277279

0 commit comments

Comments
 (0)