Skip to content

Commit ed3412a

Browse files
author
github-actions
committed
Update API docs from pynever
1 parent c7abf33 commit ed3412a

File tree

14 files changed

+56
-30
lines changed

14 files changed

+56
-30
lines changed

‎pynever/API/0_Networks.html

Lines changed: 4 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="Nodes" href="1_Nodes.html" />
23-
<link rel="prev" title="Stand-alone" href="../Guide/usage.html" />
23+
<link rel="prev" title="Command-line interface" href="../Guide/usage.html" />
2424
</head>
2525

2626
<body class="wy-body-for-nav">
@@ -48,7 +48,8 @@
4848
</ul>
4949
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
5050
<ul>
51-
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html">Stand-alone</a></li>
51+
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html">Command-line interface</a></li>
52+
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html#api">API</a></li>
5253
</ul>
5354
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5455
<ul class="current">
@@ -621,7 +622,7 @@
621622
</div>
622623
</div>
623624
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
624-
<a href="../Guide/usage.html" class="btn btn-neutral float-left" title="Stand-alone" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
625+
<a href="../Guide/usage.html" class="btn btn-neutral float-left" title="Command-line interface" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
625626
<a href="1_Nodes.html" class="btn btn-neutral float-right" title="Nodes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
626627
</div>
627628

‎pynever/API/1_Nodes.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@
4848
</ul>
4949
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
5050
<ul>
51-
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html">Stand-alone</a></li>
51+
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html">Command-line interface</a></li>
52+
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html#api">API</a></li>
5253
</ul>
5354
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5455
<ul class="current">

‎pynever/API/2_Training.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@
4848
</ul>
4949
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
5050
<ul>
51-
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html">Stand-alone</a></li>
51+
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html">Command-line interface</a></li>
52+
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html#api">API</a></li>
5253
</ul>
5354
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5455
<ul class="current">

‎pynever/API/3_Conversion.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@
4848
</ul>
4949
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
5050
<ul>
51-
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html">Stand-alone</a></li>
51+
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html">Command-line interface</a></li>
52+
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html#api">API</a></li>
5253
</ul>
5354
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5455
<ul class="current">

‎pynever/API/4_Verification.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@
4747
</ul>
4848
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
4949
<ul>
50-
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html">Stand-alone</a></li>
50+
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html">Command-line interface</a></li>
51+
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html#api">API</a></li>
5152
</ul>
5253
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5354
<ul class="current">

‎pynever/Guide/usage.html

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Stand-alone &mdash; pyNeVer &#39;1.2.6&#39; documentation</title>
9+
<title>Command-line interface &mdash; pyNeVer &#39;1.2.6&#39; documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
1212

@@ -48,11 +48,11 @@
4848
</ul>
4949
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
5050
<ul class="current">
51-
<li class="toctree-l1 current"><a class="current reference internal" href="#">Stand-alone</a><ul>
52-
<li class="toctree-l2"><a class="reference internal" href="#command-line-interface">Command-line interface</a></li>
51+
<li class="toctree-l1 current"><a class="current reference internal" href="#">Command-line interface</a><ul>
5352
<li class="toctree-l2"><a class="reference internal" href="#supported-layers">Supported layers</a></li>
5453
</ul>
5554
</li>
55+
<li class="toctree-l1"><a class="reference internal" href="#api">API</a></li>
5656
</ul>
5757
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5858
<ul>
@@ -77,7 +77,7 @@
7777
<div role="navigation" aria-label="Page navigation">
7878
<ul class="wy-breadcrumbs">
7979
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
80-
<li class="breadcrumb-item active">Stand-alone</li>
80+
<li class="breadcrumb-item active">Command-line interface</li>
8181
<li class="wy-breadcrumbs-aside">
8282
<a href="../_sources/Guide/usage.rst.txt" rel="nofollow"> View page source</a>
8383
</li>
@@ -87,10 +87,8 @@
8787
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
8888
<div itemprop="articleBody">
8989

90-
<section id="stand-alone">
91-
<h1>Stand-alone<a class="headerlink" href="#stand-alone" title="Link to this heading"></a></h1>
92-
<section id="command-line-interface">
93-
<h2>Command-line interface<a class="headerlink" href="#command-line-interface" title="Link to this heading"></a></h2>
90+
<section id="command-line-interface">
91+
<h1>Command-line interface<a class="headerlink" href="#command-line-interface" title="Link to this heading"></a></h1>
9492
<div class="line-block">
9593
<div class="line">To verify <a class="reference external" href="https://www.vnnlib.org">VNN-LIB</a> specifications on ONNX models we provide two scripts:</div>
9694
<div class="line">one for single instances and another one for multiple instances.</div>
@@ -113,7 +111,6 @@ <h2>Command-line interface<a class="headerlink" href="#command-line-interface" t
113111
</ul>
114112
</li>
115113
</ul>
116-
</section>
117114
<section id="supported-layers">
118115
<h2>Supported layers<a class="headerlink" href="#supported-layers" title="Link to this heading"></a></h2>
119116
<p>At present the <strong>pyNeVer</strong> package supports abstraction and verification of fully connected and convolutional
@@ -126,6 +123,16 @@ <h2>Supported layers<a class="headerlink" href="#supported-layers" title="Link t
126123
the specification which can be found in the documentation, or via an SMT-LIB file compliant to the
127124
<a class="reference external" href="https://www.vnnlib.org">VNN-LIB</a> standard.</p>
128125
</section>
126+
</section>
127+
<section id="api">
128+
<h1>API<a class="headerlink" href="#api" title="Link to this heading"></a></h1>
129+
<p>In the <a class="reference external" href="https://github.com/NeVerTools/pyNeVer/tree/main/examples/notebooks">notebooks</a> directory there are four Jupyter Notebooks that illustrate how to use <em>pyNever</em> as an API to design, train and verify neural networks.</p>
130+
<ul class="simple">
131+
<li><p>The <a class="reference external" href="https://github.com/NeVerTools/pyNeVer/blob/main/examples/notebooks/00%20-%20Networks.ipynb">first notebook</a> covers the classes and methods to build networks</p></li>
132+
<li><p>The <a class="reference external" href="https://github.com/NeVerTools/pyNeVer/blob/main/examples/notebooks/01%20-%20Training.ipynb">second notebook</a> covers the learning strategy to train and test a network</p></li>
133+
<li><p>The <a class="reference external" href="https://github.com/NeVerTools/pyNeVer/blob/main/examples/notebooks/02%20-%20Safety%20specifications.ipynb">third notebook</a> explains how to build a safety specification to define a verification problem</p></li>
134+
<li><p>The <a class="reference external" href="https://github.com/NeVerTools/pyNeVer/blob/main/examples/notebooks/03%20-%20Verification.ipynb">fourth notebook</a> explains our verification algorithms and covers how to instantiate and execute verification</p></li>
135+
</ul>
129136
</section>
130137

131138

‎pynever/Setup/install.html

Lines changed: 4 additions & 3 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="Stand-alone" href="../Guide/usage.html" />
22+
<link rel="next" title="Command-line interface" href="../Guide/usage.html" />
2323
<link rel="prev" title="pyNeVer" href="../index.html" />
2424
</head>
2525

@@ -48,7 +48,8 @@
4848
</ul>
4949
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
5050
<ul>
51-
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html">Stand-alone</a></li>
51+
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html">Command-line interface</a></li>
52+
<li class="toctree-l1"><a class="reference internal" href="../Guide/usage.html#api">API</a></li>
5253
</ul>
5354
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5455
<ul>
@@ -115,7 +116,7 @@ <h1>Installation and Setup<a class="headerlink" href="#installation-and-setup" t
115116
</div>
116117
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
117118
<a href="../index.html" class="btn btn-neutral float-left" title="pyNeVer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
118-
<a href="../Guide/usage.html" class="btn btn-neutral float-right" title="Stand-alone" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
119+
<a href="../Guide/usage.html" class="btn btn-neutral float-right" title="Command-line interface" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
119120
</div>
120121

121122
<hr/>

‎pynever/_sources/Guide/usage.rst.txt

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
Stand-alone
2-
============
3-
41
Command-line interface
5-
----------------------
2+
======================
3+
64
| To verify `VNN-LIB <https://www.vnnlib.org>`_ specifications on ONNX models we provide two scripts:
75
| one for single instances and another one for multiple instances.
86
@@ -39,4 +37,14 @@ internal representation used by **pyNeVer**.
3937

4038
The properties for the verification and abstraction of the networks must be defined either in python code following
4139
the specification which can be found in the documentation, or via an SMT-LIB file compliant to the
42-
`VNN-LIB <https://www.vnnlib.org>`_ standard.
40+
`VNN-LIB <https://www.vnnlib.org>`_ standard.
41+
42+
API
43+
============
44+
45+
In the `notebooks <https://github.com/NeVerTools/pyNeVer/tree/main/examples/notebooks>`_ directory there are four Jupyter Notebooks that illustrate how to use *pyNever* as an API to design, train and verify neural networks.
46+
47+
- The `first notebook <https://github.com/NeVerTools/pyNeVer/blob/main/examples/notebooks/00%20-%20Networks.ipynb>`_ covers the classes and methods to build networks
48+
- The `second notebook <https://github.com/NeVerTools/pyNeVer/blob/main/examples/notebooks/01%20-%20Training.ipynb>`_ covers the learning strategy to train and test a network
49+
- The `third notebook <https://github.com/NeVerTools/pyNeVer/blob/main/examples/notebooks/02%20-%20Safety%20specifications.ipynb>`_ explains how to build a safety specification to define a verification problem
50+
- The `fourth notebook <https://github.com/NeVerTools/pyNeVer/blob/main/examples/notebooks/03%20-%20Verification.ipynb>`_ explains our verification algorithms and covers how to instantiate and execute verification

‎pynever/genindex.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@
4545
</ul>
4646
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
4747
<ul>
48-
<li class="toctree-l1"><a class="reference internal" href="Guide/usage.html">Stand-alone</a></li>
48+
<li class="toctree-l1"><a class="reference internal" href="Guide/usage.html">Command-line interface</a></li>
49+
<li class="toctree-l1"><a class="reference internal" href="Guide/usage.html#api">API</a></li>
4950
</ul>
5051
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5152
<ul>

‎pynever/index.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@
4747
</ul>
4848
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
4949
<ul>
50-
<li class="toctree-l1"><a class="reference internal" href="Guide/usage.html">Stand-alone</a></li>
50+
<li class="toctree-l1"><a class="reference internal" href="Guide/usage.html">Command-line interface</a></li>
51+
<li class="toctree-l1"><a class="reference internal" href="Guide/usage.html#api">API</a></li>
5152
</ul>
5253
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5354
<ul>
@@ -100,7 +101,8 @@ <h1>pyNeVer<a class="headerlink" href="#pynever" title="Link to this heading">
100101
<div class="toctree-wrapper compound" id="usage">
101102
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
102103
<ul>
103-
<li class="toctree-l1"><a class="reference internal" href="Guide/usage.html">Stand-alone</a></li>
104+
<li class="toctree-l1"><a class="reference internal" href="Guide/usage.html">Command-line interface</a></li>
105+
<li class="toctree-l1"><a class="reference internal" href="Guide/usage.html#api">API</a></li>
104106
</ul>
105107
</div>
106108
<div class="toctree-wrapper compound" id="api">

‎pynever/objects.inv

7 Bytes
Binary file not shown.

‎pynever/py-modindex.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@
4848
</ul>
4949
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
5050
<ul>
51-
<li class="toctree-l1"><a class="reference internal" href="Guide/usage.html">Stand-alone</a></li>
51+
<li class="toctree-l1"><a class="reference internal" href="Guide/usage.html">Command-line interface</a></li>
52+
<li class="toctree-l1"><a class="reference internal" href="Guide/usage.html#api">API</a></li>
5253
</ul>
5354
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5455
<ul>

‎pynever/search.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@
4848
</ul>
4949
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
5050
<ul>
51-
<li class="toctree-l1"><a class="reference internal" href="Guide/usage.html">Stand-alone</a></li>
51+
<li class="toctree-l1"><a class="reference internal" href="Guide/usage.html">Command-line interface</a></li>
52+
<li class="toctree-l1"><a class="reference internal" href="Guide/usage.html#api">API</a></li>
5253
</ul>
5354
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5455
<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)