InsightSoftwareConsortium / InsightSoftwareConsortium/SimpleITK-Notebooks

Improve finding of python classes

Aperta
#317 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Jupyter Notebook
Stelle
906
Fork
374
Merge medio
54m
PR unite (30g)
1

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
jupyter-notebook, python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.