Skip to content

Commit bf2c021

Browse files
author
Jessica Shi
committed
add binder file links, installation instructions
1 parent ebe350a commit bf2c021

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

documentation/docs/tutorial.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Tutorial
2+
3+
The linked Jupyter notebooks proivde an interactive introduction to the Python TACO library, including how to initialize tensors, define mode formats, and perform computations. There are three notebooks, which differ mainly in the final extended example: [SpMV](https://mybinder.org/v2/gh/tensor-compiler/taco-jupyter-notebooks/master?filepath=Taco%20Tutorial%20via%20SpMV.ipynb) (useful for scientific computing), [SDDMM](https://mybinder.org/v2/gh/tensor-compiler/taco-jupyter-notebooks/master?filepath=Taco%20Tutorial%20via%20SDDMM.ipynb) (machine learning), and [MTTKRP](https://mybinder.org/v2/gh/tensor-compiler/taco-jupyter-notebooks/master?filepath=Taco%20Tutorial%20via%20MTTKRP.ipynb) (data analytics).
4+
5+
These notebooks are hosted online and __do not require any installation__; i.e., they can be run without having PyTaco, Jupyter, or even Python locally. However, they may take a minute or two to build.
6+
7+
If, on the other hand, you would like to run the notebooks on your computer, please do the following:
8+
9+
1. Install [Python 3](https://www.python.org/downloads/).
10+
2. Intall [Jupyter](https://jupyter.org/install).
11+
3. Install [NumPy and SciPy](https://scipy.org/install.html).
12+
4. Install [PyTaco](https://github.com/tensor-compiler/taco/tree/second-taco). Be sure to clone the `second-taco` branch.
13+
5. Clone the repository with the [tutorials](https://github.com/tensor-compiler/taco-jupyter-notebooks).

0 commit comments

Comments
 (0)