Lunar Lander Example (#70)

* Convert lunar lander example to CMA-ME * Add lunar lander to examples list * Add lunar lander to examples tests * Mention example in lunar lander tutorial * Add some notes to sphere example * Watch examples when building docs * Bump fire version in setup.py
icaros-usc · Feb 2, 2021 · e772d30 · e772d30
1 parent dc02349
commit e772d30
Show file tree

Hide file tree

Showing 8 changed files with 431 additions and 17 deletions.
diff --git a/Makefile b/Makefile
@@ -74,14 +74,7 @@ servedocs: ## compile the docs watching for changes
 	DOCS_MODE=dev sphinx-autobuild \
 		--open-browser \
 		--watch ribs/ \
-		docs/ \
-		docs/_build/html
-
-servedocs-ignore-vim: ## compile the docs watching for changes, ignore vim .swp files
-	DOCS_MODE=dev sphinx-autobuild \
-		--open-browser \
-		--watch ribs/ \
-		--ignore *.swp \
+		--watch examples/ \
 		docs/ \
 		docs/_build/html
 

diff --git a/docs/examples.md b/docs/examples.md
@@ -4,6 +4,7 @@
 :hidden:
 
 examples/sphere
+examples/lunar_lander
 ```
 
 Examples assume some experience with pyribs and provide commented source code
@@ -14,6 +15,7 @@ with:
 pip install ribs[examples]
 ```
 
-| Name                   | Archive   | Emitter   | Optimizer                           |
-| ---------------------- | --------- | --------- | ----------------------------------- |
-| {doc}`examples/sphere` | (several) | (several) | {class}`~ribs.optimizers.Optimizer` |
+| Name                         | Archive                             | Emitter                                    | Optimizer                           |
+| ---------------------------- | ----------------------------------- | ------------------------------------------ | ----------------------------------- |
+| {doc}`examples/sphere`       | (several)                           | (several)                                  | {class}`~ribs.optimizers.Optimizer` |
+| {doc}`examples/lunar_lander` | {class}`~ribs.archives.GridArchive` | {class}`~ribs.emitters.ImprovementEmitter` | {class}`~ribs.optimizers.Optimizer` |
diff --git a/docs/examples/lunar_lander.md b/docs/examples/lunar_lander.md
@@ -0,0 +1,11 @@
+# Lunar Lander Relanded: Using Dask to Distribute Evaluations
+
+This example extends the [Lunar Lander tutorial](../tutorials/lunar_lander) by
+using [Dask](https://dask.org) to distribute evaluations and thus speed things
+up. It also adds in more logging capabilities and a CLI.
+
+```{eval-rst}
+.. literalinclude:: ../../examples/lunar_lander.py
+    :language: python
+    :linenos:
+```