Skip to content

🆕 Add KongNet Model and Example Notebook#987

Merged
shaneahmed merged 120 commits intodev-define-engines-abcfrom
dev-define-KongNet-model
Feb 20, 2026
Merged

🆕 Add KongNet Model and Example Notebook#987
shaneahmed merged 120 commits intodev-define-engines-abcfrom
dev-define-KongNet-model

Conversation

@Jiaqi-Lv
Copy link
Collaborator

@Jiaqi-Lv Jiaqi-Lv commented Jan 22, 2026

Summary

This PR integrates KongNet, a state‑of‑the‑art multi‑headed deep learning architecture for nucleus detection and classification. It adds complete documentation, examples, and notebook support covering both patch‑based and whole‑slide image (WSI) processing. Multiple pretrained models are now available for major pathology datasets, each demonstrated through updated example notebooks. The PR also introduces a new visualization image and practical usage patterns for the NucleusDetector class, enabling streamlined workflows for researchers using TIAToolbox.

What’s New

🧠 KongNet Model Integration

Added pretrained KongNet models:

  • KongNet_CoNIC_1, KongNet_PanNuke_1, KongNet_MONKEY_1,
  • KongNet_PUMA_T1_3, KongNet_PUMA_T2_3, KongNet_Det_MIDOG_1.
  • These models capture multi-headed detection signals and achieve strong performance on CoNIC, PanNuke, MONKEY, PUMA, and MIDOG 2025 datasets.

📘 New Example Notebook: Nucleus Detection

A comprehensive example notebook demonstrates:

  • Patch‑level and WSI‑level detection

  • Mitosis and immune‑cell detection

  • Use of NucleusDetector with KongNet pretrained models

  • Interactive visualization via TIAViz

  • Add KongNet Model

  • Add tests

  • Add example notebook (Nucleus Detector)

Jiaqi-Lv and others added 30 commits November 6, 2025 17:23
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 12 out of 13 changed files in this pull request and generated 7 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@shaneahmed
Copy link
Member

Can you add a link to your notebook in examples/README.md? So that it appears on this page https://tia-toolbox--987.org.readthedocs.build/en/987/usage_examples.html

@review-notebook-app
Copy link

review-notebook-app bot commented Feb 19, 2026

View / edit / reply to this conversation on ReviewNB

shaneahmed commented on 2026-02-19T11:26:03Z
----------------------------------------------------------------

Links to NucleusDetection, KongNet should be to blob/develop or blob/master . Currently, they link to a temporary branch. You can also link these to readthedocs latest.


Jiaqi-Lv commented on 2026-02-19T20:14:44Z
----------------------------------------------------------------

Changed to blob/develop

@review-notebook-app
Copy link

review-notebook-app bot commented Feb 19, 2026

View / edit / reply to this conversation on ReviewNB

shaneahmed commented on 2026-02-19T11:26:04Z
----------------------------------------------------------------

Provide some background on AnnotationStore which is the format you need to visualize in TIAViz.


Jiaqi-Lv commented on 2026-02-19T20:35:51Z
----------------------------------------------------------------

Done

Copy link
Collaborator Author

Changed to blob/develop


View entire conversation on ReviewNB

Copy link
Collaborator Author

Done


View entire conversation on ReviewNB

@shaneahmed
Copy link
Member

Jupyter notebook runs successfully with changes in #1001

@shaneahmed shaneahmed merged commit de638a1 into dev-define-engines-abc Feb 20, 2026
15 checks passed
@shaneahmed shaneahmed deleted the dev-define-KongNet-model branch February 20, 2026 16:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants