Added outline to docs; moved theory text from PyMC2

pymc-devs · Apr 29, 2013 · 72c719e · 72c719e
1 parent ef52277
commit 72c719e
Show file tree

Hide file tree

Showing 18 changed files with 437 additions and 6 deletions.
diff --git a/docs/INSTALL.rst b/docs/INSTALL.rst
diff --git a/docs/README.rst b/docs/README.rst
diff --git a/docs/_images/envelope.pdf b/docs/_images/envelope.pdf
diff --git a/docs/_images/envelope.png b/docs/_images/envelope.png
diff --git a/docs/_images/reject.pdf b/docs/_images/reject.pdf
diff --git a/docs/_images/reject.png b/docs/_images/reject.png
diff --git a/docs/conclusion.rst b/docs/conclusion.rst
diff --git a/docs/distributions.rst b/docs/distributions.rst
diff --git a/docs/extending.rst b/docs/extending.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,14 +3,26 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to PyMC's documentation!
-================================
+PyMC User's Guide
+=================
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
-
+   :numbered:
+
+   README
+   INSTALL
+   tutorial
+   modelbuilding
+   modelfitting
+   modelchecking
+   extending
+   distributions
+   conclusion
+   theory
+   references
 
 
 Indices and tables

diff --git a/docs/modelbuilding.rst b/docs/modelbuilding.rst
diff --git a/docs/modelchecking.rst b/docs/modelchecking.rst
diff --git a/docs/modelfitting.rst b/docs/modelfitting.rst
diff --git a/docs/references.rst b/docs/references.rst
diff --git a/docs/theory.rst b/docs/theory.rst
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
diff --git a/pymc/distributions/meta.py b/pymc/distributions/meta.py
@@ -1,3 +1,4 @@
+# TODO Is this still relevant? If so, please document.
 from dist_math import * 
 
 def Normal_Summary(u, tau): 

diff --git a/pymc/types.py b/pymc/types.py
@@ -1,8 +1,8 @@
 
 bool_types = set(['int8'])
-   
+
 int_types = set(['int8',
-            'int16' ,   
+            'int16' ,
             'int32',
             'int64',
             'uint8',
@@ -16,8 +16,9 @@
 continuous_types = float_types | complex_types
 discrete_types = bool_types | int_types
 
-default_type = {'discrete' :    'int64', 
+default_type = {'discrete' :    'int64',
                 'continuous':   'float64'}
 
 def typefilter(vars, types):
+    # Returns variables of type `types` from `vars`
     return filter(lambda v: v.dtype in types, vars)