Design optimization plugin update

Added Bayesian optimization, genetic algorithms, and particle swarm optimization methods Removed MethodRandom and MethodRandomCustom as had become redundant Expanded DesignSpace with new support methods estimate_cost and summarize Redesigned interface with plugin to make it easier for users to batch simulations for different design search methods Automated batching of simulations when user provides pre and post processing functions Expanded testing for all new features
flexcompute · Sep 17, 2024 · 8e5af1f · 8e5af1f
1 parent d12ace8
commit 8e5af1f
Show file tree

Hide file tree

Showing 14 changed files with 3,748 additions and 1,963 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added convenience functions `from_terminal_positions` and `from_circular_path` to simplify setup of `VoltageIntegralAxisAligned` and `CustomCurrentIntegral2D`, respectively.
 - Added `axial_ratio` to `DirectivityData.axial_ratio` for the `DirectivityMonitor`, defined as the ratio of the major axis to the minor axis of the polarization ellipse. 
 `ComponentModeler.batch_data` convenience property to access the `BatchData` corresponding to the component modeler run.
+- Added optimization methods to the Design plugin. The plugin has been expanded to include Bayesian optimization, genetic algorithms and particle swarm optimization. Explanations of these methods are available in new and updated notebooks.
+- Added new support functions for the Design plugin: automated batching of `Simulation` objects, and summary functions with `DesignSpace.estimate_cost` and `DesignSpace.summarize`.
 
 ### Changed
 - Priority is given to `snapping_points` in `GridSpec` when close to structure boundaries, which reduces the chance of them being skipped.

diff --git a/docs/_static/img/design.png b/docs/_static/img/design.png
diff --git a/docs/api/plugins/design.rst b/docs/api/plugins/design.rst
@@ -11,14 +11,13 @@ Design Space Exploration
    :toctree: ../_autosummary/
    :template: module.rst
 
-   tidy3d.plugins.design.Parameter
    tidy3d.plugins.design.ParameterFloat
    tidy3d.plugins.design.ParameterInt
    tidy3d.plugins.design.ParameterAny
-   tidy3d.plugins.design.Method
    tidy3d.plugins.design.MethodGrid
    tidy3d.plugins.design.MethodMonteCarlo
-   tidy3d.plugins.design.MethodRandomCustom
-   tidy3d.plugins.design.MethodRandom
+   tidy3d.plugins.design.MethodBayOpt
+   tidy3d.plugins.design.MethodGenAlg
+   tidy3d.plugins.design.MethodParticleSwarm
    tidy3d.plugins.design.DesignSpace
-   tidy3d.plugins.design.Results
+   tidy3d.plugins.design.Result
diff --git a/docs/faq b/docs/faq
diff --git a/docs/notebooks b/docs/notebooks
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -73,6 +73,11 @@ jax = { version = "0.4.25", extras = [
   "cpu",
 ], source = "jaxsource", optional = true }
 
+# design
+bayesian-optimization = { version = "*", optional = true }
+pygad = { version = "3.3.1", optional = true }
+pyswarms = { version = "*", optional = true }
+
 # scikit-rf
 scikit-rf = { version = "*", optional = true }
 
@@ -104,13 +109,13 @@ signac = { version = "*", optional = true }
 flax = { version = ">=0.8.2", optional = true }
 sax = { version = "^0.11", optional = true }
 vtk = { version = ">=9.2.6", optional = true }
-pyswarms = { version = "*", optional = true }
 sphinxemoji = { version = "*", optional = true }
 devsim = { version = "*", optional = true }
 cma = { version = "*", optional = true }
 
 [tool.poetry.extras]
 dev = [
+  'bayesian-optimization',
   'bump-my-version',
   "coverage",
   'dill',
@@ -133,6 +138,7 @@ dev = [
   'optax',
   'pre-commit',
   'pydata-sphinx-theme',
+  'pygad',
   'pylint',
   'pyswarms',
   'pytest',
+7 −0		_faqs/Why-does-the-kernel-crash-sometimes-when-using-the-web-based-python-notebook.md
+8 −0		docs/faq/Why-does-the-kernel-crash-sometimes-when-using-the-web-based-python-notebook.md
+2 −2		script/requirements.txt
+1,051 −0		CircularlyPolarizedPatchAntenna.ipynb
+2 −1		docs/case_studies/microwave.rst
+ −		img/circularly_polarized_patch_antenna.png