update docs

agi-brain · Dec 25, 2023 · fcd43b2 · fcd43b2
1 parent a10aa18
commit fcd43b2
Show file tree

Hide file tree

Showing 10 changed files with 34 additions and 34 deletions.
diff --git a/docs/source/documents/api/learners/marl/ippo.rst b/docs/source/documents/api/learners/marl/ippo.rst
@@ -43,7 +43,7 @@ PyTorch
 
   This method performs a single update step for the IPPO learner based on the given experience sample.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -54,7 +54,7 @@ PyTorch
   This method performs a single update step for the IPPO learner with recurrent policies based on the given
     experience sample.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -140,7 +140,7 @@ MindSpore
 
   This method performs a single update step for the IPPO learner based on the given experience sample.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict

diff --git a/docs/source/documents/api/learners/marl/mappo.rst b/docs/source/documents/api/learners/marl/mappo.rst
@@ -43,7 +43,7 @@ PyTorch
 
   Update the parameters of the model.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -53,7 +53,7 @@ PyTorch
 
   Update the parameters of the model with recurrent neural networks.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -96,7 +96,7 @@ TensorFlow
 
   Update the parameters of the model.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict

diff --git a/docs/source/documents/api/learners/marl/matd3.rst b/docs/source/documents/api/learners/marl/matd3.rst
@@ -37,7 +37,7 @@ PyTorch
 
   This method performs a single update step for the MATD3 learner based on the given experience sample.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -74,7 +74,7 @@ TensorFlow
 
   This method performs a single update step for the MATD3 learner based on the given experience sample.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -111,7 +111,7 @@ MindSpore
 
   This method performs a single update step for the MATD3 learner based on the given experience sample.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict

diff --git a/docs/source/documents/api/learners/marl/mfac.rst b/docs/source/documents/api/learners/marl/mfac.rst
@@ -33,7 +33,7 @@ PyTorch
 
   This method processes an experience sample and performs a single update step for the MFAC learner.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -66,7 +66,7 @@ TensorFlow
 
   This method processes an experience sample and performs a single update step for the MFAC learner.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -99,7 +99,7 @@ MindSpore
 
   This method processes an experience sample and performs a single update step for the MFAC learner.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict

diff --git a/docs/source/documents/api/learners/marl/mfq.rst b/docs/source/documents/api/learners/marl/mfq.rst
@@ -44,7 +44,7 @@ PyTorch
 
   This method processes an experience sample and performs a single update step for the MFQ learner.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -89,7 +89,7 @@ TensorFlow
 
   This method processes an experience sample and performs a single update step for the MFQ learner.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -134,7 +134,7 @@ MindSpore
 
   This method processes an experience sample and performs a single update step for the MFQ learner.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict

diff --git a/docs/source/documents/api/learners/marl/qmix.rst b/docs/source/documents/api/learners/marl/qmix.rst
@@ -35,7 +35,7 @@ PyTorch
 
   Update the QMIX learner based on the sampled experience from the experience replay buffer.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -45,7 +45,7 @@ PyTorch
 
   Update the QMIX learner for recurrent architectures based on the sampled experience from the experience replay buffer.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -80,7 +80,7 @@ TensorFlow
 
   Update the QMIX learner based on the sampled experience from the experience replay buffer.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -115,7 +115,7 @@ MindSpore
 
   Update the QMIX learner based on the sampled experience from the experience replay buffer.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict

diff --git a/docs/source/documents/api/learners/marl/qtran.rst b/docs/source/documents/api/learners/marl/qtran.rst
@@ -36,7 +36,7 @@ PyTorch
 
   Update the parameters of the QTRAN learner.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -71,7 +71,7 @@ TensorFlow
 
   Update the parameters of the QTRAN learner.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -106,7 +106,7 @@ MindSpore
 
   Update the parameters of the QTRAN learner.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict

diff --git a/docs/source/documents/api/learners/marl/vdac.rst b/docs/source/documents/api/learners/marl/vdac.rst
@@ -43,7 +43,7 @@ PyTorch
 
   Update the VDAC learner based on the sampled experience from the experience replay buffer.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -53,7 +53,7 @@ PyTorch
 
   Update the VDAC learner for recurrent architectures based on the sampled experience from the experience replay buffer.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -96,7 +96,7 @@ TensorFlow
 
   Update the VDAC learner based on the sampled experience from the experience replay buffer.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -139,7 +139,7 @@ MindSpore
 
   Update the VDAC learner for recurrent architectures based on the sampled experience from the experience replay buffer.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict

diff --git a/docs/source/documents/api/learners/marl/vdn.rst b/docs/source/documents/api/learners/marl/vdn.rst
@@ -35,7 +35,7 @@ PyTorch
 
   Update the parameters of the model.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -45,7 +45,7 @@ PyTorch
 
   Update the parameters of the model with recurrent neural networks.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -80,7 +80,7 @@ TensorFlow
 
   Update the parameters of the model.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -115,7 +115,7 @@ MindSpore
 
   Update the parameters of the model.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict

diff --git a/docs/source/documents/api/learners/marl/wqmix.rst b/docs/source/documents/api/learners/marl/wqmix.rst
@@ -35,7 +35,7 @@ PyTorch
 
   Update the parameters of the model.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -45,7 +45,7 @@ PyTorch
 
   Update the parameters of the model with recurrent neural networks.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -80,7 +80,7 @@ TensorFlow
 
   Update the parameters of the model.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict
@@ -117,7 +117,7 @@ MindSpore
 
   Update the parameters of the model.
 
-  :param sample: A dictionary contianing necessary experience data that is sampled from experience replay buffer.
+  :param sample: A dictionary containing necessary experience data that is sampled from experience replay buffer.
   :type sample: dict
   :return: The information of the training.
   :rtype: dict