Blosc / Blosc/python-blosc2

Document SUMMARY indexes for end users

Offen
#645 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
documentation good first issue
Vorherrschende Sprache
Python
Sterne
211
Forks
58
Ø Merge
1 T. 17 Std.
Gemergte PRs (30 T.)
6

Beschreibung

SUMMARY indexes are now built automatically when a CTable is first closed, and they accelerate where() queries by skipping blocks that cannot match the predicate. This is a significant feature but it is only described in the API reference, not in any user-facing guide. The tutorial 15.indexing-ctables.ipynb covers FULL/PARTIAL indexes but does not mention SUMMARY at all.

Suggested work:
- Add a section to 15.indexing-ctables.ipynb explaining: what SUMMARY indexes store (per-block min/max), when they are built automatically, the create_summary_index=False opt-out, and how to verify they are being used.
- Add a short example that measures query time with and without a SUMMARY index on a realistic dataset
- Update doc/reference/ctable.rst to cross-reference the new create_summary_index parameter

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit tutorial 15.indexing-ctables.ipynb und dem im Issue beschriebenen Verhalten des SUMMARY-Index und untersuche anschließend doc/reference/ctable.rst auf den Parameter create_summary_index. Füge die benutzerseitige Erklärung, Details zum Deaktivieren und zur Überprüfung sowie ein realistisches Zeitbeispiel hinzu, das Abfragen mit und ohne SUMMARY-Indizes vergleicht. Als abgeschlossen gilt die Arbeit, wenn beide Dokumentationsstellen das Feature abdecken und auf den Parameter verweisen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
jupyter-notebook, python
Bereich
databases, documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Ruhig
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
74/100

Neue Issues direkt in Ihr Postfach

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