changeset 956:2668812a6c86

Added root __init__ docstring
author James Bergstra <bergstrj@iro.umontreal.ca>
date Thu, 19 Aug 2010 12:00:35 -0400
parents 492473059b37
children 5cbd235f8fb8
files pylearn/__init__.py
diffstat 1 files changed, 19 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/pylearn/__init__.py	Thu Aug 19 12:00:18 2010 -0400
+++ b/pylearn/__init__.py	Thu Aug 19 12:00:35 2010 -0400
@@ -1,3 +1,22 @@
+"""Pylearn - Theano-based machine learning library
+
+Modules:
+
+ - `io` - Python parsers/writers for various file formats
+
+ - `datasets` - loading of various datasets (depends on `io`)
+
+ - `preprocessing` - pre-processing and feature extraction for various modalities
+
+ - `external` - code for interacting with other packages
+
+ - `gd` - gradient-based optimization (for stochastic online learning)
+
+ - `sampling` - theano expressions and tools for sampling from energy functions
+
+ - `algorithms` - implementations of [published] models typically with a script that reproduces a published result.  (depends on all)
+
+"""
 #import exceptions