Files
pytorch/docs/source/torch.ao.ns._numeric_suite_fx.rst
Vasiliy Kuznetsov 565cf47abf Quantization docs: add pages for Numeric Suite (Eager and FX) (#66380)
Summary:
Pull Request resolved: https://github.com/pytorch/pytorch/pull/66380

Description:
1. creates doc pages for Eager and FX numeric suites
2. adds a link from main quantization doc to (1)
3. formats docblocks in Eager NS to render well
4. adds example code and docblocks to FX numeric suite

Test Plan:
```
cd docs
make html
python -m http.server
// renders well
```

Reviewed By: jerryzh168

Differential Revision: D31543173

Pulled By: vkuzo

fbshipit-source-id: feb291bcbe92747495f45165f738631fa5cbffbd
2021-10-11 18:47:58 -07:00

27 lines
700 B
ReStructuredText

.. _torch_ao_ns_numeric_suite_fx:
torch.ao.ns._numeric_suite_fx
-----------------------------
.. warning ::
This module is an early prototype and is subject to change.
.. currentmodule:: torch.ao.ns._numeric_suite_fx
.. automodule:: torch.ao.ns._numeric_suite_fx
:members:
:member-order: bysource
torch.ao.ns.fx.utils
--------------------------------------
.. warning ::
This module is an early prototype and is subject to change.
.. currentmodule:: torch.ao.ns.fx.utils
.. autofunction:: torch.ao.ns.fx.utils.compute_sqnr(x, y)
.. autofunction:: torch.ao.ns.fx.utils.compute_normalized_l2_error(x, y)
.. autofunction:: torch.ao.ns.fx.utils.compute_cosine_similarity(x, y)