Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Recommendations for plugins #282

Closed
jiyuuchc opened this issue Nov 20, 2023 · 4 comments
Closed

Recommendations for plugins #282

jiyuuchc opened this issue Nov 20, 2023 · 4 comments

Comments

@jiyuuchc
Copy link

We wrote a TrackMate detector plugin. This is a deep learning based cell detector, originally developed for a local hematology research project, but we are considering releasing it to the public.

While Trackmate already includes several cell-detector options, some users might still find our alternative useful due to its speed.

So before we upload it to image.net, we would like to double check with the upstream to see if there is any recommended "best-practice" for doing this, e.g., just off the top of my head:

  • Package name: we currently use ij.plugin.trackmate.lacss, which in theory could lead to collision. Should we change that?
  • Artifact name. Any conventions?
  • Is it ok to hijack trackmate's mailing list tag, e.g. https://forum.image.sc/tag/trackmate, for the plugin's POM metadata?
  • Anything else?
@jiyuuchc jiyuuchc mentioned this issue Nov 20, 2023
Closed
@tinevez
Copy link
Member

tinevez commented Nov 21, 2023 •
edited
Loading

Hello @jiyuuchc

We wrote a TrackMate detector plugin. This is a deep learning based cell detector, originally developed for a local hematology research project, but we are considering releasing it to the public.
While Trackmate already includes several cell-detector options, some users might still find our alternative useful due to its speed.

Awesome! We really built TrackMate so that it can be extended by others, and this issue makes my day!
I can't wait to study the technology you used to communicate with Python.

So before we upload it to image.net, we would like to double check with the upstream to see if there is any recommended "best-practice" for doing this, e.g., just off the top of my head:

  • Package name: we currently use ij.plugin.trackmate.lacss, which in theory could lead to collision. Should we change that?

I would recommend using the same root that of the TrackMate packages, though:
fiji.plugin.trackmate.detection.lacss

so that it fits nicely under the same package hierarchy common to all detectors.

  • Artifact name. Any conventions?

We recommend TrackMate-Something, with a capital 'S'. See for instance the artifact names for the other extensions:
https://github.com/orgs/trackmate-sc/repositories

Totally ok.

  • Anything else?

We are working on a v8 version, that will support 3D segmentation. This will cause major changes in the API that might affect you. Check the draft PR for a succint description of what will happen:
#263

But in any case we will be there to help with porting your code to the future new v8, to be out probably early next year or for Christmas.

@jiyuuchc
Copy link
Author

jiyuuchc commented Nov 21, 2023 via email

@Nick-Kuang Nick-Kuang mentioned this issue Dec 14, 2023
Merged
@tinevez
Copy link
Member

tinevez commented Feb 7, 2024

Yes absolutely.
Anything else? Can I close this issue?

@jiyuuchc
Copy link
Author

jiyuuchc commented Feb 7, 2024 via email

@tinevez tinevez closed this as completed Feb 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jiyuuchc @tinevez