Merge remote-tracking branch 'qonnxmain/main' into refactor/type-hints

Author: LinusJungemann

.github/workflows/docs.yml

@@ -18,9 +18,9 @@ jobs:
         python-version: ['3.10']
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies

.github/workflows/test.yml

@@ -9,6 +9,8 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.10"
+  apt_packages:
+    - cmake # Install CMake system-wide
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

.readthedocs.yaml

@@ -1 +1,6 @@
-.. _changes:
+========================
+Release Notes
+========================
+
+.. changelog::
+    :pypi: https://pypi.org/project/qonnx/

docs/changelog.rst

@@ -72,13 +72,17 @@
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo',
               'sphinx.ext.autosummary', 'sphinx.ext.coverage', #'sphinx.ext.viewcode',
               'sphinx.ext.doctest', 'sphinx.ext.ifconfig', 'sphinx.ext.mathjax',
-              'sphinx.ext.napoleon']
+              'sphinx.ext.napoleon', 'myst_parser', 'sphinx_github_changelog']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'restructuredtext',
+    '.md': 'markdown',
+}
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
@@ -88,7 +92,7 @@
 
 # General information about the project.
 project = u'qonnx'
-copyright = u'2021-2022 QONNX Contributors'
+copyright = u'2021-2026 QONNX Contributors'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -99,6 +103,8 @@
 # The full version, including alpha/beta/rc tags.
 release = ''  # Is set by calling `setup.py docs`
 
+sphinx_github_changelog_token = os.environ.get("GITHUB_TOKEN")
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 # language = None

docs/conf.py

@@ -2,11 +2,13 @@
 QONNX
 ======
 
-.. note:: **QONNX** is currently under active development. APIs will likely change.
+..
+   note:: **QONNX** is currently under active development. APIs will likely change.
 
-QONNX (Quantized ONNX) introduces three new custom operators -- `Quant <docs/qonnx-custom-ops/quant_op.md>`_, `BipolarQuant <docs/qonnx-custom-ops/bipolar_quant_op.md>`_ and `Trunc <docs/qonnx-custom-ops/trunc_op.md>`_  -- in order to represent arbitrary-precision uniform quantization in ONNX. This enables:
+QONNX (Quantized ONNX) introduces four new custom operators -- `IntQuant`_, `BipolarQuant`_, `FloatQuant`_, and `Trunc`_
+-- in order to represent arbitrary-precision uniform quantization in ONNX. This enables:
 
-* Representation of binary, ternary, 3-bit, 4-bit, 6-bit or any other quantization.
+* Representation of binary, ternary, 3-bit, 4-bit, 6-bit or any other quantization, or quantized floating-point values.
 
 * Quantization is an operator itself, and can be applied to any parameter or layer input.
 
@@ -33,11 +35,13 @@ Quickstart
 Operator definitions
 +++++++++++++++++++++
 
-* `Quant <docs/qonnx-custom-ops/quant_op.md>`_ for 2-to-arbitrary-bit quantization, with scaling and zero-point
+* `IntQuant`_ for 2-to-arbitrary-bit quantization, with scaling and zero-point
 
-* `BipolarQuant <docs/qonnx-custom-ops/bipolar_quant_op.md>`_  for 1-bit (bipolar) quantization, with scaling and zero-point
+* `BipolarQuant`_  for 1-bit (bipolar) quantization, with scaling and zero-point
 
-* `Trunc <docs/qonnx-custom-ops/trunc_op.md>`_ for truncating to a specified number of bits, with scaling and zero-point
+* `FloatQuant`_  for arbitrary-precision-float-quantized values
+
+* `Trunc`_ for truncating to a specified number of bits, with scaling and zero-point
 
 Installation
 +++++++++++++
@@ -90,11 +94,19 @@ QONNX also uses GitHub actions to run the full test suite on PRs.
 
    ONNX-Based Compiler Infrastructure <overview>
    Tutorials <tutorials>
+   qonnx-custom-ops/overview
    API <api/modules>
    License <license>
    Contributors <authors>
+   Read Me <readme_link>
+   Release Notes <changelog>
    Index <genindex>
 
 
 * :ref:`modindex`
 * :ref:`search`
+
+.. _IntQuant: qonnx-custom-ops/intquant_v1.html
+.. _BipolarQuant: qonnx-custom-ops/bipolarquant_v1.html
+.. _FloatQuant: qonnx-custom-ops/floatquant_v1.html
+.. _Trunc: qonnx-custom-ops/trunc_v2.html

docs/index.rst

@@ -4,4 +4,4 @@
 License
 ========
 
-.. include:: ../LICENSE
+.. literalinclude:: ../LICENSE

docs/license.rst

@@ -7,7 +7,7 @@ It is manually updated, since QONNX custom operators are relatively few in numbe
 
 |**Operator**|**Since version**||
 |-|-|-|
-|<a href="bipolarquant_v1.md">BipolarQuant</a>|<a href="bipolarquant_v1.md">1</a>|
-|<a href="floatquant_v1.md">FloatQuant</a>|<a href="floatquant_v1.md">1</a>|
-|<a href="intquant_v1.md">IntQuant</a>|<a href="intquant_v1.md">1</a>|
-|<a href="trunc_v2.md">Trunc</a>|<a href="trunc_v2.md">2</a>, <a href="trunc_v1.md">1</a>|
+|[BipolarQuant](bipolarquant_v1.md) | [1](bipolarquant_v1.md)||
+|[FloatQuant](floatquant_v1.md)      | [1](floatquant_v1.md)||
+|[IntQuant](intquant_v1.md)          | [1](intquant_v1.md)||
+|[Trunc](trunc_v2.md)                | [2](trunc_v2.md), [1](trunc_v1.md)||

docs/qonnx-custom-ops/overview.md

@@ -0,0 +1,3 @@
+```{include} ../README.md
+:relative-docs: docs/
+```