InsightSoftwareConsortium / InsightSoftwareConsortium/SimpleITK-Notebooks

Improve finding of python classes

Offen
#317 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Jupyter Notebook
Sterne
906
Forks
374
Ø Merge
54 Min.
Gemergte PRs (30 T.)
1

Beschreibung

Let's say I want to find out more about `BinaryDilate`
Here are some approaches:
# A)
Looking in the [simpleitk documentation](https://simpleitk.readthedocs.io/en/master/) search get one hit and that is only the migration guide:
![image](https://user-images.githubusercontent.com/44469195/138475964-f5133868-b8c6-4a3b-8e36-4a1ea621df4d.png)

# B)
In the C++ API I can only find [BinaryDilateImageFilter](https://simpleitk.org/doxygen/latest/html/classitk_1_1simple_1_1BinaryDilateImageFilter.html)
But that does not help me too much in finding out how to e.g. change the `kernelType` parameter.

# C)
Finally, I can search in the [GithubNotebooks repo](https://github.com/InsightSoftwareConsortium/SimpleITK-Notebooks/search?q=BinaryDilate) but also here, not too much information about setting the parameter.
![image](https://user-images.githubusercontent.com/44469195/138476630-f4c63135-2819-4d0f-8452-611e961040f9.png)

# Solutions:

# idea i)
adding a notebook into the notebook gallery, where this parameter is set, e.g. something like this:
https://simpleitk.org/doxygen/latest/html/namespaceitk_1_1simple.html#a38998f2c7b469b1ad8e337a0c6c0697b
![image](https://user-images.githubusercontent.com/44469195/138460543-5f674f54-bf3e-4575-bc23-805bd4a2c9cf.png)

# idea ii)
adding more documentation about how to set parameters in python at simpleitk.readthedocs.io

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Start by reviewing the SimpleITK documentation, the notebook gallery, and the existing BinaryDilate examples linked in the issue. Decide whether a focused notebook example or improved Read the Docs guidance best exposes Python parameter usage, and consider the work done when a reader can find and set kernelType for BinaryDilate without relying on the C++ API.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
jupyter-notebook, python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.