Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

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

Aberta
  • Algo errado?
#722 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 2 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
70/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
markdown, python
Domínio
documentation

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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).
Linguagem predominante
Python
Estrelas
211
Forks
63
Merge médio
2d 1h
PRs com merge (30d)
9

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de Blosc/python-blosc2

Todas as issues de Blosc/python-blosc2

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.