# HG changeset patch
# User James Bergstra <bergstrj@iro.umontreal.ca>
# Date 1282233635 14400
# Node ID 2668812a6c86a8f1f73d97c7e269ae1546eb38f4
# Parent  492473059b370c57f0a7c7b82b21ec9816a17c41
Added root __init__ docstring

diff -r 492473059b37 -r 2668812a6c86 pylearn/__init__.py
--- 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