opt_einsum.contract

opt_einsum.contract(subscripts, *operands, out=None, dtype=None, order='K', casting='safe', use_blas=True, optimize=True, memory_limit=None, backend='numpy')[source]

Evaluates the Einstein summation convention on the operands. A drop in replacement for NumPy’s einsum function that optimizes the order of contraction to reduce overall scaling at the cost of several intermediate arrays.

Parameters
  • subscripts (str) – Specifies the subscripts for summation.

  • *operands (list of array_like) – These are the arrays for the operation.

  • out (array_like) – A output array in which set the resulting output.

  • dtype (str) – The dtype of the given contraction, see np.einsum.

  • order (str) – The order of the resulting contraction, see np.einsum.

  • casting (str) – The casting procedure for operations of different dtype, see np.einsum.

  • use_blas (bool) – Do you use BLAS for valid operations, may use extra memory for more intermediates.

  • optimize (str, list or bool, optional (default: auto)) – Choose the type of path.

    • if a list is given uses this as the path.

    • 'optimal' An algorithm that explores all possible ways of contracting the listed tensors. Scales factorially with the number of terms in the contraction.

    • 'branch-all' An algorithm like optimal but that restricts itself to searching ‘likely’ paths. Still scales factorially.

    • 'branch-2' An even more restricted version of ‘branch-all’ that only searches the best two options at each step. Scales exponentially with the number of terms in the contraction.

    • 'greedy' An algorithm that heuristically chooses the best pair contraction at each step.

    • 'auto' Choose the best of the above algorithms whilst aiming to keep the path finding time below 1ms.

  • memory_limit ({None, int, ‘max_input’} (default: None)) – Give the upper bound of the largest intermediate tensor contract will build.

    • None or -1 means there is no limit

    • ‘max_input’ means the limit is set as largest input tensor

    • a positive integer is taken as an explicit limit on the number of elements

    The default is None. Note that imposing a limit can make contractions exponentially slower to perform.

  • backend (str, optional (default: numpy)) – Which library to use to perform the required tensordot, transpose and einsum calls. Should match the types of arrays supplied, See contract_expression() for generating expressions which convert numpy arrays to and from the backend library automatically.

Returns

out – The result of the einsum expression.

Return type

array_like

Notes

This function should produce a result identical to that of NumPy’s einsum function. The primary difference is contract will attempt to form intermediates which reduce the overall scaling of the given einsum contraction. By default the worst intermediate formed will be equal to that of the largest input array. For large einsum expressions with many input arrays this can provide arbitrarily large (1000 fold+) speed improvements.

For contractions with just two tensors this function will attempt to use NumPy’s built-in BLAS functionality to ensure that the given operation is preformed optimally. When NumPy is linked to a threaded BLAS, potential speedups are on the order of 20-100 for a six core machine.

Examples

See opt_einsum.contract_path() or numpy.einsum()