scverse / scverse/spatialdata-tutorials

Confusion of labels and images in labels_shapes_interchangeability.ipynb

Offen
#146 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Jupyter Notebook
Sterne
67
Forks
26
Ø Merge
4 Min.
Gemergte PRs (30 T.)
1

Beschreibung

I just went through the vectorization/rasterization tutorial.

What I found confusing is that it starts by claiming to convert between shapes and labels:
https://github.com/scverse/spatialdata-notebooks/blob/7ce65b2f8a291fa21fdb1542b91518378726b51d/notebooks/examples/labels_shapes_interchangeability.ipynb#L11

But then, later, shapes are not converted to labels, but to images:
https://github.com/scverse/spatialdata-notebooks/blob/7ce65b2f8a291fa21fdb1542b91518378726b51d/notebooks/examples/labels_shapes_interchangeability.ipynb#L265

I wanted to convert shapes to labels, but it took me a while to realize I needed to set return_regions_as_labels=True.
I imagine that converting from shape to label is needed more often, because then you can use the labels to aggregate. Would it make sense to update the example to conversion into labels instead of images?

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Öffne notebooks/examples/labels_shapes_interchangeability.ipynb und vergleiche die einleitende Aussage nahe Zeile 11 mit der nahe Zeile 265 gezeigten Konvertierung. Prüfe, wie return_regions_as_labels=True das Beispiel verändert, und aktualisiere anschließend den Notebook-Text oder das Beispiel, sodass das dokumentierte Verhalten von Shapes zu Labels eindeutig ist, und verifiziere, dass das gerenderte Tutorial konsistent ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
jupyter-notebook
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
55/100

Neue Issues direkt in Ihr Postfach

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