# HG changeset patch
# User James Bergstra <bergstrj@iro.umontreal.ca>
# Date 1232076095 18000
# Node ID e4a92dce13fe6c17a5cb9b846fdc21485d58f7e9
# Parent  20953adfdef81bf27c06e7b744ea41ce738a1f60
added comments to amat

diff -r 20953adfdef8 -r e4a92dce13fe pylearn/io/amat.py
--- a/pylearn/io/amat.py	Thu Jan 15 22:21:04 2009 -0500
+++ b/pylearn/io/amat.py	Thu Jan 15 22:21:35 2009 -0500
@@ -1,4 +1,22 @@
-"""load PLearn AMat files"""
+"""load PLearn AMat files
+
+
+An AMat file is an ascii format for dense matrices.
+
+The format is not precisely defined, so I'll describe here a single recipe for making a valid
+file.
+
+.. code-block:: text
+    
+    #size: <rows> <cols>
+    #sizes: <input cols> <target cols> <weight cols> <extra cols 0> <extra cols 1> <extra cols ...>
+    number number number ....
+    number number number ....
+
+
+Tabs and spaces are both valid delimiters.  Newlines separate consecutive rows.
+
+"""
 
 import sys, numpy, array