update docstrings in model

pymc-devs · Jan 14, 2017 · 57dbe47 · 57dbe47
1 parent 79ac934
commit 57dbe47
Showing 1 changed file with 14 additions and 3 deletions.
diff --git a/pymc3/model.py b/pymc3/model.py
@@ -469,6 +469,8 @@ def Var(self, name, dist, data=None, total_size=None):
         data : array_like (optional)
            If data is provided, the variable is observed. If None,
            the variable is unobserved.
+        total_size : scalar
+            upscales logp of variable with :math:`coef = total_size/var.shape[0]`
 
         Returns
         -------
@@ -728,7 +730,10 @@ def __init__(self, type=None, owner=None, index=None, name=None,
         owner : theano owner (optional)
         name : str
         distribution : Distribution
-        model : Model"""
+        model : Model
+        total_size : scalar Tensor (optional)
+            needed for upscaling logp
+        """
         if type is None:
             type = distribution.type
         super(FreeRV, self).__init__(type, owner, index, name)
@@ -811,6 +816,8 @@ def __init__(self, type=None, owner=None, index=None, name=None, data=None,
         name : str
         distribution : Distribution
         model : Model
+        total_size : scalar Tensor (optional)
+            needed for upscaling logp
         """
         from .distributions import TensorType
         if type is None:
@@ -859,6 +866,8 @@ def __init__(self, name, data, distribution, model, total_size=None):
         name : str
         distribution : Distribution
         model : Model
+        total_size : scalar Tensor (optional)
+            needed for upscaling logp
         """
         self.name = name
         self.data = {name: as_tensor(data, name, model, distribution)
@@ -924,10 +933,12 @@ def __init__(self, type=None, owner=None, index=None, name=None,
 
         type : theano type (optional)
         owner : theano owner (optional)
-
         name : str
         distribution : Distribution
-        model : Model"""
+        model : Model
+        total_size : scalar Tensor (optional)
+            needed for upscaling logp
+        """
         if type is None:
             type = distribution.type
         super(TransformedRV, self).__init__(type, owner, index, name)