Skip to content

Commit

Permalink
Merge pull request #127 from invrs-io/doc
Browse files Browse the repository at this point in the history
improve docstring
  • Loading branch information
mfschubert authored Jul 11, 2024
2 parents 9b12da5 + 27985ae commit 362036e
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions src/invrs_gym/challenges/library/challenge.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,11 @@ def eval_metric(
) -> jnp.ndarray:
"""Computes the eval metric from the component `response`.
The evaluation metric is the minimum relative efficiency across all incident
polarizations and wavelengths.
The eval metric considers a metagrating assembled from the eight meta-atoms in
the library. The relative efficiency of the grating (i.e. transmitted power
into the target order divided by total transmitted power) is computed for each
wavelength and the two incident polarization states. The eval metric is the
minimum relative efficiency among all these cases.
Args:
response: The component response.
Expand Down

0 comments on commit 362036e

Please sign in to comment.