Update API docs from pynever

github-actions · github-actions · commit 576e6fc73426 · 2025-06-04T08:27:36.000Z
diff --git a/pynever/API/0_Networks.html b/pynever/API/0_Networks.html
@@ -44,7 +44,7 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../Setup/setup.html">Installation and Setup</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../Setup/install.html">Installation and Setup</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Usage</span></p>
 <ul>
diff --git a/pynever/API/1_Nodes.html b/pynever/API/1_Nodes.html
@@ -44,7 +44,7 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../Setup/setup.html">Installation and Setup</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../Setup/install.html">Installation and Setup</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Usage</span></p>
 <ul>
diff --git a/pynever/API/2_Training.html b/pynever/API/2_Training.html
@@ -44,7 +44,7 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../Setup/setup.html">Installation and Setup</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../Setup/install.html">Installation and Setup</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Usage</span></p>
 <ul>
diff --git a/pynever/API/3_Conversion.html b/pynever/API/3_Conversion.html
diff --git a/pynever/API/4_Verification.html b/pynever/API/4_Verification.html
diff --git a/pynever/Guide/usage.html b/pynever/Guide/usage.html
@@ -20,7 +20,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Networks" href="../API/0_Networks.html" />
-    <link rel="prev" title="Installation and Setup" href="../Setup/setup.html" /> 
+    <link rel="prev" title="Installation and Setup" href="../Setup/install.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -44,7 +44,7 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../Setup/setup.html">Installation and Setup</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../Setup/install.html">Installation and Setup</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Usage</span></p>
 <ul class="current">
@@ -132,7 +132,7 @@ <h2>Supported layers<a class="headerlink" href="#supported-layers" title="Link t
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="../Setup/setup.html" class="btn btn-neutral float-left" title="Installation and Setup" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="../Setup/install.html" class="btn btn-neutral float-left" title="Installation and Setup" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="../API/0_Networks.html" class="btn btn-neutral float-right" title="Networks" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
diff --git a/pynever/Setup/install.html b/pynever/Setup/install.html
@@ -75,7 +75,7 @@
       <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
       <li class="breadcrumb-item active">Installation and Setup</li>
       <li class="wy-breadcrumbs-aside">
-            <a href="../_sources/Setup/setup.rst.txt" rel="nofollow"> View page source</a>
+            <a href="../_sources/Setup/install.rst.txt" rel="nofollow"> View page source</a>
       </li>
   </ul>
   <hr/>
diff --git a/pynever/_sources/API/3_Conversion.rst.txt b/pynever/_sources/API/3_Conversion.rst.txt
@@ -3,8 +3,20 @@
 Conversion
 ==========
 
+**pyNeVer** provides conversion capabilities to import a NN model in the ONNX and pyTorch file formats,
+as well as to export to these formats trained NNs.
+
+Representation
+--------------
+
 .. automodule:: pynever.strategies.conversion.representation
    :members:
 
+Converters
+----------
+
 .. automodule:: pynever.strategies.conversion.converters.onnx
    :members:
+
+.. automodule:: pynever.strategies.conversion.converters.pytorch
+   :members:
diff --git a/pynever/_sources/API/4_Verification.rst.txt b/pynever/_sources/API/4_Verification.rst.txt
@@ -3,11 +3,23 @@
 Verification
 ============
 
+To solve a verification problem **pyNeVer** can define the specifications to verify and instantiate
+verification algorithms to try and prove that these specifications hold.
+
+Properties
+----------
+
 .. automodule:: pynever.strategies.verification.properties
    :members:
 
-.. automodule:: pynever.strategies.verification.parameters
-   :members:
+Algorithms
+----------
 
 .. automodule:: pynever.strategies.verification.algorithms
    :members:
+
+Parameters
+----------
+
+.. automodule:: pynever.strategies.verification.parameters
+   :members:
diff --git a/pynever/_sources/Setup/install.rst.txt b/pynever/_sources/Setup/install.rst.txt
diff --git a/pynever/genindex.html b/pynever/genindex.html
@@ -41,7 +41,7 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="Setup/setup.html">Installation and Setup</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Setup/install.html">Installation and Setup</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Usage</span></p>
 <ul>
@@ -240,6 +240,8 @@ <h2 id="F">F</h2>
       <li><a href="API/3_Conversion.html#pynever.strategies.conversion.converters.onnx.ONNXConverter.from_neural_network">from_neural_network() (pynever.strategies.conversion.converters.onnx.ONNXConverter method)</a>
 
       <ul>
+        <li><a href="API/3_Conversion.html#pynever.strategies.conversion.converters.pytorch.PyTorchConverter.from_neural_network">(pynever.strategies.conversion.converters.pytorch.PyTorchConverter method)</a>
+</li>
         <li><a href="API/3_Conversion.html#pynever.strategies.conversion.representation.ConversionStrategy.from_neural_network">(pynever.strategies.conversion.representation.ConversionStrategy method)</a>
 </li>
       </ul></li>
@@ -460,6 +462,8 @@ <h2 id="M">M</h2>
         <li><a href="API/1_Nodes.html#module-pynever.nodes">pynever.nodes</a>
 </li>
         <li><a href="API/3_Conversion.html#module-pynever.strategies.conversion.converters.onnx">pynever.strategies.conversion.converters.onnx</a>
+</li>
+        <li><a href="API/3_Conversion.html#module-pynever.strategies.conversion.converters.pytorch">pynever.strategies.conversion.converters.pytorch</a>
 </li>
         <li><a href="API/3_Conversion.html#module-pynever.strategies.conversion.representation">pynever.strategies.conversion.representation</a>
 </li>
@@ -571,6 +575,13 @@ <h2 id="P">P</h2>
 
       <ul>
         <li><a href="API/3_Conversion.html#module-pynever.strategies.conversion.converters.onnx">module</a>
+</li>
+      </ul></li>
+      <li>
+    pynever.strategies.conversion.converters.pytorch
+
+      <ul>
+        <li><a href="API/3_Conversion.html#module-pynever.strategies.conversion.converters.pytorch">module</a>
 </li>
       </ul></li>
   </ul></td>
@@ -613,6 +624,8 @@ <h2 id="P">P</h2>
       <li><a href="API/3_Conversion.html#pynever.strategies.conversion.representation.PyTorchNetwork.pytorch_network">pytorch_network (pynever.strategies.conversion.representation.PyTorchNetwork attribute)</a>
 </li>
       <li><a href="API/2_Training.html#pynever.strategies.training.PytorchTraining.pytorch_training">pytorch_training() (pynever.strategies.training.PytorchTraining method)</a>
+</li>
+      <li><a href="API/3_Conversion.html#pynever.strategies.conversion.converters.pytorch.PyTorchConverter">PyTorchConverter (class in pynever.strategies.conversion.converters.pytorch)</a>
 </li>
       <li><a href="API/3_Conversion.html#pynever.strategies.conversion.representation.PyTorchNetwork">PyTorchNetwork (class in pynever.strategies.conversion.representation)</a>
 </li>
@@ -703,6 +716,8 @@ <h2 id="T">T</h2>
       <li><a href="API/3_Conversion.html#pynever.strategies.conversion.converters.onnx.ONNXConverter.to_neural_network">to_neural_network() (pynever.strategies.conversion.converters.onnx.ONNXConverter method)</a>
 
       <ul>
+        <li><a href="API/3_Conversion.html#pynever.strategies.conversion.converters.pytorch.PyTorchConverter.to_neural_network">(pynever.strategies.conversion.converters.pytorch.PyTorchConverter method)</a>
+</li>
         <li><a href="API/3_Conversion.html#pynever.strategies.conversion.representation.ConversionStrategy.to_neural_network">(pynever.strategies.conversion.representation.ConversionStrategy method)</a>
 </li>
       </ul></li>
diff --git a/pynever/index.html b/pynever/index.html
@@ -19,7 +19,7 @@
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Installation and Setup" href="Setup/setup.html" /> 
+    <link rel="next" title="Installation and Setup" href="Setup/install.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -43,7 +43,7 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="Setup/setup.html">Installation and Setup</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Setup/install.html">Installation and Setup</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Usage</span></p>
 <ul>
@@ -94,7 +94,7 @@ <h1>pyNeVer<a class="headerlink" href="#pynever" title="Link to this heading">
 <div class="toctree-wrapper compound" id="setup">
 <p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="Setup/setup.html">Installation and Setup</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Setup/install.html">Installation and Setup</a></li>
 </ul>
 </div>
 <div class="toctree-wrapper compound" id="usage">
@@ -119,7 +119,7 @@ <h1>pyNeVer<a class="headerlink" href="#pynever" title="Link to this heading">
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="Setup/setup.html" class="btn btn-neutral float-right" title="Installation and Setup" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="Setup/install.html" class="btn btn-neutral float-right" title="Installation and Setup" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>
diff --git a/pynever/objects.inv b/pynever/objects.inv
diff --git a/pynever/py-modindex.html b/pynever/py-modindex.html
@@ -44,7 +44,7 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="Setup/setup.html">Installation and Setup</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Setup/install.html">Installation and Setup</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Usage</span></p>
 <ul>
@@ -114,6 +114,11 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="API/3_Conversion.html#module-pynever.strategies.conversion.converters.onnx"><code class="xref">pynever.strategies.conversion.converters.onnx</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="API/3_Conversion.html#module-pynever.strategies.conversion.converters.pytorch"><code class="xref">pynever.strategies.conversion.converters.pytorch</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
diff --git a/pynever/search.html b/pynever/search.html
@@ -44,7 +44,7 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="Setup/setup.html">Installation and Setup</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Setup/install.html">Installation and Setup</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Usage</span></p>
 <ul>
diff --git a/pynever/searchindex.js b/pynever/searchindex.js
