facebookresearch/fmmax

Better type checking in `eigensolve_isotropic_media`

Open

#53 建立於 2023年10月31日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Jupyter Notebook (15 fork)auto 404
enhancementgood first issue

倉庫指標

Star
 (149 star)
PR 合併指標
 (PR 指標待抓取)

描述

Currently, if the wavelength parameter within eigensolve_isotropic_media is passed as a float, rather than a jax array, then it throws an obscure error (not directly pointing to the wavelength parameter itself).

It would be good to either

  • explicitly allow for float values and do the necessary conversions under the hood.
  • assert a type up front and throw an error describing why this needs to be the case.

貢獻者指南

研究方向
檢查函數 `eigensolve isotropic media`，找到使用 `wavelength` 的位置。添加類型檢查，斷言 `wavelength` 是 jax 數組，或者自動將 float 轉換為 jax 數組，以避免模糊的錯誤。
技術棧
python
領域
backend
議題類型
錯誤
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1 小時以內
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Python
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80