https://github.com/tensorly/tensorly
Revision 4030d377141e1cd54f37ab0713f41ef72e0735cb authored by Jean KOSSAIFI on 25 October 2016, 14:44:06 UTC, committed by Jean KOSSAIFI on 25 October 2016, 14:44:06 UTC
1 parent a360a82
Raw File
Tip revision: 4030d377141e1cd54f37ab0713f41ef72e0735cb authored by Jean KOSSAIFI on 25 October 2016, 14:44:06 UTC
DOC: improved documentation.
Tip revision: 4030d37
README.md
# TensorLy

Tensor Learning in Python.


## How to install
 
### Easy/fast option: install with pip

Simply run
```bash
pip install -U tensorly
```
That's it!

### Option 2: clone the repository and install

Clone the repository and cd there:
```bash
git clone https://github.com/tensorly/tensorly
cd tensorly
```

Then install the package (here in editable mode with `-e` or equivalently `--editable`):
```bash
pip install -e .
```

Alternatively, you can pip install from the git repository:
```bash
pip install git+https://github.com/tensorly/tensorly
```

## Running the tests
Testing is an essential part of this package and all functions come with uni-tests.

You can run all the tests using the `nose` package:

```bash
nosetests -v --exe --doctest-tests tensorly
```
back to top