Clarity in documentation and code around chunksizes

Ouverte
#779 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
38/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
python
Domaine
documentation

Piste de recherche

Commencez par rechercher “chunksizes” dans la documentation et le code, puis examinez v.data.set_nc_hdf5_chunksizes. Comparez les références aux tailles de chunks de Dask avec les formes et les tailles des chunks des variables. Le travail est terminé lorsque la terminologie et la documentation distinguent clairement ces concepts et décrivent précisément ce que la méthode définit.

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

Description

API review (4.0.0) enhancement

  1. If you search the document for chunksizes you get a lot of stuff about dask chunk sizes first. Can be confusing if you are interested in variable chunksizes.

  2. The method v.data.set_nc_hdf5_chunksizes actually sets the chunk shape, not the volume/size.

E.g. the word size is clearly about the volume, as can be seen from the documentation:

https://docs.unidata.ucar.edu/nug/current/netcdf_perf_chunking.html says "Currently the netCDF default chunk size is 4MiB The current default chunking strategy of the netCDF library is to balance access time alongany of a variable's dimensions, by using chunk shapes similar to the shape of the entire variable but small enough that the resulting chunk size is less than or equal to the default chunk size."

Langage dominant
Python
Étoiles
150
Forks
23
Merge moyen
1 j 11 h
PR mergées (30 j)
2

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de NCAS-CMS/cf-python

Toutes les issues de NCAS-CMS/cf-python

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

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