updated docs with more information about deterministic models

facebookresearch · Mar 8, 2021 · 3a30b1e · 3a30b1e
1 parent 52c1da4
commit 3a30b1e
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 6 deletions.
diff --git a/docs/models.rst b/docs/models.rst
@@ -1,5 +1,15 @@
 Models module
 =============
+This module provides implementations of common model architectures used in model-based RL,
+including probabilistic and deterministic ensembles. All models in the library derive from
+class :class:`mbrl.models.Model`. We provide a generic ensemble implementation,
+:class:`mbrl.models.BasicEnsemble`, that can be used to produce epistemic uncertainty estimates
+for any subclass of `Model`. For efficiency considerations, some specific model implementations
+also provide their own ensemble implementations, without having to rely on BasicEnsemble.
+One such model is :class:`mbrl.models.GaussianMLP`, which can be used as a single model or as
+an ensemble. Additionally, it can be used as a deterministic model
+trained with MSE loss, or a parameterized Gaussian with mean and log variance outputs, trained
+with negative log-likelihood.
 
 .. automodule:: mbrl.models
     :members: