pytorch / pytorch

Tensors and Dynamic neural networks in Python with strong GPU acceleration
https://pytorch.org
Other
82.02k stars 21.99k forks source link

`torch.einsum` docs don't mention that `opt_einsum` must be installed separately #127109

Open bmillwood opened 3 months ago

bmillwood commented 3 months ago

πŸ“š The doc issue

Neither the torch.einsum doc page nor the torch.backends.opt_einsum page mentions the necessary / sufficient conditions to make the backend available.

Before I looked into it, I imagined that any of these things could be true (now I think they are all false):

Suggest a potential alternative/fix

Mention that:

Minor bonus: the note in the einsum docs mentions torch.backends.opt_einsum, would be convenient if that note were a link

cc @svekars @brycebortree

soulitzer commented 3 months ago

cc @janeyx99