Skip to content

Commit

Permalink
Fix zarr_sharding_indexed -> zarr3_sharding_indexed typo
Browse files Browse the repository at this point in the history
Fixes #180

PiperOrigin-RevId: 655820293
Change-Id: I6bba05469af0af071bb722b7bb83673a0eac2d23
  • Loading branch information
jbms authored and copybara-github committed Jul 25, 2024
1 parent 40278bb commit 07bbe1a
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 52 deletions.
10 changes: 5 additions & 5 deletions tensorstore/kvstore/zarr3_sharding_indexed/index.rst
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
.. _zarr-sharding-indexed-kvstore-driver:
.. _zarr3-sharding-indexed-kvstore-driver:

``zarr_sharding_indexed`` Key-Value Store driver
``zarr3_sharding_indexed`` Key-Value Store driver
======================================================

The ``zarr_sharding_indexed`` driver implements support for stored
The ``zarr3_sharding_indexed`` driver implements support for stored
representation used by the Zarr v3 ``sharding_indexed`` codec on top of a base
key-value store.

For a grid of rank ``n``, keys must be ``n * 4`` bytes long, specifying the grid
cell indices, where ``0 <= grid_cell_indices[i] < grid_shape[i]``, as ``n``
consecutive ``uint32be`` values.

.. json:schema:: kvstore/zarr_sharding_indexed
.. json:schema:: kvstore/zarr3_sharding_indexed
Example JSON specifications
---------------------------

.. code-block:: json
{
"driver": "zarr_sharding_indexed",
"driver": "zarr3_sharding_indexed",
"kvstore": "gs://my-bucket/path/to/sharded/data",
"grid_shape": [32, 128],
"index_codecs" [
Expand Down
94 changes: 47 additions & 47 deletions tensorstore/kvstore/zarr3_sharding_indexed/schema.yml
Original file line number Diff line number Diff line change
@@ -1,53 +1,53 @@
$schema: http://json-schema.org/draft-07/schema#
$id: kvstore/zarr_sharding_indexed
$id: kvstore/zarr3_sharding_indexed
title: Read/write adapter for the :ref:`zarr v3<zarr3-driver>` sharded_indexed format.
description: JSON specification of the key-value store.
allOf:
- $ref: KvStore
- type: object
properties:
driver:
const: zarr_sharding_indexed
base:
$ref: KvStore
title: Underlying key-value store with path to shard.
grid_shape:
type: array
items:
type: integer
minimum: 1
title: "Shape of the grid of entries in the shard."
$ref: kvstore/neuroglancer_uint64_sharded/ShardingSpec
index_codecs:
title: "Codec chain for encoding/decoding the shard index."
$ref: driver/zarr3/CodecChain
index_location:
title: "Location of the shard index within the shard."
oneOf:
- const: "start"
- const: "end"
default: "end"
cache_pool:
$ref: ContextResource
description: |
Specifies or references a previously defined `Context.cache_pool`. It
is normally more convenient to specify a default `~Context.cache_pool`
in the `.context`.
- $ref: KvStore
- type: object
properties:
driver:
const: zarr3_sharding_indexed
base:
$ref: KvStore
title: Underlying key-value store with path to shard.
grid_shape:
type: array
items:
type: integer
minimum: 1
title: "Shape of the grid of entries in the shard."
$ref: kvstore/neuroglancer_uint64_sharded/ShardingSpec
index_codecs:
title: "Codec chain for encoding/decoding the shard index."
$ref: driver/zarr3/CodecChain
index_location:
title: "Location of the shard index within the shard."
oneOf:
- const: "start"
- const: "end"
default: "end"
cache_pool:
$ref: ContextResource
description: |
Specifies or references a previously defined `Context.cache_pool`. It
is normally more convenient to specify a default `~Context.cache_pool`
in the `.context`.
.. important::
.. important::
It is very helpful to specify a cache pool with a non-zero
`~Context.cache_pool.total_bytes_limit` value. Otherwise, every read
operation will require an additional read to obtain the shard index.
default: cache_pool
data_copy_concurrency:
$ref: ContextResource
description: |-
Specifies or references a previously defined `Context.data_copy_concurrency`.
It is normally more convenient to specify a default `~Context.data_copy_concurrency` in
the `.context`.
default: data_copy_concurrency
required:
- base
- grid_shape
- index_codecs
It is very helpful to specify a cache pool with a non-zero
`~Context.cache_pool.total_bytes_limit` value. Otherwise, every read
operation will require an additional read to obtain the shard index.
default: cache_pool
data_copy_concurrency:
$ref: ContextResource
description: |-
Specifies or references a previously defined `Context.data_copy_concurrency`.
It is normally more convenient to specify a default `~Context.data_copy_concurrency` in
the `.context`.
default: data_copy_concurrency
required:
- base
- grid_shape
- index_codecs

0 comments on commit 07bbe1a

Please sign in to comment.