pytorch/torch/ao/nn
Federico Galatolo d118531733 Use \odot everywhere instead of mixing \odot and * for the Hadamard product (#111763)
This pull request addresses an inconsistency in the representation of the Hadamard product across PyTorch documentation. Currently, the notation varies among different modules:

- In `torch.nn.LSTM` documentation the Hadamard product is represented with $\odot$
- In `torch.nn.GRU` documentation the Hadamard product is represented with $*$
- In `torch.nn.LSTMCell` documentation the Hadamard product is represented with $*$
- In `torch.nn.GRUCell` documentation the Hadamard product is represented with $*$
- In `torch.ao.nn.quantized.dynamic.GRU` documentation the Hadamard product is represented with $*$

This PR proposes consistently representing the Hadamard product throughout the documentation to enhance clarity and align with established standards.
The notation $\odot$ will be uniformly adopted, following the convention in the [Deep Learning Book](https://www.deeplearningbook.org/contents/linear_algebra.html).

**Changes Made:**

- Modified `torch.nn.GRU` documentation to represent the Hadamard product with $\odot$
- Modified `torch.nn.LSTMCell` documentation to represent the Hadamard product with $\odot$
- Modified `torch.nn.GRUCell` documentation to represent the Hadamard product with $\odot$
- Modified `torch.ao.nn.quantized.dynamic.GRU` documentation to represent the Hadamard product with $\odot$

Pull Request resolved: https://github.com/pytorch/pytorch/pull/111763
Approved by: https://github.com/albanD
2023-10-22 21:01:35 +00:00
..
intrinsic define public API for torch.nn.utils (#111026) 2023-10-12 23:05:23 +00:00
qat [ao] fixing public v private for torch.ao.nn.X (#87883) 2022-12-15 03:03:07 +00:00
quantizable [ao] fixing multihead attention convert size (#110407) 2023-10-03 08:49:12 +00:00
quantized Use \odot everywhere instead of mixing \odot and * for the Hadamard product (#111763) 2023-10-22 21:01:35 +00:00
sparse [BE] Enable ruff's UP rules and autoformat ao/ (#105430) 2023-07-19 13:44:37 +00:00
__init__.py