Skip to content

Commit 576e6fc

Browse files
author
github-actions
committed
Update API docs from pynever
1 parent eab7f6f commit 576e6fc

16 files changed

+208
-84
lines changed

‎pynever/API/0_Networks.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4545
<p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
4646
<ul>
47-
<li class="toctree-l1"><a class="reference internal" href="../Setup/setup.html">Installation and Setup</a></li>
47+
<li class="toctree-l1"><a class="reference internal" href="../Setup/install.html">Installation and Setup</a></li>
4848
</ul>
4949
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
5050
<ul>

‎pynever/API/1_Nodes.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4545
<p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
4646
<ul>
47-
<li class="toctree-l1"><a class="reference internal" href="../Setup/setup.html">Installation and Setup</a></li>
47+
<li class="toctree-l1"><a class="reference internal" href="../Setup/install.html">Installation and Setup</a></li>
4848
</ul>
4949
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
5050
<ul>

‎pynever/API/2_Training.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4545
<p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
4646
<ul>
47-
<li class="toctree-l1"><a class="reference internal" href="../Setup/setup.html">Installation and Setup</a></li>
47+
<li class="toctree-l1"><a class="reference internal" href="../Setup/install.html">Installation and Setup</a></li>
4848
</ul>
4949
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
5050
<ul>

‎pynever/API/3_Conversion.html

Lines changed: 77 additions & 17 deletions
Large diffs are not rendered by default.

‎pynever/API/4_Verification.html

Lines changed: 70 additions & 50 deletions
Large diffs are not rendered by default.

‎pynever/Guide/usage.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<link rel="index" title="Index" href="../genindex.html" />
2121
<link rel="search" title="Search" href="../search.html" />
2222
<link rel="next" title="Networks" href="../API/0_Networks.html" />
23-
<link rel="prev" title="Installation and Setup" href="../Setup/setup.html" />
23+
<link rel="prev" title="Installation and Setup" href="../Setup/install.html" />
2424
</head>
2525

2626
<body class="wy-body-for-nav">
@@ -44,7 +44,7 @@
4444
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4545
<p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
4646
<ul>
47-
<li class="toctree-l1"><a class="reference internal" href="../Setup/setup.html">Installation and Setup</a></li>
47+
<li class="toctree-l1"><a class="reference internal" href="../Setup/install.html">Installation and Setup</a></li>
4848
</ul>
4949
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
5050
<ul class="current">
@@ -132,7 +132,7 @@ <h2>Supported layers<a class="headerlink" href="#supported-layers" title="Link t
132132
</div>
133133
</div>
134134
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
135-
<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>
135+
<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>
136136
<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>
137137
</div>
138138

‎pynever/Setup/setup.html renamed to ‎pynever/Setup/install.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
7676
<li class="breadcrumb-item active">Installation and Setup</li>
7777
<li class="wy-breadcrumbs-aside">
78-
<a href="../_sources/Setup/setup.rst.txt" rel="nofollow"> View page source</a>
78+
<a href="../_sources/Setup/install.rst.txt" rel="nofollow"> View page source</a>
7979
</li>
8080
</ul>
8181
<hr/>

‎pynever/_sources/API/3_Conversion.rst.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,20 @@
33
Conversion
44
==========
55

6+
**pyNeVer** provides conversion capabilities to import a NN model in the ONNX and pyTorch file formats,
7+
as well as to export to these formats trained NNs.
8+
9+
Representation
10+
--------------
11+
612
.. automodule:: pynever.strategies.conversion.representation
713
:members:
814

15+
Converters
16+
----------
17+
918
.. automodule:: pynever.strategies.conversion.converters.onnx
1019
:members:
20+
21+
.. automodule:: pynever.strategies.conversion.converters.pytorch
22+
:members:

‎pynever/_sources/API/4_Verification.rst.txt

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,23 @@
33
Verification
44
============
55

6+
To solve a verification problem **pyNeVer** can define the specifications to verify and instantiate
7+
verification algorithms to try and prove that these specifications hold.
8+
9+
Properties
10+
----------
11+
612
.. automodule:: pynever.strategies.verification.properties
713
:members:
814

9-
.. automodule:: pynever.strategies.verification.parameters
10-
:members:
15+
Algorithms
16+
----------
1117

1218
.. automodule:: pynever.strategies.verification.algorithms
1319
:members:
20+
21+
Parameters
22+
----------
23+
24+
.. automodule:: pynever.strategies.verification.parameters
25+
:members:

‎pynever/_sources/Setup/setup.rst.txt renamed to ‎pynever/_sources/Setup/install.rst.txt

File renamed without changes.

‎pynever/genindex.html

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4242
<p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
4343
<ul>
44-
<li class="toctree-l1"><a class="reference internal" href="Setup/setup.html">Installation and Setup</a></li>
44+
<li class="toctree-l1"><a class="reference internal" href="Setup/install.html">Installation and Setup</a></li>
4545
</ul>
4646
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
4747
<ul>
@@ -240,6 +240,8 @@ <h2 id="F">F</h2>
240240
<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>
241241

242242
<ul>
243+
<li><a href="API/3_Conversion.html#pynever.strategies.conversion.converters.pytorch.PyTorchConverter.from_neural_network">(pynever.strategies.conversion.converters.pytorch.PyTorchConverter method)</a>
244+
</li>
243245
<li><a href="API/3_Conversion.html#pynever.strategies.conversion.representation.ConversionStrategy.from_neural_network">(pynever.strategies.conversion.representation.ConversionStrategy method)</a>
244246
</li>
245247
</ul></li>
@@ -460,6 +462,8 @@ <h2 id="M">M</h2>
460462
<li><a href="API/1_Nodes.html#module-pynever.nodes">pynever.nodes</a>
461463
</li>
462464
<li><a href="API/3_Conversion.html#module-pynever.strategies.conversion.converters.onnx">pynever.strategies.conversion.converters.onnx</a>
465+
</li>
466+
<li><a href="API/3_Conversion.html#module-pynever.strategies.conversion.converters.pytorch">pynever.strategies.conversion.converters.pytorch</a>
463467
</li>
464468
<li><a href="API/3_Conversion.html#module-pynever.strategies.conversion.representation">pynever.strategies.conversion.representation</a>
465469
</li>
@@ -571,6 +575,13 @@ <h2 id="P">P</h2>
571575

572576
<ul>
573577
<li><a href="API/3_Conversion.html#module-pynever.strategies.conversion.converters.onnx">module</a>
578+
</li>
579+
</ul></li>
580+
<li>
581+
pynever.strategies.conversion.converters.pytorch
582+
583+
<ul>
584+
<li><a href="API/3_Conversion.html#module-pynever.strategies.conversion.converters.pytorch">module</a>
574585
</li>
575586
</ul></li>
576587
</ul></td>
@@ -613,6 +624,8 @@ <h2 id="P">P</h2>
613624
<li><a href="API/3_Conversion.html#pynever.strategies.conversion.representation.PyTorchNetwork.pytorch_network">pytorch_network (pynever.strategies.conversion.representation.PyTorchNetwork attribute)</a>
614625
</li>
615626
<li><a href="API/2_Training.html#pynever.strategies.training.PytorchTraining.pytorch_training">pytorch_training() (pynever.strategies.training.PytorchTraining method)</a>
627+
</li>
628+
<li><a href="API/3_Conversion.html#pynever.strategies.conversion.converters.pytorch.PyTorchConverter">PyTorchConverter (class in pynever.strategies.conversion.converters.pytorch)</a>
616629
</li>
617630
<li><a href="API/3_Conversion.html#pynever.strategies.conversion.representation.PyTorchNetwork">PyTorchNetwork (class in pynever.strategies.conversion.representation)</a>
618631
</li>
@@ -703,6 +716,8 @@ <h2 id="T">T</h2>
703716
<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>
704717

705718
<ul>
719+
<li><a href="API/3_Conversion.html#pynever.strategies.conversion.converters.pytorch.PyTorchConverter.to_neural_network">(pynever.strategies.conversion.converters.pytorch.PyTorchConverter method)</a>
720+
</li>
706721
<li><a href="API/3_Conversion.html#pynever.strategies.conversion.representation.ConversionStrategy.to_neural_network">(pynever.strategies.conversion.representation.ConversionStrategy method)</a>
707722
</li>
708723
</ul></li>

‎pynever/index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<script src="_static/js/theme.js"></script>
2020
<link rel="index" title="Index" href="genindex.html" />
2121
<link rel="search" title="Search" href="search.html" />
22-
<link rel="next" title="Installation and Setup" href="Setup/setup.html" />
22+
<link rel="next" title="Installation and Setup" href="Setup/install.html" />
2323
</head>
2424

2525
<body class="wy-body-for-nav">
@@ -43,7 +43,7 @@
4343
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4444
<p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
4545
<ul>
46-
<li class="toctree-l1"><a class="reference internal" href="Setup/setup.html">Installation and Setup</a></li>
46+
<li class="toctree-l1"><a class="reference internal" href="Setup/install.html">Installation and Setup</a></li>
4747
</ul>
4848
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
4949
<ul>
@@ -94,7 +94,7 @@ <h1>pyNeVer<a class="headerlink" href="#pynever" title="Link to this heading">
9494
<div class="toctree-wrapper compound" id="setup">
9595
<p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
9696
<ul>
97-
<li class="toctree-l1"><a class="reference internal" href="Setup/setup.html">Installation and Setup</a></li>
97+
<li class="toctree-l1"><a class="reference internal" href="Setup/install.html">Installation and Setup</a></li>
9898
</ul>
9999
</div>
100100
<div class="toctree-wrapper compound" id="usage">
@@ -119,7 +119,7 @@ <h1>pyNeVer<a class="headerlink" href="#pynever" title="Link to this heading">
119119
</div>
120120
</div>
121121
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
122-
<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>
122+
<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>
123123
</div>
124124

125125
<hr/>

‎pynever/objects.inv

22 Bytes
Binary file not shown.

‎pynever/py-modindex.html

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4545
<p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
4646
<ul>
47-
<li class="toctree-l1"><a class="reference internal" href="Setup/setup.html">Installation and Setup</a></li>
47+
<li class="toctree-l1"><a class="reference internal" href="Setup/install.html">Installation and Setup</a></li>
4848
</ul>
4949
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
5050
<ul>
@@ -114,6 +114,11 @@ <h1>Python Module Index</h1>
114114
<td>&#160;&#160;&#160;
115115
<a href="API/3_Conversion.html#module-pynever.strategies.conversion.converters.onnx"><code class="xref">pynever.strategies.conversion.converters.onnx</code></a></td><td>
116116
<em></em></td></tr>
117+
<tr class="cg-1">
118+
<td></td>
119+
<td>&#160;&#160;&#160;
120+
<a href="API/3_Conversion.html#module-pynever.strategies.conversion.converters.pytorch"><code class="xref">pynever.strategies.conversion.converters.pytorch</code></a></td><td>
121+
<em></em></td></tr>
117122
<tr class="cg-1">
118123
<td></td>
119124
<td>&#160;&#160;&#160;

‎pynever/search.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4545
<p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
4646
<ul>
47-
<li class="toctree-l1"><a class="reference internal" href="Setup/setup.html">Installation and Setup</a></li>
47+
<li class="toctree-l1"><a class="reference internal" href="Setup/install.html">Installation and Setup</a></li>
4848
</ul>
4949
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
5050
<ul>

‎pynever/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)