Skip to content

Commit 2025501

Browse files
author
github-actions
committed
Update API docs from pynever
1 parent 0968f7c commit 2025501

8 files changed

Lines changed: 175 additions & 23 deletions

File tree

pynever/API/4_Verification.html

Lines changed: 126 additions & 12 deletions
Large diffs are not rendered by default.

pynever/Guide/usage.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ <h2>Supported layers<a class="headerlink" href="#supported-layers" title="Link t
127127
</section>
128128
<section id="api">
129129
<h1>API<a class="headerlink" href="#api" title="Link to this heading"></a></h1>
130-
<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+
<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 <strong>pyNeVer</strong> as an API to design, train and verify neural networks.</p>
131131
<ul class="simple">
132132
<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>
133133
<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>

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,9 @@ Parameters
2323

2424
.. automodule:: pynever.strategies.verification.parameters
2525
:members:
26+
27+
Enumerators
28+
-----------
29+
30+
.. automodule:: pynever.strategies.verification.ssbp.constants
31+
:members:

pynever/_sources/Guide/usage.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ the specification which can be found in the documentation, or via an SMT-LIB fil
4242
API
4343
============
4444

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.
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.
4646

4747
- The `first notebook <https://github.com/NeVerTools/pyNeVer/blob/main/examples/notebooks/00%20-%20Networks.ipynb>`_ covers the classes and methods to build networks
4848
- 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

pynever/genindex.html

Lines changed: 35 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,10 @@ <h2 id="B">B</h2>
168168
<li><a href="API/4_Verification.html#pynever.strategies.verification.parameters.SSBPVerificationParameters.bounds">bounds (pynever.strategies.verification.parameters.SSBPVerificationParameters attribute)</a>
169169
</li>
170170
<li><a href="API/4_Verification.html#pynever.strategies.verification.parameters.SSBPVerificationParameters.bounds_direction">bounds_direction (pynever.strategies.verification.parameters.SSBPVerificationParameters attribute)</a>
171+
</li>
172+
<li><a href="API/4_Verification.html#pynever.strategies.verification.ssbp.constants.BoundsBackend">BoundsBackend (class in pynever.strategies.verification.ssbp.constants)</a>
173+
</li>
174+
<li><a href="API/4_Verification.html#pynever.strategies.verification.ssbp.constants.BoundsDirection">BoundsDirection (class in pynever.strategies.verification.ssbp.constants)</a>
171175
</li>
172176
</ul></td>
173177
</tr></table>
@@ -406,6 +410,8 @@ <h2 id="I">I</h2>
406410
<li><a href="API/0_Networks.html#pynever.networks.NeuralNetwork.input_ids">input_ids (pynever.networks.NeuralNetwork attribute)</a>
407411
</li>
408412
<li><a href="API/4_Verification.html#pynever.strategies.verification.parameters.SSBPVerificationParameters.intersection">intersection (pynever.strategies.verification.parameters.SSBPVerificationParameters attribute)</a>
413+
</li>
414+
<li><a href="API/4_Verification.html#pynever.strategies.verification.ssbp.constants.IntersectionStrategy">IntersectionStrategy (class in pynever.strategies.verification.ssbp.constants)</a>
409415
</li>
410416
<li><a href="API/0_Networks.html#pynever.networks.NeuralNetwork.is_acyclic">is_acyclic() (pynever.networks.NeuralNetwork method)</a>
411417
</li>
@@ -433,18 +439,20 @@ <h2 id="K">K</h2>
433439
<h2 id="L">L</h2>
434440
<table style="width: 100%" class="indextable genindextable"><tr>
435441
<td style="width: 33%; vertical-align: top;"><ul>
442+
<li><a href="API/4_Verification.html#pynever.strategies.verification.ssbp.constants.RefinementTarget.layer_id">layer_id (pynever.strategies.verification.ssbp.constants.RefinementTarget attribute)</a>
443+
</li>
436444
<li><a href="API/0_Networks.html#pynever.networks.NeuralNetwork.layer_precedes">layer_precedes() (pynever.networks.NeuralNetwork method)</a>
437445
</li>
438446
<li><a href="API/1_Nodes.html#pynever.nodes.LayerNode">LayerNode (class in pynever.nodes)</a>
439447
</li>
440448
<li><a href="API/4_Verification.html#pynever.strategies.verification.algorithms.SSLPVerification.layers_bounds">layers_bounds (pynever.strategies.verification.algorithms.SSLPVerification attribute)</a>
441449
</li>
442450
<li><a href="API/0_Networks.html#pynever.networks.NeuralNetwork.layers_iterator">layers_iterator() (pynever.networks.NeuralNetwork method)</a>
443-
</li>
444-
<li><a href="API/1_Nodes.html#pynever.nodes.LeakyReLUNode">LeakyReLUNode (class in pynever.nodes)</a>
445451
</li>
446452
</ul></td>
447453
<td style="width: 33%; vertical-align: top;"><ul>
454+
<li><a href="API/1_Nodes.html#pynever.nodes.LeakyReLUNode">LeakyReLUNode (class in pynever.nodes)</a>
455+
</li>
448456
<li><a href="API/3_Conversion.html#pynever.strategies.conversion.representation.load_network_path">load_network_path() (in module pynever.strategies.conversion.representation)</a>
449457
</li>
450458
<li><a href="API/4_Verification.html#pynever.strategies.verification.properties.LocalRobustnessProperty">LocalRobustnessProperty (class in pynever.strategies.verification.properties)</a>
@@ -488,6 +496,8 @@ <h2 id="M">M</h2>
488496
<li><a href="API/4_Verification.html#module-pynever.strategies.verification.parameters">pynever.strategies.verification.parameters</a>
489497
</li>
490498
<li><a href="API/4_Verification.html#module-pynever.strategies.verification.properties">pynever.strategies.verification.properties</a>
499+
</li>
500+
<li><a href="API/4_Verification.html#module-pynever.strategies.verification.ssbp.constants">pynever.strategies.verification.ssbp.constants</a>
491501
</li>
492502
</ul></li>
493503
</ul></td>
@@ -507,12 +517,16 @@ <h2 id="N">N</h2>
507517
<li><a href="API/4_Verification.html#pynever.strategies.verification.algorithms.SSBPVerification.network">network (pynever.strategies.verification.algorithms.SSBPVerification attribute)</a>
508518
</li>
509519
<li><a href="API/2_Training.html#pynever.strategies.training.PytorchTraining.network_transform">network_transform (pynever.strategies.training.PytorchTraining attribute)</a>
520+
</li>
521+
<li><a href="API/0_Networks.html#pynever.networks.NeuralNetwork">NeuralNetwork (class in pynever.networks)</a>
510522
</li>
511523
</ul></td>
512524
<td style="width: 33%; vertical-align: top;"><ul>
513-
<li><a href="API/0_Networks.html#pynever.networks.NeuralNetwork">NeuralNetwork (class in pynever.networks)</a>
525+
<li><a href="API/4_Verification.html#pynever.strategies.verification.ssbp.constants.RefinementTarget.neuron_idx">neuron_idx (pynever.strategies.verification.ssbp.constants.RefinementTarget attribute)</a>
514526
</li>
515527
<li><a href="API/4_Verification.html#pynever.strategies.verification.parameters.SSLPVerificationParameters.neurons_to_refine">neurons_to_refine (pynever.strategies.verification.parameters.SSLPVerificationParameters attribute)</a>
528+
</li>
529+
<li><a href="API/4_Verification.html#pynever.strategies.verification.ssbp.constants.NeuronSplit">NeuronSplit (class in pynever.strategies.verification.ssbp.constants)</a>
516530
</li>
517531
<li><a href="API/4_Verification.html#pynever.strategies.verification.properties.NeverProperty">NeverProperty (class in pynever.strategies.verification.properties)</a>
518532
</li>
@@ -600,15 +614,15 @@ <h2 id="P">P</h2>
600614
<li><a href="API/3_Conversion.html#module-pynever.strategies.conversion.converters.pytorch">module</a>
601615
</li>
602616
</ul></li>
603-
</ul></td>
604-
<td style="width: 33%; vertical-align: top;"><ul>
605617
<li>
606618
pynever.strategies.conversion.representation
607619

608620
<ul>
609621
<li><a href="API/3_Conversion.html#module-pynever.strategies.conversion.representation">module</a>
610622
</li>
611623
</ul></li>
624+
</ul></td>
625+
<td style="width: 33%; vertical-align: top;"><ul>
612626
<li>
613627
pynever.strategies.training
614628

@@ -635,6 +649,13 @@ <h2 id="P">P</h2>
635649

636650
<ul>
637651
<li><a href="API/4_Verification.html#module-pynever.strategies.verification.properties">module</a>
652+
</li>
653+
</ul></li>
654+
<li>
655+
pynever.strategies.verification.ssbp.constants
656+
657+
<ul>
658+
<li><a href="API/4_Verification.html#module-pynever.strategies.verification.ssbp.constants">module</a>
638659
</li>
639660
</ul></li>
640661
<li><a href="API/3_Conversion.html#pynever.strategies.conversion.representation.PyTorchNetwork.pytorch_network">pytorch_network (pynever.strategies.conversion.representation.PyTorchNetwork attribute)</a>
@@ -655,14 +676,18 @@ <h2 id="P">P</h2>
655676
<h2 id="R">R</h2>
656677
<table style="width: 100%" class="indextable genindextable"><tr>
657678
<td style="width: 33%; vertical-align: top;"><ul>
679+
<li><a href="API/4_Verification.html#pynever.strategies.verification.ssbp.constants.RefinementStrategy">RefinementStrategy (class in pynever.strategies.verification.ssbp.constants)</a>
680+
</li>
681+
<li><a href="API/4_Verification.html#pynever.strategies.verification.ssbp.constants.RefinementTarget">RefinementTarget (class in pynever.strategies.verification.ssbp.constants)</a>
682+
</li>
658683
<li><a href="API/1_Nodes.html#pynever.nodes.ReLUNode">ReLUNode (class in pynever.nodes)</a>
659684
</li>
660685
<li><a href="API/0_Networks.html#pynever.networks.NeuralNetwork.remove_node">remove_node() (pynever.networks.NeuralNetwork method)</a>
661-
</li>
662-
<li><a href="API/1_Nodes.html#pynever.nodes.ReshapeNode">ReshapeNode (class in pynever.nodes)</a>
663686
</li>
664687
</ul></td>
665688
<td style="width: 33%; vertical-align: top;"><ul>
689+
<li><a href="API/1_Nodes.html#pynever.nodes.ReshapeNode">ReshapeNode (class in pynever.nodes)</a>
690+
</li>
666691
<li><a href="API/1_Nodes.html#pynever.nodes.MaxPoolNode.return_indices">return_indices (pynever.nodes.MaxPoolNode attribute)</a>
667692
</li>
668693
<li><a href="API/1_Nodes.html#pynever.nodes.BatchNormNode.running_mean">running_mean (pynever.nodes.BatchNormNode attribute)</a>
@@ -739,9 +764,11 @@ <h2 id="T">T</h2>
739764
<li><a href="API/3_Conversion.html#pynever.strategies.conversion.representation.ConversionStrategy.to_neural_network">(pynever.strategies.conversion.representation.ConversionStrategy method)</a>
740765
</li>
741766
</ul></li>
767+
<li><a href="API/4_Verification.html#pynever.strategies.verification.properties.NeverProperty.to_numeric_bounds">to_numeric_bounds() (pynever.strategies.verification.properties.NeverProperty method)</a>
768+
</li>
742769
</ul></td>
743770
<td style="width: 33%; vertical-align: top;"><ul>
744-
<li><a href="API/4_Verification.html#pynever.strategies.verification.properties.NeverProperty.to_numeric_bounds">to_numeric_bounds() (pynever.strategies.verification.properties.NeverProperty method)</a>
771+
<li><a href="API/4_Verification.html#pynever.strategies.verification.ssbp.constants.RefinementTarget.to_pair">to_pair() (pynever.strategies.verification.ssbp.constants.RefinementTarget method)</a>
745772
</li>
746773
<li><a href="API/4_Verification.html#pynever.strategies.verification.properties.NeverProperty.to_smt_file">to_smt_file() (pynever.strategies.verification.properties.NeverProperty method)</a>
747774
</li>

pynever/objects.inv

92 Bytes
Binary file not shown.

pynever/py-modindex.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,11 @@ <h1>Python Module Index</h1>
146146
<td>&#160;&#160;&#160;
147147
<a href="API/4_Verification.html#module-pynever.strategies.verification.properties"><code class="xref">pynever.strategies.verification.properties</code></a></td><td>
148148
<em></em></td></tr>
149+
<tr class="cg-1">
150+
<td></td>
151+
<td>&#160;&#160;&#160;
152+
<a href="API/4_Verification.html#module-pynever.strategies.verification.ssbp.constants"><code class="xref">pynever.strategies.verification.ssbp.constants</code></a></td><td>
153+
<em></em></td></tr>
149154
</table>
150155

151156

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)