Skip to content

Commit c8d6f7f

Browse files
author
sdemarch
committed
Update API docs from pynever
1 parent bd9850e commit c8d6f7f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+9279
-0
lines changed

‎pynever/API/0_Networks.html

Lines changed: 644 additions & 0 deletions
Large diffs are not rendered by default.

‎pynever/API/1_Nodes.html

Lines changed: 1374 additions & 0 deletions
Large diffs are not rendered by default.

‎pynever/API/2_Training.html

Lines changed: 513 additions & 0 deletions
Large diffs are not rendered by default.

‎pynever/API/3_Conversion.html

Lines changed: 292 additions & 0 deletions
Large diffs are not rendered by default.

‎pynever/Setup/setup.html

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
2+
3+
<!DOCTYPE html>
4+
<html class="writer-html5" lang="en" data-content_root="../">
5+
<head>
6+
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
7+
8+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9+
<title>Setup &mdash; pyNeVer 1.1.4 documentation</title>
10+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
11+
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
12+
13+
14+
<script src="../_static/jquery.js?v=5d32c60e"></script>
15+
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16+
<script src="../_static/documentation_options.js?v=00f267c6"></script>
17+
<script src="../_static/doctools.js?v=9bcbadda"></script>
18+
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
19+
<script src="../_static/js/theme.js"></script>
20+
<link rel="index" title="Index" href="../genindex.html" />
21+
<link rel="search" title="Search" href="../search.html" />
22+
<link rel="next" title="Networks" href="../API/0_Networks.html" />
23+
<link rel="prev" title="pyNeVer" href="../index.html" />
24+
</head>
25+
26+
<body class="wy-body-for-nav">
27+
<div class="wy-grid-for-nav">
28+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
29+
<div class="wy-side-scroll">
30+
<div class="wy-side-nav-search" >
31+
32+
33+
34+
<a href="../index.html" class="icon icon-home">
35+
pyNeVer
36+
</a>
37+
<div role="search">
38+
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
39+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
40+
<input type="hidden" name="check_keywords" value="yes" />
41+
<input type="hidden" name="area" value="default" />
42+
</form>
43+
</div>
44+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
45+
<p class="caption" role="heading"><span class="caption-text">Setup</span></p>
46+
<ul class="current">
47+
<li class="toctree-l1 current"><a class="current reference internal" href="#">Setup</a></li>
48+
</ul>
49+
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
50+
<ul>
51+
<li class="toctree-l1"><a class="reference internal" href="../API/0_Networks.html">Networks</a></li>
52+
<li class="toctree-l1"><a class="reference internal" href="../API/1_Nodes.html">Nodes</a></li>
53+
<li class="toctree-l1"><a class="reference internal" href="../API/2_Training.html">Training</a></li>
54+
<li class="toctree-l1"><a class="reference internal" href="../API/3_Conversion.html">Conversion</a></li>
55+
</ul>
56+
57+
</div>
58+
</div>
59+
</nav>
60+
61+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
62+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
63+
<a href="../index.html">pyNeVer</a>
64+
</nav>
65+
66+
<div class="wy-nav-content">
67+
<div class="rst-content">
68+
<div role="navigation" aria-label="Page navigation">
69+
<ul class="wy-breadcrumbs">
70+
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
71+
<li class="breadcrumb-item active">Setup</li>
72+
<li class="wy-breadcrumbs-aside">
73+
<a href="../_sources/Setup/setup.rst.txt" rel="nofollow"> View page source</a>
74+
</li>
75+
</ul>
76+
<hr/>
77+
</div>
78+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
79+
<div itemprop="articleBody">
80+
81+
<section id="setup">
82+
<h1>Setup<a class="headerlink" href="#setup" title="Link to this heading"></a></h1>
83+
<p>This Section is about the setup of pyNeVer</p>
84+
</section>
85+
86+
87+
</div>
88+
</div>
89+
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
90+
<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>
91+
<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>
92+
</div>
93+
94+
<hr/>
95+
96+
<div role="contentinfo">
97+
<p>&#169; Copyright 2025, NeverTools.</p>
98+
</div>
99+
100+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
101+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
102+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
103+
104+
105+
</footer>
106+
</div>
107+
</div>
108+
</section>
109+
</div>
110+
<script>
111+
jQuery(function () {
112+
SphinxRtdTheme.Navigation.enable(true);
113+
});
114+
</script>
115+
116+
</body>
117+
</html>

‎pynever/_sources/API/0_Networks.rst.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Networks
2+
=========
3+
4+
.. automodule:: pynever.networks
5+
:members:

‎pynever/_sources/API/1_Nodes.rst.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Nodes
2+
=========
3+
4+
.. automodule:: pynever.nodes
5+
:members:

‎pynever/_sources/API/2_Training.rst.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Training
2+
=========
3+
4+
.. automodule:: pynever.strategies.training
5+
:members:

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Conversion
2+
==========
3+
4+
.. automodule:: pynever.strategies.conversion.representation
5+
:members:
6+
7+
.. automodule:: pynever.strategies.conversion.converters.onnx
8+
:members:

‎pynever/_sources/Setup/setup.rst.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Setup
2+
======
3+
4+
This Section is about the setup of pyNeVer

‎pynever/_sources/index.rst.txt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
pyNeVer
2+
=========
3+
4+
Neural networks Verifier NeVer2 is a tool for the design, training and verification of neural networks.
5+
It supports feed-forward and residual neural networks with ReLU and activation functions.
6+
pyNeVer is the corresponding python package providing all the main capabilities of NeVer2
7+
and can be easily installed using pip.
8+
9+
This documentation explains how to setup pyNeVer, shows examples using pyNeVer, provides API documentation,
10+
and explains how to contribute to pyNeVer.
11+
12+
NB: this documentation is in progress!
13+
14+
.. _Setup:
15+
.. toctree::
16+
:maxdepth: 1
17+
:glob:
18+
:caption: Setup
19+
20+
Setup/*
21+
22+
.. _API:
23+
.. toctree::
24+
:maxdepth: 1
25+
:glob:
26+
:caption: API Documentation
27+
28+
API/*

‎pynever/_static/_sphinx_javascript_frameworks_compat.js

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
/* Compatability shim for jQuery and underscores.js.
2+
*
3+
* Copyright Sphinx contributors
4+
* Released under the two clause BSD licence
5+
*/
6+
7+
/**
8+
* small helper function to urldecode strings
9+
*
10+
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
11+
*/
12+
jQuery.urldecode = function(x) {
13+
if (!x) {
14+
return x
15+
}
16+
return decodeURIComponent(x.replace(/\+/g, ' '));
17+
};
18+
19+
/**
20+
* small helper function to urlencode strings
21+
*/
22+
jQuery.urlencode = encodeURIComponent;
23+
24+
/**
25+
* This function returns the parsed url parameters of the
26+
* current request. Multiple values per key are supported,
27+
* it will always return arrays of strings for the value parts.
28+
*/
29+
jQuery.getQueryParameters = function(s) {
30+
if (typeof s === 'undefined')
31+
s = document.location.search;
32+
var parts = s.substr(s.indexOf('?') + 1).split('&');
33+
var result = {};
34+
for (var i = 0; i < parts.length; i++) {
35+
var tmp = parts[i].split('=', 2);
36+
var key = jQuery.urldecode(tmp[0]);
37+
var value = jQuery.urldecode(tmp[1]);
38+
if (key in result)
39+
result[key].push(value);
40+
else
41+
result[key] = [value];
42+
}
43+
return result;
44+
};
45+
46+
/**
47+
* highlight a given string on a jquery object by wrapping it in
48+
* span elements with the given class name.
49+
*/
50+
jQuery.fn.highlightText = function(text, className) {
51+
function highlight(node, addItems) {
52+
if (node.nodeType === 3) {
53+
var val = node.nodeValue;
54+
var pos = val.toLowerCase().indexOf(text);
55+
if (pos >= 0 &&
56+
!jQuery(node.parentNode).hasClass(className) &&
57+
!jQuery(node.parentNode).hasClass("nohighlight")) {
58+
var span;
59+
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
60+
if (isInSVG) {
61+
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
62+
} else {
63+
span = document.createElement("span");
64+
span.className = className;
65+
}
66+
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
67+
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
68+
document.createTextNode(val.substr(pos + text.length)),
69+
node.nextSibling));
70+
node.nodeValue = val.substr(0, pos);
71+
if (isInSVG) {
72+
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
73+
var bbox = node.parentElement.getBBox();
74+
rect.x.baseVal.value = bbox.x;
75+
rect.y.baseVal.value = bbox.y;
76+
rect.width.baseVal.value = bbox.width;
77+
rect.height.baseVal.value = bbox.height;
78+
rect.setAttribute('class', className);
79+
addItems.push({
80+
"parent": node.parentNode,
81+
"target": rect});
82+
}
83+
}
84+
}
85+
else if (!jQuery(node).is("button, select, textarea")) {
86+
jQuery.each(node.childNodes, function() {
87+
highlight(this, addItems);
88+
});
89+
}
90+
}
91+
var addItems = [];
92+
var result = this.each(function() {
93+
highlight(this, addItems);
94+
});
95+
for (var i = 0; i < addItems.length; ++i) {
96+
jQuery(addItems[i].parent).before(addItems[i].target);
97+
}
98+
return result;
99+
};
100+
101+
/*
102+
* backward compatibility for jQuery.browser
103+
* This will be supported until firefox bug is fixed.
104+
*/
105+
if (!jQuery.browser) {
106+
jQuery.uaMatch = function(ua) {
107+
ua = ua.toLowerCase();
108+
109+
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
110+
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
111+
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
112+
/(msie) ([\w.]+)/.exec(ua) ||
113+
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
114+
[];
115+
116+
return {
117+
browser: match[ 1 ] || "",
118+
version: match[ 2 ] || "0"
119+
};
120+
};
121+
jQuery.browser = {};
122+
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
123+
}

0 commit comments

Comments
 (0)