Skip to content

Commit a939e91

Browse files
committed
fix a few things
1 parent 5d1801c commit a939e91

File tree

5 files changed

+46
-9
lines changed

5 files changed

+46
-9
lines changed

README.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,18 +43,26 @@ or
4343

4444
pip install onnx-diagnostic
4545

46-
**Enlightening Examples**
46+
Enlightening Examples
47+
+++++++++++++++++++++
48+
49+
**Torch Export**
4750

4851
* `Use DYNAMIC or AUTO when exporting if dynamic shapes has constraints
4952
<https://sdpython.github.io/doc/onnx-diagnostic/dev/auto_examples/plot_export_with_dynamic_shapes_auto.html>`_
5053
* `Export with DynamicCache and dynamic shapes
5154
<https://sdpython.github.io/doc/onnx-diagnostic/dev/auto_examples/plot_export_with_dynamic_cache.html>`_
5255
* `Steel method forward to guess the dynamic shapes
5356
<https://sdpython.github.io/doc/onnx-diagnostic/dev/auto_examples/plot_export_tiny_llm.html>`_
54-
* `Running ReferenceEvaluator on a failing model
55-
<https://sdpython.github.io/doc/onnx-diagnostic/dev/auto_examples/plot_failing_reference_evaluator.html>`_
57+
58+
**Investigate ONNX models**
59+
5660
* `Find where a model is failing by running submodels
5761
<https://sdpython.github.io/doc/onnx-diagnostic/dev/auto_examples/plot_failing_model_extract.html>`_
62+
* `Intermediate results with (ONNX) ReferenceEvaluator
63+
<https://sdpython.github.io/doc/onnx-diagnostic/dev/auto_examples/plot_failing_reference_evaluator.html>`_
64+
* `Intermediate results with onnxruntime
65+
<https://sdpython.github.io/doc/onnx-diagnostic/dev/auto_examples/plot_failing_onnxruntime_evaluator.html>`_
5866

5967
Snapshot of usefuls tools
6068
+++++++++++++++++++++++++

_doc/_static/custom.css

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,9 @@
55
font-family: monospace;
66
font-size: 0.9em;
77
}
8+
.sphx-glr-script-out {
9+
padding: 10px;
10+
font-family: monospace;
11+
font-size: 0.9em;
12+
overflow-x: auto;
13+
}

_doc/examples/plot_failing_onnxruntime_evaluator.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
"""
22
.. _l-plot-failing-onnxruntime-evaluator:
33
4-
Running OnnxruntimeEvaluator on a failing model
5-
===============================================
4+
Intermediate results with onnxruntime
5+
=====================================
66
77
Example :ref:`l-plot-failing-reference-evaluator` demonstrated
88
how to run a python runtime on a model but it may very slow sometimes

_doc/examples/plot_failing_reference_evaluator.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
"""
22
.. _l-plot-failing-reference-evaluator:
33
4-
Running ReferenceEvaluator on a failing model
5-
=============================================
4+
Intermediate results with (ONNX) ReferenceEvaluator
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 run a python runtime

_doc/index.rst

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,33 @@ Source are `sdpython/onnx-diagnostic
3838
CHANGELOGS
3939
license
4040

41-
**Enlightening Examples**
41+
Getting started
42+
+++++++++++++++
43+
44+
::
45+
46+
git clone https://github.com/sdpython/onnx-diagnostic.git
47+
cd onnx-diagnostic
48+
pip install -e .
49+
50+
or
51+
52+
::
53+
54+
pip install onnx-diagnostic
55+
56+
Enlightening Examples
57+
+++++++++++++++++++++
58+
59+
**Torch Export**
4260

4361
* :ref:`l-plot-export-cond`
4462
* :ref:`l-plot-sxport-with-dynamio-shapes-auto`
4563
* :ref:`l-plot-export-with-dynamic-shape`
4664
* :ref:`l-plot-tiny-llm-export`
65+
66+
**Investigate ONNX models**
67+
4768
* :ref:`l-plot-failing-reference-evaluator`
4869
* :ref:`l-plot-failing-onnxruntime-evaluator`
4970
* :ref:`l-plot-failing-model-extract`
@@ -137,6 +158,8 @@ Size of the package:
137158
gr = df[["dir", "ext", "lines", "chars"]].groupby(["ext", "dir"]).sum()
138159
print(gr)
139160

140-
**Older versions**
161+
Older versions
162+
++++++++++++++
141163

164+
* `0.2.0 <../v0.2.0/index.html>`_
142165
* `0.1.0 <../v0.1.0/index.html>`_

0 commit comments

Comments
 (0)