facebookresearch/fmmax

Better type checking in `eigensolve_isotropic_media`

Ouverte

#53 ouverte le 31 oct. 2023

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Jupyter Notebook (15 forks)auto 404
enhancementgood first issue

Métriques du dépôt

Stars
 (149 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Inspectez la fonction `eigensolve isotropic media` pour localiser où `wavelength` est utilisé. Ajoutez une vérification de type pour affirmer que `wavelength` est un tableau jax, ou convertissez automatiquement un float en tableau jax pour éviter des erreurs obscures.
Stack technique
python
Domaine
backend
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80