Rename helpers into helper (#26)

* first version of sbs

* move one function

* fix issues

* refactoring

* fix import

* g

* add phi2

* issues

* import issues

* doc

* final

* doc

* connect

Author: xadupre

CHANGELOGS.rst

@@ -4,6 +4,8 @@ Change Logs
 0.3.0
 +++++
 
+* :pr:`26`: creates a folder ``helpers`` to gather all the functions
+  used in many places
 * :pr:`25`: improve patches for DynamicCache
   (issue with register_pytree_flatten_spec being deprecated)
 * :pr:`24`: dummy inputs for ``text2text-generation``, add new function

README.rst

@@ -98,7 +98,7 @@ Snapshot of usefuls tools
 .. code-block:: python
 
         import onnx
-        from onnx_diagnostic.helpers import onnx_dtype_name
+        from onnx_diagnostic.helpers.onnx_helper import onnx_dtype_name
 
         itype = onnx.TensorProto.BFLOAT16
         print(onnx_dtype_name(itype))

_doc/api/args.rst

@@ -0,0 +1,7 @@
+
+onnx_diagnostic.helpers.args_helper
+===================================
+
+.. automodule:: onnx_diagnostic.helpers.args_helper
+    :members:
+    :no-undoc-members:

_doc/api/cache_helpers.rst

@@ -0,0 +1,7 @@
+
+onnx_diagnostic.helpers.cache_helper
+====================================
+
+.. automodule:: onnx_diagnostic.helpers.cache_helper
+    :members:
+    :no-undoc-members:

_doc/api/helpers.rst

@@ -0,0 +1,7 @@
+
+onnx_diagnostic.helpers.helper
+==============================
+
+.. automodule:: onnx_diagnostic.helpers.helper
+    :no-undoc-members:
+    :exclude-members: max_diff, string_diff, string_sig, string_type

_doc/api/helpers/args_helper.rst

@@ -0,0 +1,26 @@
+
+onnx_diagnostic.helpers
+=======================
+
+.. toctree::
+    :maxdepth: 1
+    :caption: submodules
+
+    args_helper
+    cache_helper
+    helper
+    onnx_helper
+    ort_session
+    torch_test_helper
+
+.. autofunction:: onnx_diagnostic.helpers.max_diff
+
+.. autofunction:: onnx_diagnostic.helpers.string_diff
+
+.. autofunction:: onnx_diagnostic.helpers.string_sig
+
+.. autofunction:: onnx_diagnostic.helpers.string_type
+
+.. automodule:: onnx_diagnostic.helpers
+    :members:
+    :no-undoc-members:

_doc/api/helpers/cache_helper.rst

@@ -0,0 +1,7 @@
+
+onnx_diagnostic.helpers.onnx_helper
+===================================
+
+.. automodule:: onnx_diagnostic.helpers.onnx_helper
+    :members:
+    :no-undoc-members: