mirror of
https://github.com/zebrajr/pytorch.git
synced 2025-12-07 12:21:27 +01:00
0581331963
Reference pages: - Landing page: https://docs-preview.pytorch.org/88371/onnx_diagnostics.html - Individual rule: https://docs-preview.pytorch.org/88371/generated/onnx_diagnostics_rules/POE0004%3Aoperator-supported-in-newer-opset-version.html An initial PR to setup the document generation for ONNX diagnostics. * Add document page for ONNX diagnostics. * Add document generation for diagnostics rules from `rules.yaml`. * Add dependency on `myst-parser` for markdown to rst parsing. More content to be added. Pull Request resolved: https://github.com/pytorch/pytorch/pull/88371 Approved by: https://github.com/abock, https://github.com/justinchuby, https://github.com/malfet, https://github.com/kit1980
36 lines
982 B
ReStructuredText
36 lines
982 B
ReStructuredText
torch.onnx diagnostics
|
|
======================
|
|
|
|
.. contents:: :local:
|
|
.. automodule:: torch.onnx._internal.diagnostics
|
|
.. currentmodule:: torch.onnx._internal.diagnostics
|
|
|
|
Overview
|
|
--------
|
|
|
|
NOTE: This feature is underdevelopment and is subject to change.
|
|
|
|
The goal is to improve the diagnostics to help users debug and improve their model export to ONNX.
|
|
|
|
- The diagnostics are emitted in machine parsable `Static Analysis Results Interchange Format (SARIF) <https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html>`__.
|
|
- A new clearer, structured way to add new and keep track of diagnostic rules.
|
|
- Serve as foundation for more future improvements consuming the diagnostics.
|
|
|
|
|
|
Diagnostic Rules
|
|
----------------
|
|
|
|
.. toctree::
|
|
:glob:
|
|
|
|
generated/onnx_diagnostics_rules/*
|
|
|
|
API Reference
|
|
-------------
|
|
|
|
.. autoclass:: torch.onnx._internal.diagnostics.ExportDiagnostic
|
|
:members:
|
|
|
|
.. autoclass:: torch.onnx._internal.diagnostics.infra.DiagnosticEngine
|
|
:members:
|