Skip to content

ZedProfiler docs#26

Merged
MikeLippincott merged 19 commits into
WayScience:mainfrom
MikeLippincott:generate_docs
Jun 10, 2026
Merged

ZedProfiler docs#26
MikeLippincott merged 19 commits into
WayScience:mainfrom
MikeLippincott:generate_docs

Conversation

@MikeLippincott

Copy link
Copy Markdown
Member

Description

Establishing V0.1 docs and notebook walkthrough.

What kind of change(s) are included?

  • Documentation (changes docs or other related content)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have searched for existing content to ensure this is not a duplicate.
  • I have performed a self-review of these additions (including spelling, grammar, and related).
  • [] These changes pass all pre-commit checks.
  • I have added comments to my code to help provide understanding
  • [] I have added a test which covers the code changes found within this PR
  • I have deleted all non-relevant text in this pull request template.

@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@gwaybio

gwaybio commented Jun 10, 2026

Copy link
Copy Markdown
Member

@MikeLippincott - this is looking strong. Kudos to getting us to this point!

I've made several changes directly on top of yours. I'm going to approve this PR, but please also take a look at my changes and feel free to merge when ready. Please add any comments and I'd be happy to discuss

…miner integration

- Replace pure random noise with 3D spherical objects: compact nuclear channel
  and a diffuse channel with per-object colocalization strength
- Add interactive plotly z-slice browser for synthetic data preview
- Hide data generation and viz code behind expand toggles
- Import featurization modules via zedprofiler dot notation
- Import IO classes via zedprofiler.IO.loading_classes module
- Add pycytominer normalize + feature_select pipeline step
- Add pairwise object correlation heatmap (plotly, RdBu)
- Add walkthrough outline to intro cell
- Add plotly and pycytominer to docs dependency group

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@gwaybio

gwaybio commented Jun 10, 2026

Copy link
Copy Markdown
Member

the most recent commit enhances quality of life for the walkthrough and I think will be more impactful for someone (or an agent) wishing to understand ZP

Comment thread pyproject.toml Outdated
@MikeLippincott MikeLippincott merged commit 31871fe into WayScience:main Jun 10, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants