https://github.com/tensorly/tensorly
Tip revision: bdc11743a1e8d283d4b9b12cc1b17930c12b0518 authored by Jean Kossaifi on 07 December 2020, 19:05:18 UTC
DOC: fix class documentation
DOC: fix class documentation
Tip revision: bdc1174
index.rst
:no-toc:
.. tensorly documentation
.. only:: latex
TensorLy: Tensor Learning in Python
====================================
.. toctree::
:maxdepth: 1
:hidden:
installation
user_guide/index
modules/api
auto_examples/index
development_guide/index
Notebooks <https://github.com/JeanKossaifi/tensorly-notebooks>
about
.. only:: html
.. raw:: html
<section class="hero is-bold">
<div class="hero-body home-hero">
<div class="container has-text-centered">
<h1 class="title is-1">
TensorLy: Simple and Fast Tensor Learning in Python
</h1>
<hr/>
<div class="columns is-vcentered">
<div class="column is-8 ">
<figure class="image">
<img src="_static/TensorLy-pyramid.png" class="logo" alt="TensorLy logo">
<a href="http://tensorly.org/dev/index.html" title="TensorLy" style="position: absolute; left: 2.29%; top: 4.32%; width: 25.96%; height: 24.52%; z-index: 2;"></a><a href="http://tensorly.org/dev/modules/api.html#module-tensorly.decomposition" title="Tensor Decomposition" style="position: absolute; left: 27.25%; top: 43.16%; width: 21.94%; height: 3.86%; z-index: 2;"></a><a href="http://tensorly.org/dev/modules/api.html#module-tensorly.regression" title="Tensor Regression" style="position: absolute; left: 33.89%; top: 48.03%; width: 11.28%; height: 3.86%; z-index: 2;"></a><a href="http://tensorly.org/dev/modules/api.html#module-tensorly.tenalg" title="Tensor Algebra" style="position: absolute; left: 26.07%; top: 65.75%; width: 23.95%; height: 5.69%; z-index: 2;"></a><a href="http://tensorly.org/dev/modules/api.html#tensorly-manipulating-the-backend-with-a-unified-interface" title="TensorLy Backend" style="position: absolute; left: 26.02%; top: 83.47%; width: 24.06%; height: 5.42%; z-index: 2;"></a><a href="http://tensorly.org/dev/modules/generated/tensorly.decomposition.CP.html#tensorly.decomposition.CP" title="CP" style="position: absolute; left: 79.4%; top: 29.11%; width: 3.74%; height: 3.95%; z-index: 2;"></a><a href="http://tensorly.org/dev/modules/generated/tensorly.decomposition.Tucker.html#tensorly.decomposition.Tucker" title="Tucker" style="position: absolute; left: 83.53%; top: 29.2%; width: 7.2%; height: 3.86%; z-index: 2;"></a><a href="http://tensorly.org/dev/modules/generated/tensorly.decomposition.TensorTrain.html#tensorly.decomposition.TensorTrain" title="Tensor Train" style="position: absolute; left: 91.51%; top: 29.2%; width: 7.31%; height: 4.32%; z-index: 2;"></a><a href="http://tensorly.org/dev/modules/api.html#module-tensorly.regression" title="Tensor Regression" style="position: absolute; left: 79.45%; top: 33.98%; width: 18.48%; height: 3.58%; z-index: 2;"></a><a href="http://tensorly.org/dev/modules/generated/tensorly.base.fold.html" title="Tensor Folding" style="position: absolute; left: 80.51%; top: 52.62%; width: 7.98%; height: 4.13%; z-index: 2;"></a><a href="http://tensorly.org/dev/modules/generated/tensorly.base.unfold.html" title="Tensor Unfolding" style="position: absolute; left: 88.78%; top: 52.53%; width: 9.1%; height: 4.13%; z-index: 2;"></a><a href="http://tensorly.org/dev/modules/generated/tensorly.tenalg.mode_dot.html" title="n-mode Product" style="position: absolute; left: 79.96%; top: 57.58%; width: 15.41%; height: 3.21%; z-index: 2;"></a> </figure>
</div>
<div class="column is-4">
<div class="container tensorly-functionalities-container">
<div class="content tensorly-functionalities">
<ul>
<li> Tested and Optimised </li>
<li> Pure Python </li>
<li> Flexible Backends for: <ul>
<li> <a target="_blank" href="https://numpy.org/"> NumPy </a> </li>
<li> <a target="_blank" href="https://pytorch.org/"> PyTorch </a> </li>
<li> <a target="_blank" href="https://www.tensorflow.org/"> TensorFlow </a> </li>
<li> <a target="_blank" href="https://jax.readthedocs.io/en/latest/"> JAX </a> </li>
<li> <a target="_blank" href="https://mxnet.apache.org/versions/1.7.0/"> Apache MXNet </a> </li>
<li> <a target="_blank" href="https://cupy.dev/"> CuPy </a> </li>
</ul>
</li>
<li> Thorough Documentation </li>
<li> Minimal Dependencies </li>
</ul>
</div>
</div>
<p class="has-text-centered">
<a class="button is-large is-dark is-primary" href="installation.html">
Get started
</a>
</p>
</div>
</div>
</div>
<div class="hero-discover container has-text-centered">
<p class="title">Discover TensorLy's Functionalities!</p>
</div>
<div class="container has-text-centered">
<br/>
<a href="#functionalities">
<span>
<i class="fa fa-chevron-down" aria-hidden="true"></i>
<span>
</a>
</div>
</div>
<div class="section home-main">
<a name="functionalities" style="visibility: hidden;"></a>
<div class="container">
<div class="tile is-ancestor">
<div class="tile is-parent">
<a class="tile is-child box" href="installation.html">
<p class="title">Install TensorLy</p>
<p class="subtitle">Installation Instructions </p>
</a>
</div>
<div class="tile is-parent">
<a class="tile is-child box" href="user_guide/index.html">
<p class="title">User Guide</p>
<p class="subtitle">A Friendly Guide to Tensor Learning</p>
</a>
</div>
<div class="tile is-parent">
<a class="tile is-child box" href= "auto_examples/index.html">
<p class="title">Examples</p>
<p class="subtitle">See Usage Examples With Code</p>
</a>
</div>
</div>
<div class="tile is-ancestor">
<div class="tile is-parent">
<a class="tile is-child box" href="modules/api.html">
<p class="title">
<i class="fa fa-book" aria-hidden="true"></i>
API
</p>
<p class="subtitle">Functions and Classes Documentation</p>
</a>
</div>
<div class="tile is-parent">
<a class="tile is-child box" href="about.html">
<p class="title">About Us</p>
<p class="subtitle">About the Developers</p>
</a>
</div>
<div class="tile is-parent">
<a class="tile is-child box" href= "https://github.com/tensorly/tensorly">
<p class="title">
<span class="icon"><i class="fa fa-github"></i></span>
<span>Contribute</span>
</p>
<p class="subtitle">Source Code on Github</p>
</a>
</div>
</div>
</div>
</div>
</section>
.. raw:: html
<div class="container has-text-centered">
<script type="text/javascript">
function disp(s) {
var win;
var doc;
win = window.open("", "WINDOWID");
doc = win.document;
doc.open("text/plain");
doc.write("<pre>" + s + "</pre>");
doc.close();
}
</script>
<script>
function toggle_modal(id){
var modal = document.getElementById(id);
modal.classList.toggle('is-active');
};
</script>
<div class="modal" id="tensorly_bibtex">
<div class="modal-background" onclick="javascrip:toggle_modal('tensorly_bibtex');"></div>
<div class="modal-content">
<div class="box">
<div class="content has-text-left">
<code class="language-latex" data-lang="latex">
@article{tensorly, <br/>
author = {Jean Kossaifi and Yannis Panagakis and Anima Anandkumar and Maja Pantic}, <br/>
title = {TensorLy: Tensor Learning in Python}, <br/>
journal = {Journal of Machine Learning Research (JMLR)} <br/>
volume = {20},<br/>
number = {26},<br/>
year = {2019}, <br/>
} <br/>
</code>
</div>
</div>
</div>
<button class="modal-close" onclick="javascrip:toggle_modal('tensorly_bibtex');"></button>
</div>
<br/> <br/>
<div class="card has-text-left">
<header class="card-header">
<nav class="level">
<div class="level-left">
<div class="level-item card-header-title">
If you use TensorLy, please cite:
</div></div>
<div class="level-right card-header-icon"> <div class="level-item">
<a onclick="javascrip:toggle_modal('tensorly_bibtex');" >
<span class="icon" style="margin-right:0.7em">
[bibtex]
</span>
</a>
</div></div>
</nav>
</header>
<div class="card-content">
Jean Kossaifi, Yannis Panagakis, Anima Anandkumar and Maja Pantic, <strong> TensorLy: Tensor Learning in Python</strong>,
Journal of Machine Learning Research, Year: 2019, Volume: 20, Issue: 26, Pages: 1−6.
<br/><a href="http://jmlr.org/papers/v20/18-277.html">http://jmlr.org/papers/v20/18-277.html</a>.
</div>
</div>
</div>
