improves documentation (#21)

* improves documentation

* fix thumb

* title

Author: xadupre

_doc/examples/plot_export_locate_issue.py

@@ -103,5 +103,8 @@ def forward(self, x: torch.Tensor, ys: list[torch.Tensor]):
 #   File "onnx-diagnostic/_doc/examples/plot_export_locate_issue.py", line 25, in forward
 #       z = x * caty
 
+# %%
 
-doc.plot_legend("was inferred to be a constant", "torch.export.export", "tomato")
+doc.plot_legend(
+    "dynamic dimension\nwas inferred\nto be a constant", "torch.export.export", "tomato"
+)

_doc/examples/plot_export_tiny_llm.py

@@ -174,4 +174,4 @@ def _forward_(*args, _f=None, **kwargs):
 # If you have any error, then look at example
 # :ref:`l-plot-tiny-llm-export-patched`.
 
-doc.plot_legend("Tiny-LLM fails", "torch.export.export", "tomato")
+doc.plot_legend("Tiny-LLM\nforward inputs\nbehind generate", "torch.export.export", "tomato")

_doc/examples/plot_export_with_dynamic_cache.py

@@ -225,4 +225,4 @@ def forward(self, cache, z):
 
 # %%
 
-doc.plot_legend("dynamic shapes", "torch.export.export", "tomato")
+doc.plot_legend("dynamic shapes\nfor cache", "torch.export.export", "tomato")

_doc/examples/plot_export_with_dynamic_shapes_auto.py

@@ -94,4 +94,4 @@ def forward(self, x, y, z):
 
 # %%
 
-doc.plot_legend("dynamic shapes inferred", "torch.export.export", "tomato")
+doc.plot_legend("dynamic shapes\ninferred", "torch.export.export", "tomato")

_doc/examples/plot_failing_model_extract.py

@@ -100,4 +100,4 @@
 
 # %%
 
-doc.plot_legend("Run until it fails", "onnxruntime.InferenceSession", "lightgrey")
+doc.plot_legend("run onnx model\nuntil it fails", "onnxruntime.InferenceSession", "lightgrey")

_doc/examples/plot_failing_onnxruntime_evaluator.py

@@ -106,4 +106,4 @@
 # It is possible to insert prints in the python code to print
 # more information or debug if needed.
 
-doc.plot_legend("onnxruntime running step by step", "OnnxruntimeEvaluator", "lightgrey")
+doc.plot_legend("onnxruntime\nrunning\nstep by step", "OnnxruntimeEvaluator", "lightgrey")

_doc/examples/plot_failing_reference_evaluator.py

@@ -81,4 +81,4 @@
 # It is possible to insert prints in the python code to print
 # more information or debug if needed.
 
-doc.plot_legend("Python Runtime for ONNX", "ExtendedReferenceEvalutor", "lightgrey")
+doc.plot_legend("Python Runtime\nfor ONNX", "ExtendedReferenceEvalutor", "lightgrey")

onnx_diagnostic/doc.py

@@ -8,14 +8,14 @@ def reset_torch_transformers(gallery_conf, fname):
 
 
 def plot_legend(
-    text: str, text_bottom: str = "", color: str = "green", fontsize: int = 35
+    text: str, text_bottom: str = "", color: str = "green", fontsize: int = 15
 ) -> "matplotlib.axes.Axes":  # noqa: F821
     import matplotlib.pyplot as plt
 
-    fig = plt.figure()
+    fig = plt.figure(figsize=(2, 2))
     ax = fig.add_subplot()
     ax.axis([0, 5, 0, 5])
-    ax.text(2.5, 4, "END", fontsize=50, horizontalalignment="center")
+    ax.text(2.5, 4, "END", fontsize=10, horizontalalignment="center")
     ax.text(
         2.5,
         2.5,
@@ -26,7 +26,7 @@ def plot_legend(
         verticalalignment="center",
     )
     if text_bottom:
-        ax.text(4.5, 0.5, text_bottom, fontsize=20, horizontalalignment="right")
+        ax.text(4.5, 0.5, text_bottom, fontsize=7, horizontalalignment="right")
     ax.grid(False)
     ax.set_axis_off()
     return ax