Better document the impact of data dtype on performance

Aperta
#992 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
56/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
numpy, python
Ambito
documentation

Direzione di ricerca

Start by locating the napari documentation pages that explain image data and performance, then trace how Layer.data reaches the displayed GPU texture as suggested in the issue. Document the supported dtypes, when other dtypes are coerced during slicing, and the performance impact; done means users can find this guidance and understand the implications for large slices.

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

Descrizione

documentation task

🧰 Task

Our vispy/gpu pipeline only supports int8, uint8, int16, uint16, float32, other dtypes get coerced during slicing.
This has a pretty significant performance implication for large slices of e.g. float64 or in64 data.
See also: https://github.com/napari/napari/issues/1300#issuecomment-4274666208

Importantly, many numpy functions can produce float64 or int64 by default, triggering this issue.

We should raise more awareness of this in the documentation and possibly add an in-depth look at the data handling pipeline from Layer.data to the displayed gpu texture.

Lingua principale
Makefile
Stelle
13
Fork
71
Merge medio
3g 11h
PR unite (30g)
30

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di napari/docs

Tutte le issue di napari/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.