Rename chunk_dim to stream_dim, following ezmsg core - #242
Merged
Merged
Conversation
Tracks the upstream rename of `AxisArray.chunk_dim` and the corresponding
`ezmsg.baseproc.util.streamdim` helpers. `chunk` was overloaded: xarray's
`DataArray.chunk`, dask, zarr and HDF5 all use it for memory/IO layout,
and this package uses it a third way -- `chunk_sizes`, `chunk_len`, "chunk
size jitter" -- for how much data a message carries. `stream_dim` names
the role instead: the dimension the stream extends along.
Those payload-size uses are deliberately left as `chunk`. Only the
dimension sense is renamed, including the prose that describes it ("chunk
dimension" / "chunk axis") and `test_chunk_dim_resolution.py`.
Pure rename. 4336 passed, 9 skipped, against the renamed ezmsg core and
ezmsg-baseproc.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Tracks the rename of
AxisArray.chunk_dimtostream_dimin ezmsg core (ezmsg-org/ezmsg#265).Why the name changed
chunkwas already spoken for in three directions:chunkfor multi-dimensional memory/IO layout. SinceAxisArraydeliberately echoesxarray.DataArray— which has a.chunk()method — borrowing the word invites exactly the wrong reading.array_chunker/chunk_lenmean "how much data per message".stream_dimnames that role directly and reuses ezmsg's own vocabulary (InputStream/OutputStream).append_dim(zarr) andconcat_dim(xarray) were the closest semantic matches but were rejected: in ezmsg-sigproc those words already name the target argument of an append or concat operation. netCDF'sunlimited_dimsdescribes a static property of the dimension rather than what is happening to it.What's in here
Pure rename — no behaviour change.
Also follows ezmsg-baseproc's
resolve_chunk_dim/resolve_configured_chunk_dim→resolve_stream_dim/resolve_configured_stream_dim(ezmsg-org/ezmsg-baseproc#16), and renamestests/unit/test_chunk_dim_resolution.py.This package is the strongest case for the rename: it uses
chunkheavily in the other sense —chunk_sizesin the MLX Metal kernels,chunk_len, "chunk-size jitter" — so the two meanings were colliding inside single files. Those are untouched.Uses of
chunkthat mean how much data a message carries are deliberately left alone; only the dimension sense is renamed, including the prose that describes it.The
ezmsgfloor moves>=3.10.0b2→>=3.10.0b3. 3.10.0b1 and b2 are on PyPI carryingchunk_dim, so the floor has to move for the rename to be meaningful; 3.10.0b3 is the first release withstream_dim.Testing
4336 passed, 9 skipped, run against the renamed ezmsg core and ezmsg-baseproc installed editable.
Merge order: ezmsg 3.10.0b3 must be on PyPI before this merges, or CI here resolves an
ezmsgthat has nostream_dim.