update docs

adaptive-intelligent-robotics · Sep 5, 2024 · 0508d7c · 0508d7c
1 parent 78d8249
commit 0508d7c
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/docs/api_documentation/core/dcrlme.md b/docs/api_documentation/core/dcrlme.md
@@ -0,0 +1,5 @@
+# Descriptor-Conditioned Reinforcement Learning MAP-Elites (DCRL-ME)
+
+To create an instance of DCRL-ME, one need to use an instance of [MAP-Elites](map_elites.md) with the `DCRLMEEmitter`, detailed below.
+
+::: qdax.core.emitters.dcrl_me_emitter.DCRLMEEmitter
diff --git a/docs/api_documentation/core/map_elites.md b/docs/api_documentation/core/map_elites.md
@@ -2,7 +2,7 @@
 
 This class implement the base mechanism of MAP-Elites. It must be used with an emitter. To get the usual MAP-Elites algorithm, one must use the [mixing emitter](emitters.md#qdax.core.emitters.standard_emitters.MixingEmitter).
 
-The MAP-Elites class can be used with other emitters to create variants, like [PGAME](pgame.md), [CMA-MEGA](cma_mega.md) and [OMG-MEGA](omg_mega.md).
+The MAP-Elites class can be used with other emitters to create variants, like [PGAME](pgame.md), [DCRL-ME](dcrlme.md) [CMA-MEGA](cma_mega.md) and [OMG-MEGA](omg_mega.md).
 
 ::: qdax.core.map_elites.MAPElites
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -136,6 +136,7 @@ nav:
       - Core algorithms:
         - MAP Elites: api_documentation/core/map_elites.md
         - PGAME: api_documentation/core/pgame.md
+        - DCRLME: api_documentation/core/dcrlme.md
         - QDPG: api_documentation/core/qdpg.md
         - CMA ME: api_documentation/core/cmame.md
         - OMG MEGA: api_documentation/core/omg_mega.md