Skip to content

Commit 6bde8a7

Browse files
committed
improves documentation
1 parent 503930b commit 6bde8a7

File tree

4 files changed

+15
-2
lines changed

4 files changed

+15
-2
lines changed

README.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,15 @@ or
4444

4545
pip install onnx-diagnostic
4646

47+
**Enlightening Examples**
48+
49+
* `Use DYNAMIC or AUTO when dynamic shapes has constraints
50+
<https://sdpython.github.io/doc/onnx-diagnostic/dev/auto_examples/plot_export_with_dynamic_shapes_auto.html>`_
51+
* `Steel method forward to guess the dynamic shapes
52+
<https://sdpython.github.io/doc/onnx-diagnostic/dev/auto_examples/plot_export_tiny_llm.html>`_
53+
* `Find where a model is failing by running submodels
54+
<https://sdpython.github.io/doc/onnx-diagnostic/dev/auto_examples/plot_failing_model_extract.html>`_
55+
4756
Snapshot of usefuls tools
4857
+++++++++++++++++++++++++
4958

_doc/examples/plot_export_with_dynamic_shapes_auto.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
"""
2+
.. _l-plot-sxport-with-dynamio-shapes-auto:
3+
24
Use DYNAMIC or AUTO when dynamic shapes has constraints
35
=======================================================
46

_doc/examples/plot_failing_model_extract.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
"""
22
.. _l-plot-failing-model-extract:
33
4-
Find where a model failing by running submodels
5-
===============================================
4+
Find where a model is failing by running submodels
5+
==================================================
66
77
Let's assume :epkg:`onnxruntime` crashes without telling why or where.
88
The first thing is do is to locate where. For that, we extract every submodel

_doc/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,9 @@ Source are `sdpython/onnx-diagnostic
4747

4848
**Enlightening Examples**
4949

50+
* :ref:`l-plot-sxport-with-dynamio-shapes-auto`
5051
* :ref:`l-plot-tiny-llm-export`
52+
* :ref:`l-plot-failing-model-extract`
5153

5254
**Some Usefuls Tools**
5355

0 commit comments

Comments
 (0)