Merge pull request #50 from facebookresearch/small-config-change

Config changes, README for doxygen docs, hosted docs

Author: prigoyal

docs/README.md

@@ -1,4 +1,4 @@
-# Writing documentation for Tensor Comprehensions
+# Generating Sphinx documentation for Tensor Comprehensions
 
 1. First install sphinx
 
@@ -24,3 +24,34 @@ cd docs && make html
 5. Now you can see the generated html `index.html` under `build/html/`
 
 6. Send PR
+
+# Generating Doxygen docs for Tensor Comprehensions
+
+1. Install Doxygen
+
+Run the command
+
+```Shell
+$ apt-get install doxygen
+```
+
+2. Edit the `docs/doxygen/index.md` file for making changes to the main page for
+doxygen docs.
+
+3. Edit the `docs/doxygen/Doxyfile` file for making change to what code should be
+documented, excluded etc.
+
+4. Now, test the docs locally. Run the following commands:
+
+```Shell
+$ cd $HOME/TensorComprehensions && mkdir -p $HOME/TensorComprehensions-docs/api
+$ doxygen docs/doxygen/Doxyfile
+```
+
+This will generate an `html` folder which will contain all the html files for the
+documentation. Please `DO NOT` edit the `html` folder manually. Rather make changes
+as suggested in Step 2, 3 and re-generate docs.
+
+5. Check the HTML docs look fine to you.
+
+6. Send a PR

docs/doxygen/Doxyfile

@@ -51,7 +51,7 @@ PROJECT_BRIEF          =
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           = docs/doxygen/tc-logo-small.png
+PROJECT_LOGO           = docs/doxygen/img/tc-logo-small.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -811,7 +811,7 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                = 
+EXCLUDE                =
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -1068,7 +1068,7 @@ GENERATE_HTML          = YES
 # The default directory is: html.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_OUTPUT            = html
+HTML_OUTPUT            = ../TensorComprehensions-docs/html/api/
 
 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
 # generated HTML page (for example: .htm, .php, .asp).
@@ -1416,7 +1416,7 @@ DISABLE_INDEX          = NO
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-GENERATE_TREEVIEW      = NO
+GENERATE_TREEVIEW      = YES
 
 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
 # doxygen will group on one line in the generated HTML documentation.

docs/doxygen/tc-logo-small.png renamed to docs/doxygen/img/tc-logo-small.png

@@ -15,19 +15,19 @@ Tensor Comprehension Notation
 -----------------------------
 TC borrow three ideas from Einstein notation that make expressions concise:
 
-1. loop index variables are defined implicitly by using them in an expression and their range is aggressively inferred based on what they index,
-2. indices that appear on the right of an expression but not on the left are assumed to be reduction dimensions,
-3. the evaluation order of points in the iteration space does not affect the output.
+1. Loop index variables are defined implicitly by using them in an expression and their range is aggressively inferred based on what they index.
+2. Indices that appear on the right of an expression but not on the left are assumed to be reduction dimensions.
+3. The evaluation order of points in the iteration space does not affect the output.
 
 Let's start with a simple example is a matrix vector product:
 
-    def mv(float(R,C) A, float(C) x) -> (o) {
-      o(i) +=! A(i,j) * b(j)
+    def mv(float(R,C) A, float(C) B) -> (o) {
+      o(i) +=! A(i,j) * B(j)
     }
 
 `A` and `x` are input tensors. `o` is an output tensor.
-The statement `o(i) += A(i,j)*b(j)` introduces two index variables `i` and `j`.
-Their range is inferred by their use indexing `A` and `b`. `i = [0,R)`, `j = [0,C)`.
+The statement `o(i) += A(i,j) * b(j)` introduces two index variables `i` and `j`.
+Their range is inferred by their use indexing `A` and `B`. `i = [0,R)`, `j = [0,C)`.
 Because `j` only appears on the right side,
 stores into `o` will reduce over `j` with the reduction specified for the loop.
 Reductions can occur across multiple variables, but they all share the same kind of associative reduction (e.g. +=)
@@ -36,7 +36,7 @@ to maintain invariant (3). `mv` computes the same thing as this C++ loop:
     for(int i = 0; i < R; i++) {
       o(i) = 0.0f;
       for(int j = 0; j < C; j++) {
-        o(i) += A(i,j) * b(j);
+        o(i) += A(i,j) * B(j);
       }
     }
 
@@ -47,30 +47,33 @@ Examples of TC
 
 We provide a few basic examples.
 
-Simple matrix-vector:
+**Simple matrix-vector**:
 
-    def mv(float(R,C) A, float(C) x) -> (o) {
-      o(i) += A(i,j) * b(j)
+    def mv(float(R,C) A, float(C) B) -> (o) {
+      o(i) += A(i,j) * B(j)
     }
 
-Simple matrix-multiply (note the layout for B is transposed and matches the
+**Simple matrix-multiply:**
+
+Note the layout for B is transposed and matches the
 traditional layout of the weight matrix in a linear layer):
 
     def mm(float(X,Y) A, float(Y,Z) B) -> (R) {
       R(i,j) += A(i,j) * B(j,k)
     }
 
-Simple 2-D convolution (no stride, no padding):
+**Simple 2-D convolution (no stride, no padding):**
 
     def conv(float(B,IP,H,W) input, float(OP,IP,KH,KW) weight) -> (output) {
       output(b, op, h, w) += input(b, ip, h + kh, w + kw) * weight(op, ip, kh, kw)
     }
 
-Simple 2D max pooling (note the similarity with a convolution with a
+**Simple 2D max pooling:**
+
+Note the similarity with a convolution with a
 "select"-style kernel):
 
     def maxpool2x2(float(B,C,H,W) input) -> (output) {
       output(b,c,i,j) max= input(b,c,2*i + kw, 2*j + kh)
         where kw = [0, 2[, kh = [0, 2[
     }
-

docs/doxygen/index.md

@@ -105,7 +105,7 @@ Set environment variables:
     $ export LD_LIBRARY_PATH=/usr/local/cuda/lib64:/usr/local/cuda/targets/x86_64-linux/lib/stubs/:$LD_LIBRARY_PATH
     $ export PATH=/usr/local/bin:/usr/local/cuda/bin:$PATH
 
-.. _conda_dep_install_tc:
+.. _conda_dep_install_tc_caffe2:
 
 Step 5: Install TC with Caffe2
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^