Rename CoordinateOutputMode.SINGLE_OUTPUT to MERGED (4.2.0)#152
Merged
Conversation
Rename the coordinate output-mode value `single_output` -> `merged` (and the constant `CoordinateOutputMode.SINGLE_OUTPUT` -> `CoordinateOutputMode.MERGED`) so the public name matches hs2p's existing internal vocabulary (`merged_coords`, `_merge_*`, the `merged` process-list row label) and reads more clearly than `single_output`. BREAKING CHANGE: `CoordinateOutputMode.SINGLE_OUTPUT` and the config value `tiling.masks.output_mode: single_output` are removed with no alias. Migration: use `CoordinateOutputMode.MERGED` / `output_mode: merged`. A merged artifact now carries `output_mode="merged"` and the process-list label `annotation="merged"` (the two intentionally coincide). Bumps version 4.1.0 -> 4.2.0. Co-Authored-By: Claude Opus 4.8 <[email protected]>
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.
What
Rename the coordinate output-mode value
single_output→merged, and the constantCoordinateOutputMode.SINGLE_OUTPUT→CoordinateOutputMode.MERGED, across code, tests, and docs. Bumps version4.1.0→4.2.0.Why
single_outputwas the odd one out: hs2p's internals already speak "merged" (merged_coords,_merge_*, and themergedprocess-list row label). Aligning the public name with that vocabulary reads more clearly.Breaking change
CoordinateOutputMode.SINGLE_OUTPUTand the config valuetiling.masks.output_mode: single_outputare removed with no backward-compat alias.Migration: use
CoordinateOutputMode.MERGED/output_mode: merged.A merged artifact now carries
output_mode="merged"and the process-list labelannotation="merged"— the two intentionally coincide ("merged-mode row, labeled merged").Verification
tests/test_standalone_mask_pyramid.py) are pre-existing and unrelated — a missingscripts/generate_tissue_mask_pyramid.pyin the environment; that file is byte-identical tomain.Downstream
Unblocks slide2vec's annotation-aware feature extraction (slide2vec issue #154 targets the 4.2.0 release and uses
output_mode: merged).