API review for version 4.0.0: thoughts, ideas, linked Issues, etc.
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 18/100
調査の方向性
これは範囲を限定した実装タスクではなく、API の広範なレビューです。まず Python Array API Standard と、リンクされている issue #775、#772、#773、#277、#328、#38、#135 を読み、その後、一覧にあるトピックと関連する cf-python API の議論をレビューしてください。単一の完了基準はありません。実行可能なトピックは、定義された成果を持つ、焦点を絞った issue に分ける必要があります。
索引モデルが issue の本文から書いたものです。
説明
This Issue is to collate and register any comments (thoughts, ideas, tentative decisions, questions, etc.) including links to self-contained related Issues, regarding the cf-python API (and perhaps the API of cfdm too, also keeping cf-plot and it's eventual incorporation into cf-python in mind).
The context, for those unaware, is that we will be reviewing and revising the API for a forthcoming version 4.0.0, which we hope to release by the end of 2024. Anything anyone wants to register on the topic of the cf-python API is very welcome! Brain dumps are welcome, though we may want to move distinct topics to their own Issues and link them in, if themes emerge.
Useful references are:
- the Python Array API Standard, which we want to abide by unless there is good reason not to;
- the NumPy API which is of high relevance for our array-related operations;
- the Dask API ditto;
- the CF xarray API might be useful for background/comparison.
Please try to organise points/discussion as we go along into topics and themes, noting them below (ideally linking to comments and/or Issues). Anyone contributing to the thread feel free to edit/update this.
Topics and themes
- conforming to the Python Array API standard (see link above)
- deprecated objects:
- ensure all deprecation errors include stating replacements, else messages to indicate why there isn't one any longer (etc.) - should only be a small number of cases that don't abide by this already.
- views/representations of fields/datasets:
- including identical data in different formats, #775.
- truncation for long FieldLists, arrays, etc., #772.
- (methods for) conversion to/from other formats:
- xarray, #773
- availability of methods on given objects vs. module-level, #277
- level of support for NumPy-like operations (generalising sentiment in #328)
- more binary operations (now we are well-daskified), #38
- ensuring sets of related methods have full coverage, esp. pairs e.g. minima and maxima such as argmax and argmin (see https://github.com/NCAS-CMS/cf-python/issues/135)
- aliases e.g. for longer method names - when to use, what to use and how to document (including should we have a big table listing these?)
- simplifications in general - what can sensibly be streamlined?
- verbosity and logging (e.g. which methods deserve a
verbosekeyword)- getting all outputs managed under the logging umbrella, #286.
- 主要言語
- Python
- スター
- 150
- フォーク
- 23
- 平均マージ
- 21時間 29分
- マージ済み PR（30日）
- 1
環境構築
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
NCAS-CMS/cf-python のほかの issue
-
code tidy
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
-
Attempt at unsupported conservative 3D mesh regridding対応中かも @sadielbartholomew が 18 日前に担当しました。 オープンbug?
-
Release: migrate from deprecated build command対応中かも @sadielbartholomew が 21 日前に担当しました。 オープンrelease
-
Remove support for Python 3.10 (EOL)対応中かも @sadielbartholomew が 21 日前に担当しました。 オープンenhancement
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
NCAS-CMS/cf-python の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
spec-kitty/spec-kitty#5319 ·
メンテナーはふだん 1 日以内に返信
-
backend::vllm diffusion multimodal
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
openai/openai-agents-python#5229 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
メンテナーはふだん 1 日以内に返信