.. cuTensor documentation master file, created by
   sphinx-quickstart on Mon Aug 26 16:03:12 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

###############################################################
cuTENSOR: A High-Performance CUDA Library For Tensor Primitives
###############################################################

Welcome to the cuTENSOR library documentation.

cuTENSOR is a high-performance CUDA library for tensor primitives; its key features are:

  * Extensive mixed-precision support:

    * FP64 inputs with FP32 compute.
    * FP32 inputs with FP16 compute.
    * Complex-times-real operations.
    * Conjugate (without transpose) support.

  * Support for up to 12-dimensional tensors.
  * Arbitrary data layouts.
  * Trivially serializable data structures.
  * Main computational routines:

    * :ref:`Direct (i.e., transpose-free) tensor contractions<contraction-operations-label>`.
    * :ref:`Tensor reductions (including partial reductions)<reduction-operations-label>`.
    * :ref:`Element-wise tensor operations<elementwise-operations-label>`:

       * Support for various activation functions.
       * Arbitrary tensor permutations.
       * Conversion between different data types.

The documentation consists of three main components:

  * A :ref:`user-guide-label` that introduces important basics of cuTENSOR including details on notation and accuracy.
  * A :ref:`getting-started-label` guide that steps through a simple tensor contraction example.
  * An :ref:`api-reference-label` that provides a comprehensive overview of all library routines, constants, and data types.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   user_guide
   getting_started
   api/index

Indices And Tables
==================

* :ref:`genindex`
* :ref:`search`