Skip to content

Commit

Permalink
improve docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
mfschubert committed Aug 13, 2024
1 parent 04bf6b4 commit 1eadf5c
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/invrs_gym/challenges/library/challenge.py
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,12 @@ def meta_atom_library(
reaching broadband 90% relative diffraction efficiency" by Chen et al.
https://www.nature.com/articles/s41467-023-38185-2
In the library design challenge, all possible rotations of the individual meta-
atoms are considered. The optimal rotation (i.e. that which yield the highest
wavelength-averaged relative efficiency) is used to compute evaluation metrics
and loss. The optimal rotations can be found and applied using the
`optimal_rotation` and `rotate_params` functions in this module.
Args:
minimum_width: The minimum width target for the challenge, in pixels.
minimum_spacing: The minimum spacing target for the challenge, in pixels.
Expand Down

0 comments on commit 1eadf5c

Please sign in to comment.