diff options
author | Matthias Bussonnier <bussonniermatthias@gmail.com> | 2021-01-27 17:43:33 -0800 |
---|---|---|
committer | Matthias Bussonnier <bussonniermatthias@gmail.com> | 2021-01-27 17:52:30 -0800 |
commit | f305d5962614e98eea5d10a2140eee7e16ab9aca (patch) | |
tree | 2c86ecbfe79e29188fc040e19d762e16b1d08005 /numpy/core/einsumfunc.py | |
parent | 11a8f8d7dba0eb7b0bc31f74bec659e2e497abfd (diff) | |
download | numpy-f305d5962614e98eea5d10a2140eee7e16ab9aca.tar.gz |
DOC: Misc numpydoc format fixes
Via prototype docstring autoreformatter; and cherry-picked to mostly
include spacing issues around colons in parameters and see also.
When no space is present numpydoc tend to miss-parse those sections
A couple of typos are fixed as well.
Diffstat (limited to 'numpy/core/einsumfunc.py')
-rw-r--r-- | numpy/core/einsumfunc.py | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/numpy/core/einsumfunc.py b/numpy/core/einsumfunc.py index e0942beca..18157641a 100644 --- a/numpy/core/einsumfunc.py +++ b/numpy/core/einsumfunc.py @@ -327,7 +327,7 @@ def _greedy_path(input_sets, output_set, idx_dict, memory_limit): Set that represents the rhs side of the overall einsum subscript idx_dict : dictionary Dictionary of index sizes - memory_limit_limit : int + memory_limit : int The maximum number of elements in a temporary array Returns @@ -1061,14 +1061,12 @@ def einsum(*operands, out=None, optimize=False, **kwargs): See Also -------- einsum_path, dot, inner, outer, tensordot, linalg.multi_dot - - einops: + einops : similar verbose interface is provided by `einops <https://github.com/arogozhnikov/einops>`_ package to cover additional operations: transpose, reshape/flatten, repeat/tile, squeeze/unsqueeze and reductions. - - opt_einsum: + opt_einsum : `opt_einsum <https://optimized-einsum.readthedocs.io/en/stable/>`_ optimizes contraction order for einsum-like expressions in backend-agnostic manner. |