facebookresearch/fmmax

Better type checking in `eigensolve_isotropic_media`

Open

#53 opened on Oct 31, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Jupyter Notebook (15 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (149 stars)
PR merge metrics
 (PR metrics pending)

Description

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.

Contributor guide

Research direction
Inspect the function `eigensolve isotropic media` to locate where `wavelength` is used. Add type checking to assert that `wavelength` is a jax array, or automatically convert a float to a jax array to avoid obscure errors.
Tech stack
python
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80