Skip to content

Commit a176942

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

File tree

18 files changed

+4271
-182
lines changed

18 files changed

+4271
-182
lines changed

‎pynever/API/0_Networks.html

Lines changed: 51 additions & 49 deletions
Large diffs are not rendered by default.

‎pynever/API/1_Nodes.html

Lines changed: 111 additions & 91 deletions
Large diffs are not rendered by default.

‎pynever/API/2_Training.html

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

‎pynever/API/3_Conversion.html

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

‎pynever/Setup/setup.html

Lines changed: 28 additions & 6 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>Setup &mdash; pyNeVer 1.1.4 documentation</title>
9+
<title>Installation and Setup &mdash; pyNeVer 1.1.4 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

@@ -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">Setup</span></p>
4646
<ul class="current">
47-
<li class="toctree-l1 current"><a class="current reference internal" href="#">Setup</a></li>
47+
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation and Setup</a></li>
4848
</ul>
4949
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
5050
<ul>
@@ -68,7 +68,7 @@
6868
<div role="navigation" aria-label="Page navigation">
6969
<ul class="wy-breadcrumbs">
7070
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
71-
<li class="breadcrumb-item active">Setup</li>
71+
<li class="breadcrumb-item active">Installation and Setup</li>
7272
<li class="wy-breadcrumbs-aside">
7373
<a href="../_sources/Setup/setup.rst.txt" rel="nofollow"> View page source</a>
7474
</li>
@@ -78,9 +78,31 @@
7878
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
7979
<div itemprop="articleBody">
8080

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>
81+
<section id="installation-and-setup">
82+
<h1>Installation and Setup<a class="headerlink" href="#installation-and-setup" title="Link to this heading"></a></h1>
83+
<p><strong>pyNeVer</strong> depends on several packages, which are all available via <code class="docutils literal notranslate"><span class="pre">pip</span></code> and should be installed automatically.
84+
The packages required for the correct execution are the following:</p>
85+
<ul class="simple">
86+
<li><p><em>numpy</em></p></li>
87+
<li><p><em>ortools</em></p></li>
88+
<li><p><em>onnx</em></p></li>
89+
<li><p><em>torch</em></p></li>
90+
<li><p><em>torchvision</em></p></li>
91+
<li><p><em>pysmt</em></p></li>
92+
<li><p><em>multipledispatch</em></p></li>
93+
</ul>
94+
<p>To install <strong>pyNeVer</strong> as an API, run the command:</p>
95+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>pynever
96+
</pre></div>
97+
</div>
98+
<p>To run <strong>pyNeVer</strong> as a standalone tool you should clone this repository and create a conda environment</p>
99+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/nevertools/pyNeVer
100+
<span class="nb">cd</span><span class="w"> </span>pyNeVer
101+
102+
conda<span class="w"> </span>env<span class="w"> </span>create<span class="w"> </span>-f<span class="w"> </span>environment.yml
103+
conda<span class="w"> </span>activate<span class="w"> </span>pynever
104+
</pre></div>
105+
</div>
84106
</section>
85107

86108

‎pynever/_modules/index.html

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

0 commit comments

Comments
 (0)