Merge pull request #31 from invrs-io/nanometer

Update docs to report length scale in nanometers
invrs-io · Jul 15, 2024 · 0c20abc · 0c20abc
2 parents 588cd7f + 7cf7fde
commit 0c20abc
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 14 deletions.
diff --git a/docs/notebooks/bayer_sorter.ipynb b/docs/notebooks/bayer_sorter.ipynb
@@ -27,7 +27,8 @@
    "source": [
     "from invrs_gym import challenges\n",
     "\n",
-    "docstring = challenges.bayer_sorter().eval_metric.__doc__\n",
+    "challenge = challenges.bayer_sorter()\n",
+    "docstring = challenge.eval_metric.__doc__\n",
     "print(\"\\n\".join([s[8:] for s in docstring.split(\"Args\")[0].split(\"\\n\")[2:-2]]))"
    ]
   },
@@ -48,12 +49,15 @@
     "from invrs_leaderboard import data\n",
     "\n",
     "df = data.leaderboard_dataframe(base_path=\"../../\")\n",
+    "df[\"minimum_length_scale_nm\"] = (\n",
+    "    df[\"minimum_length_scale\"] * challenge.component.spec.grid_spacing * 1000\n",
+    ")\n",
     "\n",
     "def plot_challenge_metrics(challenge_name: str) -> display.DisplayHandle:\n",
     "    challenge_df = df[df[\"challenge\"] == challenge_name]\n",
     "    fig = px.scatter(\n",
     "        challenge_df,\n",
-    "        x=\"minimum_length_scale\",\n",
+    "        x=\"minimum_length_scale_nm\",\n",
     "        y=\"eval_metric\",\n",
     "        color=\"file_prefix\",\n",
     "        hover_data=[\"file\", \"minimum_width\", \"minimum_spacing\", \"binarization_degree\"],\n",

diff --git a/docs/notebooks/ceviche_challenges.ipynb b/docs/notebooks/ceviche_challenges.ipynb
@@ -27,7 +27,8 @@
    "source": [
     "from invrs_gym import challenges\n",
     "\n",
-    "docstring = challenges.ceviche_beam_splitter().eval_metric.__doc__\n",
+    "challenge = challenges.ceviche_beam_splitter()\n",
+    "docstring = challenge.eval_metric.__doc__\n",
     "print(\"\\n\".join([s[8:] for s in docstring.split(\"Args\")[0].split(\"\\n\")[2:-2]]))"
    ]
   },
@@ -48,12 +49,15 @@
     "from invrs_leaderboard import data\n",
     "\n",
     "df = data.leaderboard_dataframe(base_path=\"../../\")\n",
+    "df[\"minimum_length_scale_nm\"] = (\n",
+    "    df[\"minimum_length_scale\"] * float(challenge.component.ceviche_model.params.resolution)\n",
+    ")\n",
     "\n",
     "def plot_challenge_metrics(challenge_name: str) -> display.DisplayHandle:\n",
     "    challenge_df = df[df[\"challenge\"] == challenge_name]\n",
     "    fig = px.scatter(\n",
     "        challenge_df,\n",
-    "        x=\"minimum_length_scale\",\n",
+    "        x=\"minimum_length_scale_nm\",\n",
     "        y=\"eval_metric\",\n",
     "        color=\"file_prefix\",\n",
     "        hover_data=[\"file\", \"minimum_width\", \"minimum_spacing\", \"binarization_degree\"],\n",

diff --git a/docs/notebooks/diffractive_splitter.ipynb b/docs/notebooks/diffractive_splitter.ipynb
@@ -27,7 +27,8 @@
    "source": [
     "from invrs_gym import challenges\n",
     "\n",
-    "docstring = challenges.diffractive_splitter().eval_metric.__doc__\n",
+    "challenge = challenges.diffractive_splitter()\n",
+    "docstring = challenge.eval_metric.__doc__\n",
     "print(\"\\n\".join([s[8:] for s in docstring.split(\"Args\")[0].split(\"\\n\")[2:-2]]))"
    ]
   },
@@ -48,12 +49,15 @@
     "from invrs_leaderboard import data\n",
     "\n",
     "df = data.leaderboard_dataframe(base_path=\"../../\")\n",
+    "df[\"minimum_length_scale_nm\"] = (\n",
+    "    df[\"minimum_length_scale\"] * challenge.component.spec.grid_spacing * 1000\n",
+    ")\n",
     "\n",
     "def plot_challenge_metrics(challenge_name: str) -> display.DisplayHandle:\n",
     "    challenge_df = df[df[\"challenge\"] == challenge_name]\n",
     "    fig = px.scatter(\n",
     "        challenge_df,\n",
-    "        x=\"minimum_length_scale\",\n",
+    "        x=\"minimum_length_scale_nm\",\n",
     "        y=\"eval_metric\",\n",
     "        color=\"file_prefix\",\n",
     "        hover_data=[\"file\", \"minimum_width\", \"minimum_spacing\", \"binarization_degree\"],\n",

diff --git a/docs/notebooks/meta_atom_library.ipynb b/docs/notebooks/meta_atom_library.ipynb
@@ -27,7 +27,8 @@
    "source": [
     "from invrs_gym import challenges\n",
     "\n",
-    "docstring = challenges.meta_atom_library().eval_metric.__doc__\n",
+    "challenge = challenges.meta_atom_library()\n",
+    "docstring = challenge.eval_metric.__doc__\n",
     "print(\"\\n\".join([s[8:] for s in docstring.split(\"Args\")[0].split(\"\\n\")[2:-2]]))"
    ]
   },
@@ -48,12 +49,15 @@
     "from invrs_leaderboard import data\n",
     "\n",
     "df = data.leaderboard_dataframe(base_path=\"../../\")\n",
+    "df[\"minimum_length_scale_nm\"] = (\n",
+    "    df[\"minimum_length_scale\"] * challenge.component.spec.grid_spacing * 1000\n",
+    ")\n",
     "\n",
     "def plot_challenge_metrics(challenge_name: str) -> display.DisplayHandle:\n",
     "    challenge_df = df[df[\"challenge\"] == challenge_name]\n",
     "    fig = px.scatter(\n",
     "        challenge_df,\n",
-    "        x=\"minimum_length_scale\",\n",
+    "        x=\"minimum_length_scale_nm\",\n",
     "        y=\"eval_metric\",\n",
     "        color=\"file_prefix\",\n",
     "        hover_data=[\"file\", \"minimum_width\", \"minimum_spacing\", \"binarization_degree\"],\n",

diff --git a/docs/notebooks/metagrating.ipynb b/docs/notebooks/metagrating.ipynb
@@ -27,7 +27,8 @@
    "source": [
     "from invrs_gym import challenges\n",
     "\n",
-    "docstring = challenges.metagrating().eval_metric.__doc__\n",
+    "challenge = challenges.metagrating()\n",
+    "docstring = challenge.eval_metric.__doc__\n",
     "print(\"\\n\".join([s[8:] for s in docstring.split(\"Args\")[0].split(\"\\n\")[2:-2]]))"
    ]
   },
@@ -48,12 +49,15 @@
     "from invrs_leaderboard import data\n",
     "\n",
     "df = data.leaderboard_dataframe(base_path=\"../../\")\n",
+    "df[\"minimum_length_scale_nm\"] = (\n",
+    "    df[\"minimum_length_scale\"] * challenge.component.spec.grid_spacing * 1000\n",
+    ")\n",
     "\n",
     "def plot_challenge_metrics(challenge_name: str) -> display.DisplayHandle:\n",
     "    challenge_df = df[df[\"challenge\"] == challenge_name]\n",
     "    fig = px.scatter(\n",
     "        challenge_df,\n",
-    "        x=\"minimum_length_scale\",\n",
+    "        x=\"minimum_length_scale_nm\",\n",
     "        y=\"eval_metric\",\n",
     "        color=\"file_prefix\",\n",
     "        hover_data=[\"file\", \"minimum_width\", \"minimum_spacing\", \"binarization_degree\"],\n",

diff --git a/docs/notebooks/metalens.ipynb b/docs/notebooks/metalens.ipynb
@@ -27,7 +27,8 @@
    "source": [
     "from invrs_gym import challenges\n",
     "\n",
-    "docstring = challenges.metalens().eval_metric.__doc__\n",
+    "challenge = challenges.metalens()\n",
+    "docstring = challenge.eval_metric.__doc__\n",
     "print(\"\\n\".join([s[8:] for s in docstring.split(\"Args\")[0].split(\"\\n\")[2:-2]]))"
    ]
   },
@@ -48,12 +49,15 @@
     "from invrs_leaderboard import data\n",
     "\n",
     "df = data.leaderboard_dataframe(base_path=\"../../\")\n",
+    "df[\"minimum_length_scale_nm\"] = (\n",
+    "    df[\"minimum_length_scale\"] * challenge.component.spec.grid_spacing * 1000\n",
+    ")\n",
     "\n",
     "def plot_challenge_metrics(challenge_name: str) -> display.DisplayHandle:\n",
     "    challenge_df = df[df[\"challenge\"] == challenge_name]\n",
     "    fig = px.scatter(\n",
     "        challenge_df,\n",
-    "        x=\"minimum_length_scale\",\n",
+    "        x=\"minimum_length_scale_nm\",\n",
     "        y=\"eval_metric\",\n",
     "        color=\"file_prefix\",\n",
     "        hover_data=[\"file\", \"minimum_width\", \"minimum_spacing\", \"binarization_degree\"],\n",

diff --git a/docs/notebooks/photon_extractor.ipynb b/docs/notebooks/photon_extractor.ipynb
@@ -27,7 +27,8 @@
    "source": [
     "from invrs_gym import challenges\n",
     "\n",
-    "docstring = challenges.photon_extractor().eval_metric.__doc__\n",
+    "challenge = challenges.photon_extractor()\n",
+    "docstring = challenge.eval_metric.__doc__\n",
     "print(\"\\n\".join([s[8:] for s in docstring.split(\"Args\")[0].split(\"\\n\")[2:-2]]))"
    ]
   },
@@ -48,12 +49,15 @@
     "from invrs_leaderboard import data\n",
     "\n",
     "df = data.leaderboard_dataframe(base_path=\"../../\")\n",
+    "df[\"minimum_length_scale_nm\"] = (\n",
+    "    df[\"minimum_length_scale\"] * challenge.component.spec.grid_spacing * 1000\n",
+    ")\n",
     "\n",
     "def plot_challenge_metrics(challenge_name: str) -> display.DisplayHandle:\n",
     "    challenge_df = df[df[\"challenge\"] == challenge_name]\n",
     "    fig = px.scatter(\n",
     "        challenge_df,\n",
-    "        x=\"minimum_length_scale\",\n",
+    "        x=\"minimum_length_scale_nm\",\n",
     "        y=\"eval_metric\",\n",
     "        color=\"file_prefix\",\n",
     "        hover_data=[\"file\", \"minimum_width\", \"minimum_spacing\", \"binarization_degree\"],\n",