-
Notifications
You must be signed in to change notification settings - Fork 2
add new roadmap #31
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.
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
Open
MikeLippincott
wants to merge
2
commits into
WayScience:main
Choose a base branch
from
MikeLippincott:roadmap
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
add new roadmap #31
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||
|---|---|---|---|---|
|
|
@@ -4,115 +4,16 @@ This file is for planning of new modules, features, and PRs that are needed the | |||
| The roadmap is organized into phases, with each phase containing a set of PRs that build upon each other. | ||||
| The roadmap is intended to be a living document and may be updated as needed. | ||||
|
|
||||
| ## Scope for current release | ||||
| ## Future Plans | ||||
|
|
||||
| ### In scope | ||||
|
|
||||
| - [ ] Handcrafted featurization modules: | ||||
| - [ ] volumesizeshape | ||||
| - [ ] Colocalization | ||||
| - [ ] Intensity | ||||
| - [ ] Granularity | ||||
| - [ ] Neighbors | ||||
| - [ ] Texture | ||||
| - [ ] Featurization helper utilities needed by the modules | ||||
| - [ ] Full test suite with coverage gate (>=85%) | ||||
| - [ ] Sphinx documentation | ||||
| - [ ] Example notebooks for module usage | ||||
| - [ ] Our [RFC2119-specification](./docs/src/Feature_Naming_Convention.md) driven feature naming policy | ||||
|
|
||||
| ## Architecture and Product Decisions | ||||
|
|
||||
| - [ ] Linux-first, CPU-only, low RAM usage for the current release. | ||||
| - [ ] File-format agnostic APIs operating on NumPy arrays. | ||||
| - [ ] Input contracts: | ||||
| - [ ] Single-channel arrays: (z, y, x) | ||||
| - [ ] Multi-channel arrays: (c, z, y, x) | ||||
| - [ ] Modules are intentionally small and composable for external parallel orchestration. | ||||
|
|
||||
| ## PR Plan | ||||
|
|
||||
| ### Phase 1: Foundation (PR 1-3) | ||||
|
|
||||
| 1. PR 1: Packaging and environment baseline | ||||
|
|
||||
| - [x] Python package scaffold, uv dependency management, version metadata 0.0.1, lint/test tooling, CI skeleton. | ||||
| - [x] Linux support and CPU-only scope statements in metadata and docs. | ||||
|
|
||||
| 2. PR 2: Core data model and API contracts | ||||
|
|
||||
| - [x] Canonical input contracts, loader interfaces, common error types. | ||||
| - [x] Return schema contract (required keys, types, deterministic ordering). | ||||
|
|
||||
| 3. PR 3: RFC2119 naming specification and validators | ||||
|
|
||||
| - [x] Port and adapt naming conventions into this repository. | ||||
| - [x] Add runtime and CI naming validation helpers and conformance tests. | ||||
|
|
||||
| ### Phase 2: Feature modules and tests (PR 4-9) | ||||
|
|
||||
| 4. PR 4: volumesizeshape module and tests | ||||
|
|
||||
| - [x] Implement module | ||||
|
|
||||
| 1. PR 5: Colocalization module and tests | ||||
|
|
||||
| - [x] Implement module | ||||
|
|
||||
| 1. PR 6: Intensity module and tests | ||||
|
|
||||
| - [x] Implement module | ||||
|
|
||||
| 1. PR 7: Granularity module and tests | ||||
|
|
||||
| - [x] Implement module | ||||
|
|
||||
| 1. PR 8: Neighbors module and tests | ||||
|
|
||||
| - [x] Implement module | ||||
|
|
||||
| 1. PR 9: Texture module and tests | ||||
|
|
||||
| - [x] Implement module | ||||
|
|
||||
| ### Phase 3: Integration, docs, release (PR 10-13) | ||||
|
|
||||
| 10. PR 10: Integration matrix and parallelization guidance | ||||
|
|
||||
| - [x] Cross-module integration tests and explicit non-goal docs for internal parallelization. | ||||
|
|
||||
| 11. PR 11: Example notebooks and public dataset references | ||||
|
|
||||
| - [ ] One notebook per module plus one end-to-end chaining notebook. | ||||
|
|
||||
| 12. PR 12: Sphinx docs, logo, API docs | ||||
|
|
||||
| - [ ] API pages, architecture and scope pages, docs build checks in CI. | ||||
|
|
||||
| 13. PR 13: Release v0.0.1 and publish workflow | ||||
|
|
||||
| - [ ] Changelog, semantic tag, PyPI publish automation, README install updates. | ||||
|
|
||||
| ### Phase 4: Post-release improvements (PR 14+) | ||||
|
|
||||
| 14. Add the ability for loading of images from array instead of file | ||||
| file paths for increased flexibility in data sources and testing. | ||||
|
|
||||
| ## Verification Gates | ||||
|
|
||||
| - [x] Run full unit and integration tests on Linux with coverage >=85%. | ||||
| - [x] Run naming validation tests for all emitted feature names. | ||||
| - [ ] Build Sphinx docs in CI with warnings treated as errors. | ||||
| - [ ] Execute example notebooks in a clean environment. | ||||
| - [ ] Validate install/import from both wheel and sdist. | ||||
| - [ ] Perform release dry-run before publishing. | ||||
|
|
||||
| ## v0.0.2 Backlog (Planned) | ||||
|
|
||||
| - [ ] Nucleocentric featurization. | ||||
| - [ ] Pick between pandas and polars for dataframe handling. | ||||
| - [ ] Optional mask output mode. | ||||
| - [ ] Expanded benchmark strategy. | ||||
|
|
||||
| ## v0.0.3 Backlog (Planned) | ||||
|
|
||||
| - [ ] Potential Arrow Flight handoff experiments. | ||||
| - [ ] Cytomining V2 support. | ||||
| - [ ] Support for additional image formats (e.g., TIFF, JPEG, OME-arrow). | ||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Probably not? We'd likely have some preprocessing stage that will be broadly useful (not just inside zp) |
||||
| - [ ] Support multi-channel image loading (lazily). | ||||
| - [ ] Support loading of shapes, vectors, outlines, and contours. | ||||
| - [ ] Integration with cloud storage solutions (e.g., AWS S3, Google Cloud Storage). | ||||
| - [ ] Support with DeepProfiler image handoff (thin arrow flight, but simplified for the use case of image handoff). | ||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i'm not sure i understand this |
||||
| - [ ] Support for additional feature extraction methods (e.g., mesh, graph-based features, point-clouds, polygons). | ||||
| - [ ] Feature-extraction time estimation and optimization. | ||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we've moving away from calling it cytomining v2 (we still use as shorthand)