Skip to content

Commit 2ec553c

Browse files
Merge branch 'zarr-developers:main' into main
2 parents ee3eca5 + 2911be8 commit 2ec553c

37 files changed

+246
-8991
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
Contributing
22
============
33

4-
Please see the [project documentation](https://zarr.readthedocs.io/en/stable/contributing.html) for information about contributing to Zarr.
4+
Please see the [project documentation](https://zarr.readthedocs.io/en/stable/developers/contributing.html) for information about contributing to Zarr.

changes/2871.feature.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Added public API for Buffer ABCs and implementations.
2+
3+
Use :mod:`zarr.buffer` to access buffer implementations, and
4+
:mod:`zarr.abc.buffer` for the interface to implement new buffer types.
5+
6+
Users previously importing buffer from ``zarr.core.buffer`` should update their
7+
imports to use :mod:`zarr.buffer`. As a reminder, all of ``zarr.core`` is
8+
considered a private API that's not covered by zarr-python's versioning policy.

changes/3138.feature.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Adds a `with_read_only` convenience method to the `Store` abstract base class (raises `NotImplementedError`) and implementations to the `MemoryStore`, `ObjectStore`, `LocalStore`, and `FsspecStore` classes.

docs/user-guide/config.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ This is the current default configuration::
6363
'variable-length-string': {'name': 'vlen-utf8'}},
6464
'write_empty_chunks': False},
6565
'async': {'concurrency': 10, 'timeout': None},
66-
'buffer': 'zarr.core.buffer.cpu.Buffer',
66+
'buffer': 'zarr.buffer.cpu.Buffer',
6767
'codec_pipeline': {'batch_size': 1,
6868
'path': 'zarr.core.codec_pipeline.BatchedCodecPipeline'},
6969
'codecs': {'blosc': 'zarr.codecs.blosc.BloscCodec',
@@ -78,5 +78,5 @@ This is the current default configuration::
7878
'zstd': 'zarr.codecs.zstd.ZstdCodec'},
7979
'default_zarr_format': 3,
8080
'json_indent': 2,
81-
'ndbuffer': 'zarr.core.buffer.cpu.NDBuffer',
81+
'ndbuffer': 'zarr.buffer.cpu.NDBuffer',
8282
'threading': {'max_workers': None}}

docs/user-guide/extending.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,10 @@ Coming soon.
8383
Custom array buffers
8484
--------------------
8585

86-
Coming soon.
86+
Zarr-python provides control over where and how arrays stored in memory through
87+
:mod:`zarr.buffer`. Currently both CPU (the default) and GPU implementations are
88+
provided (see :ref:`user-guide-gpu` for more). You can implement your own buffer
89+
classes by implementing the interface defined in :mod:`zarr.abc.buffer`.
8790

8891
Other extensions
8992
----------------

0 commit comments

Comments
 (0)