Blosc / Blosc/python-blosc2

Document SUMMARY indexes for end users

Abierto
#645 0 comentarios 0 reacciones 0 asignados Ver en GitHub
documentation good first issue
Lenguaje dominante
Python
Estrellas
211
Forks
58
Merge medio
1 d 17 h
PR fusionados (30 d)
6

Descripción

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

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza con tutorial 15.indexing-ctables.ipynb y el comportamiento del índice SUMMARY descrito en el issue; después, inspecciona doc/reference/ctable.rst para consultar el parámetro create_summary_index. Añade la explicación orientada al usuario, los detalles para desactivarlo y verificarlo, además de un ejemplo realista de tiempos que compare consultas con y sin índices SUMMARY. El trabajo estará terminado cuando ambas ubicaciones de la documentación cubran la funcionalidad y hagan referencia al parámetro.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
jupyter-notebook, python
Área
databases, documentation
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Tranquilo
Claridad
Bien especificado
Aptitud para principiantes
74/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.