Blosc / Blosc/python-blosc2

Document SUMMARY indexes for end users

Ouverte
#645 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
documentation good first issue
Langage dominant
Python
Étoiles
211
Forks
58
Merge moyen
1 j 17 h
PR mergées (30 j)
6

Description

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

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par tutorial 15.indexing-ctables.ipynb et par le comportement de l’index SUMMARY décrit dans l’issue, puis examinez doc/reference/ctable.rst pour le paramètre create_summary_index. Ajoutez l’explication destinée à l’utilisateur, les détails permettant de désactiver et de vérifier la fonctionnalité, ainsi qu’un exemple réaliste de temps comparant les requêtes avec et sans index SUMMARY. Le travail est terminé lorsque les deux emplacements de la documentation couvrent la fonctionnalité et renvoient au paramètre.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
jupyter-notebook, python
Domaine
databases, documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
Calme
Clarté
Clairement spécifiée
Accessibilité débutants
74/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.