diff filetensor.py @ 72:2b6656b2ef52

Changed docs slightly
author Joseph Turian <turian@iro.umontreal.ca>
date Fri, 02 May 2008 18:36:47 -0400
parents 2508c373cf29
children 82ba488b2c24
line wrap: on
line diff
--- a/filetensor.py	Fri May 02 18:19:35 2008 -0400
+++ b/filetensor.py	Fri May 02 18:36:47 2008 -0400
@@ -1,18 +1,18 @@
 """
 Read and write the matrix file format described at
-http://www.cs.nyu.edu/~ylclab/data/norb-v1.0/index.html
+U{http://www.cs.nyu.edu/~ylclab/data/norb-v1.0/index.html}
 
 The format is for dense tensors:
 
-    magic number indicating type and endianness - 4bytes
-    rank of tensor - int32
-    dimensions - int32, int32, int32, ...
-    <data>
+    - magic number indicating type and endianness - 4bytes
+    - rank of tensor - int32
+    - dimensions - int32, int32, int32, ...
+    - <data>
 
 The number of dimensions and rank is slightly tricky: 
-    for scalar: rank=0, dimensions = [1, 1, 1]
-    for vector: rank=1, dimensions = [?, 1, 1]
-    for matrix: rank=2, dimensions = [?, ?, 1]
+    - for scalar: rank=0, dimensions = [1, 1, 1]
+    - for vector: rank=1, dimensions = [?, 1, 1]
+    - for matrix: rank=2, dimensions = [?, ?, 1]
 
 For rank >= 3, the number of dimensions matches the rank exactly.