mirror of
https://github.com/pytorch/pytorch.git
synced 2025-10-20 21:14:14 +08:00
89e79f844d
This PR introduces a new documentation page with a list of supported ATen operators by the ONNX converter. When `make html` (or similar) are called, a python script will generate a temporary CSV file inside the doc build folder with a list of operators/opsets currently supported by the PyTorch ONNX exporter. That CSV is used by Sphinx to build a HTML table using the same theme as the rest of the documentation. That page is linked to the existing `onnx.rst`, including its table of contents. @BowenBao @shubhambhokare1 Feel free to add more details on how the script cross reference onnx symbolics and aten operators list from torch jit api` Below is the workflow for the changed pages: The initial torch.onnx page was modified to add a link to the list of supported aten operators  The screen below highlights the text structure changes to the `ATen operartors` section  Finally the new page with the list of supported operators is shown below  Pull Request resolved: https://github.com/pytorch/pytorch/pull/74397 Approved by: https://github.com/garymm, https://github.com/malfet
47 lines
1.7 KiB
Makefile
47 lines
1.7 KiB
Makefile
# Minimal makefile for Sphinx documentation
|
|
#
|
|
|
|
# You can set these variables from the command line.
|
|
SPHINXOPTS ?= -j auto -WT --keep-going
|
|
SPHINXBUILD ?= sphinx-build
|
|
SPHINXPROJ ?= PyTorch
|
|
SOURCEDIR ?= source
|
|
BUILDDIR ?= build
|
|
PYCMD ?= python
|
|
|
|
# Put it first so that "make" without argument is like "make help".
|
|
help:
|
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
figures:
|
|
@$(PYCMD) source/scripts/build_activation_images.py
|
|
@$(PYCMD) source/scripts/build_quantization_configs.py
|
|
|
|
onnx_supported_aten_ops:
|
|
@$(PYCMD) source/scripts/build_onnx_supported_aten_op_csv_table.py
|
|
|
|
docset: html
|
|
doc2dash --name $(SPHINXPROJ) --icon $(SOURCEDIR)/_static/img/pytorch-logo-flame.png --enable-js --online-redirect-url https://pytorch.org/docs/ --force $(BUILDDIR)/html/
|
|
|
|
# Manually fix because Zeal doesn't deal well with `icon.png`-only at 2x resolution.
|
|
cp $(SPHINXPROJ).docset/icon.png $(SPHINXPROJ).docset/icon@2x.png
|
|
convert $(SPHINXPROJ).docset/icon@2x.png -resize 16x16 $(SPHINXPROJ).docset/icon.png
|
|
|
|
html-stable:
|
|
# stable differs from `make html` in two ways:
|
|
# 1) The stable logo is used instead of the unstable logo
|
|
# 2) There will not be a link to the stable docs.
|
|
# See conf.py for more details.
|
|
RELEASE=1 make html
|
|
|
|
.PHONY: help Makefile docset onnx_supported_aten_ops
|
|
|
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
%: Makefile figures onnx_supported_aten_ops
|
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
clean:
|
|
@echo "Removing everything under 'build' and 'source/generated'.."
|
|
@rm -rf $(BUILDDIR)/html/ $(BUILDDIR)/doctrees $(SOURCEDIR)/generated $(BUILDDIR)/auto_gen_aten_op_list.csv
|