doc: update examples and add tfds example

EMI-Group · Apr 24, 2024 · 240d50d · 240d50d
1 parent 31f58b6
commit 240d50d
Show file tree

Hide file tree

Showing 6 changed files with 48,554 additions and 8 deletions.
diff --git a/docs/source/example/atari_pong.ipynb b/docs/source/example/atari_pong.ipynb
@@ -19,7 +19,7 @@
    "outputs": [],
    "source": [
     "from evox import workflows, algorithms, problems\n",
-    "from evox.monitors import StdSOMonitor\n",
+    "from evox.monitors import EvalMonitor\n",
     "from evox.utils import TreeAndVector\n",
     "import jax\n",
     "import jax.numpy as jnp\n",
@@ -78,7 +78,7 @@
     "model = PongPolicy()\n",
     "params = model.init(model_key, jnp.zeros((210, 160, 3)))\n",
     "adapter = TreeAndVector(params)\n",
-    "monitor = StdSOMonitor()\n",
+    "monitor = EvalMonitor()\n",
     "problem = problems.neuroevolution.Gym(\n",
     "    env_name=\"ALE/Pong-v5\",\n",
     "    env_options={\"full_action_space\": False},\n",

diff --git a/docs/source/example/custom_algorithm_and_problem.ipynb b/docs/source/example/custom_algorithm_and_problem.ipynb
@@ -123,7 +123,7 @@
     "    flip_prob=0.1,\n",
     ")\n",
     "problem = OneMax()\n",
-    "monitor = monitors.StdSOMonitor()"
+    "monitor = monitors.EvalMonitor()"
    ]
   },
   {
@@ -137,7 +137,6 @@
     "    algorithm,\n",
     "    problem,\n",
     "    monitors=[monitor],\n",
-    "    record_pop=True,\n",
     "    opt_direction=\"max\",\n",
     ")"
    ]

diff --git a/docs/source/example/gym_classic_control.ipynb b/docs/source/example/gym_classic_control.ipynb
@@ -30,7 +30,7 @@
    "outputs": [],
    "source": [
     "from evox import workflows, algorithms, problems\n",
-    "from evox.monitors import StdSOMonitor\n",
+    "from evox.monitors import EvalMonitor\n",
     "from evox.utils import TreeAndVector\n",
     "import jax\n",
     "import jax.numpy as jnp\n",
@@ -97,7 +97,7 @@
     "model = ClassicPolicy()\n",
     "params = model.init(model_key, jnp.zeros(policy_params[gym_name][1]))\n",
     "adapter = TreeAndVector(params)\n",
-    "monitor = StdSOMonitor()\n",
+    "monitor = EvalMonitor()\n",
     "problem = problems.neuroevolution.Gym(\n",
     "    env_name=gym_name,\n",
     "    policy=jax.jit(model.apply),\n",

diff --git a/docs/source/example/index.md b/docs/source/example/index.md
@@ -7,4 +7,5 @@ pso_ackley
 custom_algorithm_and_problem
 gym_classic_control
 atari_pong
+tfds
 ```
diff --git a/docs/source/example/pso_ackley.ipynb b/docs/source/example/pso_ackley.ipynb
@@ -46,7 +46,7 @@
     "    pop_size=100,\n",
     ")\n",
     "problem = problems.numerical.Ackley()\n",
-    "monitor = monitors.StdSOMonitor()"
+    "monitor = monitors.EvalMonitor()"
    ]
   },
   {
@@ -60,7 +60,6 @@
     "    algorithm,\n",
     "    problem,\n",
     "    monitors=[monitor],\n",
-    "    record_pop=True,\n",
     ")"
    ]
   },

diff --git a/docs/source/example/tfds.ipynb b/docs/source/example/tfds.ipynb