Skip to content

Commit 83539d3

Browse files
committed
add docs
1 parent 41d182c commit 83539d3

File tree

3 files changed

+9
-306
lines changed

3 files changed

+9
-306
lines changed

docs/user-guide/cachingstore.rst

Lines changed: 0 additions & 304 deletions
This file was deleted.

docs/user-guide/cachingstore.md renamed to docs/user-guide/experimental.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
# CacheStore guide
1+
# Experimental features
22

3-
The `zarr.storage.CacheStore` provides a dual-store caching implementation
3+
This section contains documentation for experimental Zarr Python features. The features described here are exciting and potentially useful, but also volatile -- we might change them at any time. Take this into account if you consider depending on these features.
4+
5+
## `CacheStore`
6+
7+
Zarr Python 3.1.4 adds `zarr.storage.CacheStore` provides a dual-store caching implementation
48
that can be wrapped around any Zarr store to improve performance for repeated data access.
59
This is particularly useful when working with remote stores (e.g., S3, HTTP) where network
610
latency can significantly impact data access speed.
@@ -10,6 +14,8 @@ providing persistent caching capabilities with time-based expiration, size-based
1014
and flexible cache storage options. It automatically evicts the least recently used items
1115
when the cache reaches its maximum size.
1216

17+
Because the `CacheStore` uses an ordinary Zarr `Store` object as the caching layer, you can reuse the data stored in the cache later.
18+
1319
> **Note:** The CacheStore is a wrapper store that maintains compatibility with the full
1420
> `zarr.abc.store.Store` API while adding transparent caching functionality.
1521

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ nav:
2525
- user-guide/extending.md
2626
- user-guide/gpu.md
2727
- user-guide/consolidated_metadata.md
28+
- user-guide/experimental.md
2829
- API Reference:
2930
- api/index.md
3031
- api/array.md

0 commit comments

Comments
 (0)