Skip to content

ZEP1: Apply review feedback for terminology section #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 17, 2022
Merged

ZEP1: Apply review feedback for terminology section #163

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
735b4c4
Add illustrations to terminology, more explanations for store and sto…
jstriebel Oct 4, 2022
6c395e5
Apply suggestions from code review
jstriebel Nov 16, 2022
92eb9f6
minor update
jstriebel Nov 16, 2022
2ca025e
Merge remote-tracking branch 'origin/main' into ZEP0001-apply-storage…
jstriebel Nov 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions docs/core/v3.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ The following figure illustrates the first part of the terminology:
`data type`_, grid_, `memory layout`_ and compressor_ for that
array_.

Groups can have a optional metadata document which provide extra
Groups can have an optional metadata document which provides extra
information about a group.

.. _store:
Expand All @@ -388,7 +388,7 @@ The following figure illustrates the first part of the terminology:
*Store*

The `metadata documents`_ and encoded chunk_ data for all nodes in a
hierarchy_ are held in a store as a sequence of bytes. To enable a variety
hierarchy_ are held in a store as raw bytes. To enable a variety
of different store types to be used, this specification defines an
`Abstract store interface`_ which is a common set of operations that stores
may provide. For example, a directory in a file system can be a zarr store,
Expand All @@ -398,7 +398,7 @@ The following figure illustrates the first part of the terminology:
resource contents, and resources can be read, written or deleted via HTTP.

The following figure illustrates the codec, store and storage transformer
terminology on the example of reading from an array:
terminology for a use case of reading from an array:

..
The following image was produced with https://excalidraw.com/
Expand Down Expand Up @@ -434,14 +434,13 @@ terminology on the example of reading from an array:

*Storage transformer*

To enhance the storage capabilities, storage transformers may change the
storage structure and behaviour of data coming from an array_ in the
underlying store_, being able to manipulate the stored bytes and the key
they are stored at. Upon retrieval the original data is restored within the
To provide performance enhancements or other optimizations,
storage transformers may intercept and alter the storage keys and bytes
of an array_ before they reach the underlying physical storage.
Upon retrieval, the original keys and bytes are restored within the
transformer. Any number of `predefined storage transformers`_ can be
registered and stacked. They allow to have common behavior that is not store
specific, but in the contrast to codecs they rather affect the storage
format of a complete array, rather than single chunks. See the
registered and stacked. In contrast to codecs, stroage transformers act on
the a complete array, rather than individual chunks. See the
`storage transformers details`_ below.

.. _`storage transformers details`: #storage-transformers-1
Expand Down