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.

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

Add DeepLearningUI extension #1811

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

mturja-vf-ic-bd
Copy link
Contributor

@mturja-vf-ic-bd mturja-vf-ic-bd commented Mar 2, 2022

New extension

  • Extension has a reasonable name (not too general, not too narrow, suggests what the extension is for)
  • Repository name is Slicer+ExtensionName
  • Repository is associated with 3d-slicer-extension GitHub topic so that it is listed here. To edit topics, click the settings icon in the right side of "About" section header and enter 3d-slicer-extension in "Topics" and click "Save changes". To learn more about topics, read https://help.github.com/en/articles/about-topics
  • Extension description summarizes in 1-2 sentences what the extension is usable (should be understandable for non-experts)
  • Any known related patents must be mentioned in the extension description.
  • If source code license is more restrictive for users than BSD, MIT, Apache, or 3D Slicer license then the name of the used license must be mentioned in the extension description.
  • Extension URL and revision (scmurl, scmrevision) is correct, consider using a branch name (main, master, release, ...) instead of a specific git has to avoid re-submitting pull request whenever the extension is updated
  • Extension icon URL is correct (do not use the icon's webpage but the raw data download URL that you get from the download button - it should look something like this: https://raw.githubusercontent.com/user/repo/main/SomeIcon.png)
  • Screenshot URLs (screenshoturls) are correct, contains at least one
  • Homepage URL points to valid webpage containing the following:
    • Extension name
    • Short description: 1-2 sentences, which summarizes what the extension is usable for
    • At least one nice, informative image, that illustrates what the extension can do. It may be a screenshot.
    • Description of contained modules: at one sentence for each module
    • Tutorial: step-by-step description of at least the most typical use case, include a few screenshots, provide download links to sample input data set
    • Publication: link to publication and/or to PubMed reference (if available)
    • License: We suggest you use a permissive license that includes patent and contribution clauses. This will help protect developers and ensure the code remains freely available. We suggest you use the Slicer License or the Apache 2.0. Always mention in your README file the license you have chosen. If you choose a different license, explain why to the extension maintainers. Depending on the license we may not be able to host your work. Read here to learn more about licenses.
    • Content of submitted s4ext file is consistent with the top-level CMakeLists.txt file in the repository (description, URLs, dependencies, etc. are the same)

Copy link
Member

@pieper pieper left a comment

Choose a reason for hiding this comment

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

This is interesting and I'm glad you were able to implement it, but I have some questions that were unclear from the readme. First, how is one expected to generate the training data and why is it jpeg? Is there a repository of example training data? Second, how does on use the resulting model? Can you apply it to new data loaded in Slicer?

@mturja-vf-ic-bd
Copy link
Contributor Author

This is interesting and I'm glad you were able to implement it, but I have some questions that were unclear from the readme. First, how is one expected to generate the training data and why is it jpeg? Is there a repository of example training data? Second, how does on use the resulting model? Can you apply it to new data loaded in Slicer?

Great questions. I am currently working on making the data generation process easier by designing another module that will be added to the same extension. The same goes for prediction. So There will be three modules in this extension: 1. Data preparation, 2. Training, 3. Testing. Among which only Training part is done.

@pieper
Copy link
Member

pieper commented Mar 2, 2022

Sounds good, looking forward to seeing it 👍

It probably makes sense to wait for the complete workflow before merging this and then posting on discourse with an example video or tutorial.

@mturja-vf-ic-bd
Copy link
Contributor Author

@Connor-Bowley Will you have a look?

@Connor-Bowley
Copy link

Yes I will take a look at your extension.

@Connor-Bowley
Copy link

Connor-Bowley commented Mar 7, 2022

@jcfr
Copy link
Member

jcfr commented Mar 14, 2022

@Connor-Bowley Thanks for the help reviewing 🙏

@mturja-vf-ic-bd After reviewing the suggestions linked above, let us know if you have any questions.

@mturja-vf-ic-bd
Copy link
Contributor Author

@Connor-Bowley I have addressed your additional comments.

@Connor-Bowley
Copy link

@mturja-vf-ic-bd The extension is looking good. There are a few checkbox items you still need to address (e.g. the license)

@mturja-vf-ic-bd
Copy link
Contributor Author

The checkbox items are addressed.

@Connor-Bowley
Copy link

@Connor-Bowley
Copy link

Similarly the screenshot URL should be https://raw.githubusercontent.com/mturja-vf-ic-bd/SlicerDeepLearningUI/main/screenshot.png

One way to get the URL on Chrome is to go to the file in github, right-click on the image, and do "Open image in new tab". That should open the image where you can grab the correct link.

@jcfr jcfr changed the title Adding s4ext for DeepLearningUI extension Add DeepLearningUI extension Jul 28, 2022
@jcfr jcfr added the Status: Awaiting Response ⏳ Waiting for a response/more information label Aug 16, 2023
@jcfr jcfr force-pushed the mturja-vf-ic-bd-patch-1 branch from 34fb2c4 to d08158d Compare May 1, 2024 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Awaiting Response ⏳ Waiting for a response/more information
Development

Successfully merging this pull request may close these issues.

4 participants