Skip to content

Commit ca442f8

Browse files
committed
Update glossary
1 parent 0374429 commit ca442f8

1 file changed

Lines changed: 15 additions & 2 deletions

File tree

docs/user-guide/glossary.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,23 @@ The partitioning of an array's elements into [chunks](#chunk). In Zarr V3, the
3636
chunk grid is defined in the array [metadata](#metadata) and determines the
3737
boundaries of each storage object.
3838

39+
Zarr V3 supports two chunk grid types:
40+
41+
- **Regular**: All chunks have the same shape (the last chunk along each
42+
dimension may be smaller than the declared size).
43+
- **Rectilinear** *(experimental)*: Each dimension can have different chunk
44+
sizes, specified as a list of edge lengths per dimension. Enable with
45+
`zarr.config.set({'array.rectilinear_chunks': True})`.
46+
3947
When sharding is used, the chunk grid defines the [shard](#shard) boundaries,
4048
not the inner chunk boundaries. The inner chunk shape is defined within the
4149
[sharding codec](#shard).
4250

4351
**API**: The `chunk_grid` field in array metadata contains the storage-level
44-
grid.
52+
grid. [`Array.chunks`][zarr.Array.chunks] returns the chunk shape for regular
53+
grids. For all grid types, `Array.read_chunk_sizes` and `Array.write_chunk_sizes`
54+
return the per-dimension chunk sizes in dask-style `tuple[tuple[int, ...], ...]`
55+
format.
4556

4657
### Shard
4758

@@ -104,7 +115,9 @@ The following properties are available on [`zarr.Array`][]:
104115

105116
| Property | Description |
106117
|----------|-------------|
107-
| `.chunks` | Chunk shape — the inner chunk shape when sharding is used |
118+
| `.chunks` | Chunk shape — the inner chunk shape when sharding is used. Raises for rectilinear grids |
108119
| `.shards` | Shard shape, or `None` if no sharding |
120+
| `.read_chunk_sizes` | Per-dimension chunk data sizes (`tuple[tuple[int, ...], ...]`). Works for all grid types |
121+
| `.write_chunk_sizes` | Per-dimension storage chunk sizes (`tuple[tuple[int, ...], ...]`). Works for all grid types |
109122
| `.nchunks` | Total number of independently compressible units across the array |
110123
| `.cdata_shape` | Number of independently compressible units per dimension |

0 commit comments

Comments
 (0)