support automatic differentiation natively in tidy3d through autograd

Author: tylerflex

.github/ISSUE_TEMPLATE/autograd_bug.md

@@ -0,0 +1,20 @@
+---
+name: Autograd Bug Report
+about: Create a report to help us improve our autograd feature
+title: 'Autograd Bug'
+labels: 'autograd'
+assignees: 'tylerflex'
+
+---
+
+**Description**
+Please paste the error message displayed in your warning when running `tidy3d.web.run()` or `tidy3d.web.run_async()`
+
+**Simulation Setup**
+
+Please describe your simulation setup as specifically as you can, including code snippets or uploading the `simulation.to_file('sim.json')` file. 
+
+Also please include what options were passed to the `web` function.
+
+**Other information**
+Anything else you'd like to add to help us look into it?

.gitignore

@@ -112,7 +112,7 @@ _autosummary
 
 # Test and temporary files
 tests/tmp/*
-tests/data/invdes_history.pkl
+tests/data/invdes_history.*
 
 # Translations
 *.mo
@@ -134,3 +134,6 @@ htmlcov/
 # Specific file and folder exclusions
 .idea
 .vscode
+
+# cProfile output
+*.prof

CHANGELOG.md

@@ -6,6 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
+- Automatic differentiation supported natively in Tidy3D components, and through the `web.run()` and `web.run_async()` functions through `autograd`.
 - A batch of `ModeSolver` objects can be run concurrently using `tidy3d.plugins.mode.web.run_batch()`
 - `RectangularWaveguide.plot_field` optionally draws geometry edges over fields. 
 - `RectangularWaveguide` supports layered cladding above and below core.

docs/api/plugins/autograd.rst

@@ -0,0 +1,40 @@
+.. currentmodule:: tidy3d
+
+Automatic Differentiation with Autograd 
+---------------------------------------
+
+.. toctree::
+
+    ../../../tidy3d/plugins/autograd/README
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+    tidy3d.plugins.autograd.functions.threshold
+    tidy3d.plugins.autograd.functions.rescale
+    tidy3d.plugins.autograd.functions.morphological_gradient_external
+    tidy3d.plugins.autograd.functions.morphological_gradient_internal
+    tidy3d.plugins.autograd.functions.morphological_gradient
+    tidy3d.plugins.autograd.functions.grey_closing
+    tidy3d.plugins.autograd.functions.grey_opening
+    tidy3d.plugins.autograd.functions.grey_erosion
+    tidy3d.plugins.autograd.functions.grey_dilation
+    tidy3d.plugins.autograd.functions.pad
+    tidy3d.plugins.autograd.functions.convolve
+
+    tidy3d.plugins.autograd.primitives.gaussian_filter
+
+    tidy3d.plugins.autograd.types.PaddingType
+    tidy3d.plugins.autograd.types.KernelType
+
+    tidy3d.plugins.autograd.invdes.get_kernel_size_px
+    tidy3d.plugins.autograd.invdes.grey_indicator
+    tidy3d.plugins.autograd.invdes.make_circular_filter
+    tidy3d.plugins.autograd.invdes.make_conic_filter
+    tidy3d.plugins.autograd.invdes.make_curvature_penalty
+    tidy3d.plugins.autograd.invdes.make_erosion_dilation_penalty
+    tidy3d.plugins.autograd.invdes.make_filter
+    tidy3d.plugins.autograd.invdes.make_filter_and_project
+    tidy3d.plugins.autograd.invdes.ramp_projection
+    tidy3d.plugins.autograd.invdes.tanh_projection

docs/api/plugins/index.rst

@@ -9,6 +9,7 @@ Plugins
     polyslab
     smatrix
     resonance
+    autograd
     adjoint
     waveguide
     design
@@ -20,6 +21,7 @@ Plugins
 .. include:: /api/plugins/polyslab.rst
 .. include:: /api/plugins/smatrix.rst
 .. include:: /api/plugins/resonance.rst
+.. include:: /api/plugins/autograd.rst
 .. include:: /api/plugins/adjoint.rst
 .. include:: /api/plugins/waveguide.rst
 .. include:: /api/plugins/design.rst

poetry.lock

@@ -36,6 +36,8 @@ pydantic = "^2.0"
 PyYAML = "*"
 dask = "*"
 toml = "*"
+autograd = "1.6.2"
+
 ### NOT CORE
 scipy = "*"
 boto3 = "^1.28.0"