From 8bb709271fe2032d19869c309651abce7f4565dc Mon Sep 17 00:00:00 2001 From: AdityaChaubeyIITM Date: Wed, 5 Mar 2025 20:39:46 +0530 Subject: [PATCH 1/4] Updated doc to allow easier lookup of default values --- docs/user-guide/config.rst | 42 ++++++++++++++++++++++++++++++++------ 1 file changed, 36 insertions(+), 6 deletions(-) diff --git a/docs/user-guide/config.rst b/docs/user-guide/config.rst index 91ffe50b91..eb8f577e8a 100644 --- a/docs/user-guide/config.rst +++ b/docs/user-guide/config.rst @@ -26,13 +26,43 @@ For more information, see the Configuration options include the following: -- Default Zarr format ``default_zarr_version`` -- Default array order in memory ``array.order`` +- ``default_zarr_version`` + Sets the default Zarr format version. + + - **Default:** ``3`` + +- **array.order** + Defines the default memory layout for arrays. + + - ``'C'`` → Row-major (default, like NumPy) + - ``'F'`` → Column-major (like Fortran) + - **Default:** ``'C'`` + + - Default filters, serializers and compressors, e.g. ``array.v3_default_filters``, ``array.v3_default_serializer``, ``array.v3_default_compressors``, ``array.v2_default_filters`` and ``array.v2_default_compressor`` -- Whether empty chunks are written to storage ``array.write_empty_chunks`` -- Async and threading options, e.g. ``async.concurrency`` and ``threading.max_workers`` -- Selections of implementations of codecs, codec pipelines and buffers -- Enabling GPU support with ``zarr.config.enable_gpu()``. See :ref:`user-guide-gpu` for more. + +- ``array.write_empty_chunks`` + Determines whether empty chunks (filled with default values) are written to storage. + + - ``False`` → Empty chunks are **not written** (saves space). + - ``True`` → Empty chunks are explicitly stored. + - **Default:** ``False`` + +- ``async.concurrency`` + Sets the number of concurrent async operations. + + - **Default:** ``10`` + +- ``threading.max_workers`` + Defines the maximum number of worker threads for parallel execution. + + - **Default**: ``None`` (uses system default) + +- ``codecs`` / ``codec_pipeline`` / ``buffer`` + Allows selection of custom implementations for codecs, encoding pipelines, and data buffers. + +- GPU Support : Enabling GPU support with ``zarr.config.enable_gpu()``. See :ref:`user-guide-gpu` for more. + For selecting custom implementations of codecs, pipelines, buffers and ndbuffers, first register the implementations in the registry and then select them in the config. From 33932585ccd0aa82d05d7fd8e0bb087a86ad5541 Mon Sep 17 00:00:00 2001 From: AdityaHere Date: Thu, 6 Mar 2025 10:08:07 +0530 Subject: [PATCH 2/4] Update docs/user-guide/config.rst Co-authored-by: Davis Bennett --- docs/user-guide/config.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/config.rst b/docs/user-guide/config.rst index eb8f577e8a..a6c68f5dfa 100644 --- a/docs/user-guide/config.rst +++ b/docs/user-guide/config.rst @@ -27,7 +27,7 @@ For more information, see the Configuration options include the following: - ``default_zarr_version`` - Sets the default Zarr format version. + Sets the default Zarr format version. The options are ``2`` or ``3``. - **Default:** ``3`` From 7ff67e0fc690f45eea0fb93485060ba35f0b79bf Mon Sep 17 00:00:00 2001 From: AdityaHere Date: Thu, 6 Mar 2025 10:08:19 +0530 Subject: [PATCH 3/4] Update docs/user-guide/config.rst Co-authored-by: Davis Bennett --- docs/user-guide/config.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/config.rst b/docs/user-guide/config.rst index a6c68f5dfa..58bb20a4d4 100644 --- a/docs/user-guide/config.rst +++ b/docs/user-guide/config.rst @@ -34,7 +34,7 @@ Configuration options include the following: - **array.order** Defines the default memory layout for arrays. - - ``'C'`` → Row-major (default, like NumPy) + - ``'C'`` → Row-major (The default value used for NumPy arrays) - ``'F'`` → Column-major (like Fortran) - **Default:** ``'C'`` From e58913eb543e6cfee66f094b54eedec434557468 Mon Sep 17 00:00:00 2001 From: AdityaHere Date: Thu, 6 Mar 2025 10:08:30 +0530 Subject: [PATCH 4/4] Update docs/user-guide/config.rst Co-authored-by: Davis Bennett --- docs/user-guide/config.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user-guide/config.rst b/docs/user-guide/config.rst index 58bb20a4d4..65f3121b20 100644 --- a/docs/user-guide/config.rst +++ b/docs/user-guide/config.rst @@ -42,9 +42,9 @@ Configuration options include the following: - Default filters, serializers and compressors, e.g. ``array.v3_default_filters``, ``array.v3_default_serializer``, ``array.v3_default_compressors``, ``array.v2_default_filters`` and ``array.v2_default_compressor`` - ``array.write_empty_chunks`` - Determines whether empty chunks (filled with default values) are written to storage. + Determines whether empty chunks (filled with default values) are written to storage. Setting this to ``False`` can reduce the number of write operations and objects created when writing arrays with large empty regions. - - ``False`` → Empty chunks are **not written** (saves space). + - ``False`` → Empty chunks are **not written**. - ``True`` → Empty chunks are explicitly stored. - **Default:** ``False``