Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

[DOC] Container Architecture & Chunking Sizing Guide (Decision Matrix)

Abierto
  • ¿Algo no está bien?
#722 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

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

Línea de trabajo

The guide will be a new Markdown file at doc/getting_started/choosing_containers_and_chunking.md. Start by reading the existing doc/getting_started/index.rst to understand the documentation structure and the linked issue #651 for terminology. Review the project's README and the main documentation to understand the different container types (NDArray, CTable, etc.) and their use cases. The guide should include a decision matrix table and chunking guidelines. Done looks like a complete Markdown file that is linked from the index.

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

Descripción

documentation sustain-2026

New contributors and users face two key architectural questions when getting started:

  1. Which container should I choose? (NDArray vs CTable vs SChunk vs TreeStore vs DictStore vs BatchArray).
  2. How do I choose chunk and block shapes? (Balancing compression ratio, CPU cache locality, slicing granularity, and storage overhead).

While issue #651 addresses a terminology glossary, there is no practical decision matrix or chunking rules-of-thumb guide in the documentation.

Suggested Work

Create a Markdown guide at doc/getting_started/choosing_containers_and_chunking.md (and link it from doc/getting_started/index.rst).

The guide should feature:

  1. Container Decision Matrix: A structured table comparing:
    • Data Geometry (multidimensional, tabular/relational, key-value, hierarchical tree)
    • Read/write mutability and append performance
    • Query capabilities (expression evaluation, SQL/where filtering, coordinate slicing)
    • On-disk layout (.b2nd, .b2frame, .b2z, .b2d)
  2. Chunking vs. Blocking Rules of Thumb:
    • Clear explanation of the two-level chunking hierarchy: chunks represent disk/network transfer units (typically 1 MB – 64 MB), whereas blocks represent CPU cache units (typically 64 KB – 1 MB to fit L2/L3 caches).
    • Practical guidelines for 1D, 2D, and 3D data geometries.
    • Trade-offs: large chunks (better compression) vs. small chunks (faster random slicing).
Lenguaje dominante
Python
Estrellas
211
Forks
63
Merge medio
2 d 1 h
PR fusionados (30 d)
9

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Blosc/python-blosc2

Todos los issues de Blosc/python-blosc2

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.