NumPy ベストプラクティス

NumPy開発のための専門的なガイドライン。配列プログラミング、数値計算、パフォーマンス最適化に焦点を当てています。

コードスタイルと構造

• 正確なNumPyの例を含む簡潔で技術的なPythonコードを書く
• 明示的なループより、パフォーマンスのためにベクトル化操作を優先する
• データ内容を反映した説明的な変数名を使用する (例: weights, gradients, input_array)
• Pythonコードについては PEP 8 スタイルガイドに従う
• 適切な場合は関数型プログラミングパターンを使用する

配列の作成と操作

• 適切な配列作成関数を使用する: np.array(), np.zeros(), np.ones(), np.empty(), np.arange(), np.linspace()
• 配列サイズが既知の場合は、事前割り当てに np.zeros() または np.empty() を優先する
• 配列の結合には np.concatenate(), np.vstack(), np.hstack() を使用する
• 異なる形状の配列への操作には、ブロードキャストを活用する

インデックスとスライシング

• 条件付き選択には、ブール配列を用いた高度なインデックスを使用する
• メモリを節約するため、可能な限りコピーではなくビューを優先する
• 条件付き要素選択には np.where() を使用する
• ファンシーインデックス (コピーを作成) と基本的なスライシング (ビューを作成) の違いを理解する

データ型

• dtype パラメータを使用して、明示的に適切なデータ型を指定する
• 完全な精度が不要な場合は、メモリ効率のために np.float32 を使用する
• 固定サイズの整数型での整数オーバーフローに注意する
• 不要なコピーなしで型変換するために np.asarray() を使用する

パフォーマンス最適化

ベクトル化

• Pythonループより必ずベクトル化操作を優先する
• 要素ごとの操作には NumPy ユニバーサル関数 (ufuncs) を使用する
• 複雑なテンソル操作には np.einsum() を活用する
• 行列乗算には np.dot() または @ 演算子を使用する

メモリ管理

• メモリレイアウト (C連続 vs Fortran連続) を確認するために np.ndarray.flags を使用する
• 可能な限り out パラメータを用いた場所での操作を優先する
• 大規模データセットにはメモリマップ配列 (np.memmap) を使用する
• 配列のコピーとビューに注意を払う

計算効率

• 集計には axis パラメータを使用して np.sum(), np.mean(), np.std() を使用する
• 累積操作には np.cumsum(), np.cumprod() を活用する
• ソート済み配列の効率的な操作には np.searchsorted() を使用する

エラーハンドリングと検証

• 計算の前に、入力の形状とデータ型を検証する
• 情報的なメッセージを含む次元チェックのためにアサーションを使用する
• np.isnan(), np.isinf() を使用して、NaN と Inf 値を適切に処理する
• 浮動小数点エラー処理を制御するために np.errstate() コンテキストマネージャを使用する

乱数生成

• 最新の乱数生成には np.random.default_rng() を使用する
• 再現性のためにシードを設定する: rng = np.random.default_rng(seed=42)
• レガシー np.random 関数より新しい Generator API を優先する
• 適切な分布を使用する: rng.normal(), rng.uniform(), rng.choice()

線形代数

• 線形代数操作には np.linalg を使用する
• 線形システムでは逆行列の計算ではなく np.linalg.solve() を活用する
• 分解には np.linalg.eig(), np.linalg.svd() を使用する
• 反転前に np.linalg.cond() で行列条件を確認する

テストとドキュメンテーション

• np.testing アサーションで pytest を使用したユニットテストを書く
• 完全な比較には np.testing.assert_array_equal() を使用する
• 浮動小数点比較には np.testing.assert_array_almost_equal() を使用する
• NumPy ドキュメンテーション形式に従う包括的なドキュメント文字列を含める

主要な規約

• import numpy as np としてインポートする
• 変数と関数には snake_case を使用する
• ドキュメント文字列に配列の形状を記載する
• %timeit を使用してコードをプロファイルし、ボトルネックを特定する