diff --git a/docs/finn/_build/doctrees/environment.pickle b/docs/finn/_build/doctrees/environment.pickle index 7758793f5dfcee919b09be9e17b800872def2da2..fea633144c18d76692cb8554887fae3ca177c98c 100644 Binary files a/docs/finn/_build/doctrees/environment.pickle and b/docs/finn/_build/doctrees/environment.pickle differ diff --git a/docs/finn/_build/doctrees/getting_started.doctree b/docs/finn/_build/doctrees/getting_started.doctree index 9dbdca274c9a74fb60257378e0c6601ca5939d2b..03db59d5b2770ddc593cd4928e7e2afafc3b076c 100644 Binary files a/docs/finn/_build/doctrees/getting_started.doctree and b/docs/finn/_build/doctrees/getting_started.doctree differ diff --git a/docs/finn/_build/doctrees/index.doctree b/docs/finn/_build/doctrees/index.doctree index 93c68a738d78c37d9640c996ad69961eaf3ed0d4..0c80a5a41d7f882745208036f79b25fc22065cc1 100644 Binary files a/docs/finn/_build/doctrees/index.doctree and b/docs/finn/_build/doctrees/index.doctree differ diff --git a/docs/finn/_build/doctrees/source_code/finn.analysis.doctree b/docs/finn/_build/doctrees/source_code/finn.analysis.doctree index b11a143c2469b0cbc2535dce9ffe1e2d093cba58..9d3b2e63f531c9aed8c284cfc20387c62ad1f437 100644 Binary files a/docs/finn/_build/doctrees/source_code/finn.analysis.doctree and b/docs/finn/_build/doctrees/source_code/finn.analysis.doctree differ diff --git a/docs/finn/_build/doctrees/source_code/finn.analysis.fpgadataflow.doctree b/docs/finn/_build/doctrees/source_code/finn.analysis.fpgadataflow.doctree index f2a9679be2041b76ba07f659ccead1fb30b8882c..40046ab359e9fb05a16d197598265e98387d37b7 100644 Binary files a/docs/finn/_build/doctrees/source_code/finn.analysis.fpgadataflow.doctree and b/docs/finn/_build/doctrees/source_code/finn.analysis.fpgadataflow.doctree differ diff --git a/docs/finn/_build/html/_sources/getting_started.rst.txt b/docs/finn/_build/html/_sources/getting_started.rst.txt index b1c1fa32556ecc6c5c43491f356085f43df7c706..d42e9dd94bb37f64fd6a821f96e0419f48fd0430 100644 --- a/docs/finn/_build/html/_sources/getting_started.rst.txt +++ b/docs/finn/_build/html/_sources/getting_started.rst.txt @@ -11,7 +11,7 @@ Requirements * Ubuntu 18.04 * Docker -* A working Vivado installation +* A working Vivado 2019.1 installation * A `VIVADO_PATH` environment variable pointing to the Vivado installation directory (e.g. the directory where settings64.sh is located) Running FINN in Docker diff --git a/docs/finn/_build/html/_sources/index.rst.txt b/docs/finn/_build/html/_sources/index.rst.txt index a41e76f02a979bff4e8bfaf59f46f4f08e37a76e..af903f9ea4bb6b0f8d9d22de20eacdaa4fb707f9 100644 --- a/docs/finn/_build/html/_sources/index.rst.txt +++ b/docs/finn/_build/html/_sources/index.rst.txt @@ -26,7 +26,7 @@ What is FINN? :maxdepth: 2 :hidden: - end_to_end_flow getting_started + end_to_end_flow source_code/finn diff --git a/docs/finn/_build/html/genindex.html b/docs/finn/_build/html/genindex.html index ad3dca129fa3b67ee87592f9bf6a2435d07a79c4..a30ecdee49b10fb4a0c566852f3288c6bcc37569 100644 --- a/docs/finn/_build/html/genindex.html +++ b/docs/finn/_build/html/genindex.html @@ -80,8 +80,8 @@ <ul> -<li class="toctree-l1"><a class="reference internal" href="end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="source_code/finn.html">finn package</a></li> </ul> diff --git a/docs/finn/_build/html/getting_started.html b/docs/finn/_build/html/getting_started.html index 6fbd26d7cba6339b02418a44c001c1d9d58c9fb5..4081e15f90acd1eb78003fe3cdad15036501efa8 100644 --- a/docs/finn/_build/html/getting_started.html +++ b/docs/finn/_build/html/getting_started.html @@ -35,8 +35,8 @@ <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> - <link rel="next" title="finn package" href="source_code/finn.html" /> - <link rel="prev" title="FINN - End-to-End Flow" href="end_to_end_flow.html" /> + <link rel="next" title="FINN - End-to-End Flow" href="end_to_end_flow.html" /> + <link rel="prev" title="FINN" href="index.html" /> </head> <body class="wy-body-for-nav"> @@ -81,7 +81,6 @@ <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Getting Started</a><ul> <li class="toctree-l2"><a class="reference internal" href="#how-to-use-the-finn-compiler">How to use the FINN compiler</a></li> <li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li> @@ -94,6 +93,7 @@ </li> </ul> </li> +<li class="toctree-l1"><a class="reference internal" href="end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="source_code/finn.html">finn package</a></li> </ul> @@ -170,7 +170,7 @@ <ul class="simple"> <li><p>Ubuntu 18.04</p></li> <li><p>Docker</p></li> -<li><p>A working Vivado installation</p></li> +<li><p>A working Vivado 2019.1 installation</p></li> <li><p>A <cite>VIVADO_PATH</cite> environment variable pointing to the Vivado installation directory (e.g. the directory where settings64.sh is located)</p></li> </ul> </div> @@ -226,10 +226,10 @@ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="source_code/finn.html" class="btn btn-neutral float-right" title="finn package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + <a href="end_to_end_flow.html" class="btn btn-neutral float-right" title="FINN - End-to-End Flow" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="end_to_end_flow.html" class="btn btn-neutral float-left" title="FINN - End-to-End Flow" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="index.html" class="btn btn-neutral float-left" title="FINN" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> diff --git a/docs/finn/_build/html/index.html b/docs/finn/_build/html/index.html index e7fc6ab72b5a4843fc1f42c0a36469d05afda97c..927359dd94721e32767cc0071fc34e24084b4752 100644 --- a/docs/finn/_build/html/index.html +++ b/docs/finn/_build/html/index.html @@ -35,7 +35,7 @@ <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> - <link rel="next" title="FINN - End-to-End Flow" href="end_to_end_flow.html" /> + <link rel="next" title="Getting Started" href="getting_started.html" /> </head> <body class="wy-body-for-nav"> @@ -80,8 +80,8 @@ <ul> -<li class="toctree-l1"><a class="reference internal" href="end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="source_code/finn.html">finn package</a></li> </ul> @@ -177,7 +177,7 @@ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="end_to_end_flow.html" class="btn btn-neutral float-right" title="FINN - End-to-End Flow" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + <a href="getting_started.html" class="btn btn-neutral float-right" title="Getting Started" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> </div> diff --git a/docs/finn/_build/html/py-modindex.html b/docs/finn/_build/html/py-modindex.html index 8f7478987e22efeaa3bd1c95ede2d92de309a1d6..a16fc84b45caf144b5c943eb30288092df6ef7ac 100644 --- a/docs/finn/_build/html/py-modindex.html +++ b/docs/finn/_build/html/py-modindex.html @@ -82,8 +82,8 @@ <ul> -<li class="toctree-l1"><a class="reference internal" href="end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="source_code/finn.html">finn package</a></li> </ul> diff --git a/docs/finn/_build/html/search.html b/docs/finn/_build/html/search.html index 8680019e298ea8b9d5921eb881e25d7172456792..f9c93364300d57a622b5000645f3b165689a63e1 100644 --- a/docs/finn/_build/html/search.html +++ b/docs/finn/_build/html/search.html @@ -80,8 +80,8 @@ <ul> -<li class="toctree-l1"><a class="reference internal" href="end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="source_code/finn.html">finn package</a></li> </ul> diff --git a/docs/finn/_build/html/source_code/finn.analysis.fpgadataflow.html b/docs/finn/_build/html/source_code/finn.analysis.fpgadataflow.html index 66af9e5b61b2b22078486bd9bcd128b6832b268d..6eb70fa03c2e1069c404a0d3a7266fccd8118eb1 100644 --- a/docs/finn/_build/html/source_code/finn.analysis.fpgadataflow.html +++ b/docs/finn/_build/html/source_code/finn.analysis.fpgadataflow.html @@ -81,8 +81,8 @@ <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1 current"><a class="reference internal" href="finn.html">finn package</a><ul class="current"> <li class="toctree-l2 current"><a class="reference internal" href="finn.html#subpackages">Subpackages</a><ul class="current"> <li class="toctree-l3 current"><a class="reference internal" href="finn.analysis.html">finn.analysis package</a><ul class="current"> @@ -181,7 +181,7 @@ <dt id="finn.analysis.fpgadataflow.hls_synth_res_estimation.hls_synth_res_estimation"> <code class="sig-prename descclassname">finn.analysis.fpgadataflow.hls_synth_res_estimation.</code><code class="sig-name descname">hls_synth_res_estimation</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.analysis.fpgadataflow.hls_synth_res_estimation.hls_synth_res_estimation" title="Permalink to this definition">¶</a></dt> <dd><p>Extracts the results from the vivado synthesis. -Returns {node name : resource estimation}</p> +Returns {node name : resource estimation}.</p> </dd></dl> </div> @@ -191,7 +191,7 @@ Returns {node name : resource estimation}</p> <dt id="finn.analysis.fpgadataflow.res_estimation.res_estimation"> <code class="sig-prename descclassname">finn.analysis.fpgadataflow.res_estimation.</code><code class="sig-name descname">res_estimation</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.analysis.fpgadataflow.res_estimation.res_estimation" title="Permalink to this definition">¶</a></dt> <dd><p>Estimates the resources needed for the given model. -Returns {node name : resource estimation}</p> +Returns {node name : resource estimation}.</p> </dd></dl> </div> diff --git a/docs/finn/_build/html/source_code/finn.analysis.html b/docs/finn/_build/html/source_code/finn.analysis.html index 53b62a9dd8bcab2984da1016e7c406791c1435af..0f6133de590407baecf62dbacead869aeb12fa7b 100644 --- a/docs/finn/_build/html/source_code/finn.analysis.html +++ b/docs/finn/_build/html/source_code/finn.analysis.html @@ -81,8 +81,8 @@ <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1 current"><a class="reference internal" href="finn.html">finn package</a><ul class="current"> <li class="toctree-l2 current"><a class="reference internal" href="finn.html#subpackages">Subpackages</a><ul class="current"> <li class="toctree-l3 current"><a class="current reference internal" href="#">finn.analysis package</a><ul> @@ -193,13 +193,13 @@ <dt id="finn.analysis.topology.all_tensors_f32"> <code class="sig-prename descclassname">finn.analysis.topology.</code><code class="sig-name descname">all_tensors_f32</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.analysis.topology.all_tensors_f32" title="Permalink to this definition">¶</a></dt> <dd><p>Checks whether all tensors have a float32 dtype, extra quantization -annotations notwithstanding.</p> +annotations notwithstanding. Returns {“all_tensors_f32â€: Bool}.</p> </dd></dl> <dl class="function"> <dt id="finn.analysis.topology.get_per_tensor_fanouts"> <code class="sig-prename descclassname">finn.analysis.topology.</code><code class="sig-name descname">get_per_tensor_fanouts</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.analysis.topology.get_per_tensor_fanouts" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dictionary of (tensor_name, tensor_fanout) for the model.</p> +<dd><p>Returns a dictionary of {tensor_name: tensor_fanout} for the model.</p> </dd></dl> <dl class="function"> @@ -207,7 +207,7 @@ annotations notwithstanding.</p> <code class="sig-prename descclassname">finn.analysis.topology.</code><code class="sig-name descname">is_linear</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.analysis.topology.is_linear" title="Permalink to this definition">¶</a></dt> <dd><p>Checks whether the given model graph is linear. This is done by looking at the fan-out of each tensor. All tensors have a fan-out <= 1 in a linear -graph. Returns {“is_linearâ€, Bool}</p> +graph. Returns {“is_linearâ€: Bool}.</p> </dd></dl> <dl class="function"> @@ -216,7 +216,8 @@ graph. Returns {“is_linearâ€, Bool}</p> <dd><p>Verifies that the node inputs are ordered in the way that FINN expects them. When a node has a mixture of static (= constant, initialized) inputs and dynamic inputs, the dynamic input should come first, followed by the -static one. Only verifiable for a small subset of op_types for now.</p> +static one. Only verifiable for a small subset of op_types for now. Returns +{“node_inputs_in_expected_orderâ€: Bool}.</p> </dd></dl> </div> @@ -226,8 +227,10 @@ static one. Only verifiable for a small subset of op_types for now.</p> <dt id="finn.analysis.verify_custom_nodes.verify_nodes"> <code class="sig-prename descclassname">finn.analysis.verify_custom_nodes.</code><code class="sig-name descname">verify_nodes</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.analysis.verify_custom_nodes.verify_nodes" title="Permalink to this definition">¶</a></dt> <dd><p>Checks if custom ops in graph are correctly built, with all attributes -and inputs. Returns {node op_type : info_messages} -<a href="#id1"><span class="problematic" id="id2">*</span></a>info_messages is list of strings about the result of the verification</p> +and inputs. Returns {node op_type : info_messages}</p> +<ul class="simple"> +<li><p>info_messages: is list of strings about the result of the verification.</p></li> +</ul> </dd></dl> </div> diff --git a/docs/finn/_build/html/source_code/finn.core.html b/docs/finn/_build/html/source_code/finn.core.html index d23a497114768167937e08487867d205f877fcd7..f3497ef34567d61d4fd62b0d352aae1b4be02c7c 100644 --- a/docs/finn/_build/html/source_code/finn.core.html +++ b/docs/finn/_build/html/source_code/finn.core.html @@ -81,8 +81,8 @@ <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1 current"><a class="reference internal" href="finn.html">finn package</a><ul class="current"> <li class="toctree-l2 current"><a class="reference internal" href="finn.html#subpackages">Subpackages</a><ul class="current"> <li class="toctree-l3"><a class="reference internal" href="finn.analysis.html">finn.analysis package</a></li> diff --git a/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.html b/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.html index e2e64ef1ee9dcd81d8201a99ac409d52be5734ae..3397e666a7604d1675a0a60a53f3f64e3dde2c45 100644 --- a/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.html +++ b/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.html @@ -81,8 +81,8 @@ <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1 current"><a class="reference internal" href="finn.html">finn package</a><ul class="current"> <li class="toctree-l2 current"><a class="reference internal" href="finn.html#subpackages">Subpackages</a><ul class="current"> <li class="toctree-l3"><a class="reference internal" href="finn.analysis.html">finn.analysis package</a></li> diff --git a/docs/finn/_build/html/source_code/finn.custom_op.html b/docs/finn/_build/html/source_code/finn.custom_op.html index 96f9fc548c52a50920b15c535a392aeb408a82d9..76679f1dce08528afca8798679611dc9222e53c0 100644 --- a/docs/finn/_build/html/source_code/finn.custom_op.html +++ b/docs/finn/_build/html/source_code/finn.custom_op.html @@ -81,8 +81,8 @@ <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1 current"><a class="reference internal" href="finn.html">finn package</a><ul class="current"> <li class="toctree-l2 current"><a class="reference internal" href="finn.html#subpackages">Subpackages</a><ul class="current"> <li class="toctree-l3"><a class="reference internal" href="finn.analysis.html">finn.analysis package</a></li> diff --git a/docs/finn/_build/html/source_code/finn.html b/docs/finn/_build/html/source_code/finn.html index 7b4e1468d29571d1807a0fa38109fa3cdb6cf47a..41405e8f3e8180d5b99d512583cfd42cf4f66e28 100644 --- a/docs/finn/_build/html/source_code/finn.html +++ b/docs/finn/_build/html/source_code/finn.html @@ -36,7 +36,7 @@ <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="finn.analysis package" href="finn.analysis.html" /> - <link rel="prev" title="Getting Started" href="../getting_started.html" /> + <link rel="prev" title="FINN - End-to-End Flow" href="../end_to_end_flow.html" /> </head> <body class="wy-body-for-nav"> @@ -81,8 +81,8 @@ <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">finn package</a><ul> <li class="toctree-l2"><a class="reference internal" href="#subpackages">Subpackages</a><ul> <li class="toctree-l3"><a class="reference internal" href="finn.analysis.html">finn.analysis package</a></li> @@ -295,7 +295,7 @@ <a href="finn.analysis.html" class="btn btn-neutral float-right" title="finn.analysis package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="../getting_started.html" class="btn btn-neutral float-left" title="Getting Started" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="../end_to_end_flow.html" class="btn btn-neutral float-left" title="FINN - End-to-End Flow" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> diff --git a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.html b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.html index ecb446b4b8b6a4719c893ede8efee4370e84b136..8df99ea93108608e6c7548a7294540428f8090b4 100644 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.html +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.html @@ -81,8 +81,8 @@ <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1 current"><a class="reference internal" href="finn.html">finn package</a><ul class="current"> <li class="toctree-l2 current"><a class="reference internal" href="finn.html#subpackages">Subpackages</a><ul class="current"> <li class="toctree-l3"><a class="reference internal" href="finn.analysis.html">finn.analysis package</a></li> diff --git a/docs/finn/_build/html/source_code/finn.transformation.html b/docs/finn/_build/html/source_code/finn.transformation.html index 7137bc225817e97e6a4552bd684f4d0f2c2f496a..7e75c43e1a9418199581a92a4c82fa529ff0e616 100644 --- a/docs/finn/_build/html/source_code/finn.transformation.html +++ b/docs/finn/_build/html/source_code/finn.transformation.html @@ -81,8 +81,8 @@ <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1 current"><a class="reference internal" href="finn.html">finn package</a><ul class="current"> <li class="toctree-l2 current"><a class="reference internal" href="finn.html#subpackages">Subpackages</a><ul class="current"> <li class="toctree-l3"><a class="reference internal" href="finn.analysis.html">finn.analysis package</a></li> diff --git a/docs/finn/_build/html/source_code/finn.transformation.streamline.html b/docs/finn/_build/html/source_code/finn.transformation.streamline.html index 31a87bdb4971af86f1f9222f8f27162375937d8d..9d0b44376a524a0c8dc179890bfd05832c5984a0 100644 --- a/docs/finn/_build/html/source_code/finn.transformation.streamline.html +++ b/docs/finn/_build/html/source_code/finn.transformation.streamline.html @@ -81,8 +81,8 @@ <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1 current"><a class="reference internal" href="finn.html">finn package</a><ul class="current"> <li class="toctree-l2 current"><a class="reference internal" href="finn.html#subpackages">Subpackages</a><ul class="current"> <li class="toctree-l3"><a class="reference internal" href="finn.analysis.html">finn.analysis package</a></li> diff --git a/docs/finn/_build/html/source_code/finn.util.html b/docs/finn/_build/html/source_code/finn.util.html index da8fe1e3c3ed527e4fd31b2d3dbc3381ed139fb1..93c23b203017762bb6ba85fab5bb71ed22473b33 100644 --- a/docs/finn/_build/html/source_code/finn.util.html +++ b/docs/finn/_build/html/source_code/finn.util.html @@ -80,8 +80,8 @@ <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1 current"><a class="reference internal" href="finn.html">finn package</a><ul class="current"> <li class="toctree-l2 current"><a class="reference internal" href="finn.html#subpackages">Subpackages</a><ul class="current"> <li class="toctree-l3"><a class="reference internal" href="finn.analysis.html">finn.analysis package</a></li> diff --git a/docs/finn/_build/html/source_code/modules.html b/docs/finn/_build/html/source_code/modules.html index f20549b667f93be7935d1ddbdbd2a91a8039ab00..2a0d6a6966205b788ec5488338a51fec6e3ec401 100644 --- a/docs/finn/_build/html/source_code/modules.html +++ b/docs/finn/_build/html/source_code/modules.html @@ -79,8 +79,8 @@ <ul> -<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../end_to_end_flow.html">FINN - End-to-End Flow</a></li> <li class="toctree-l1"><a class="reference internal" href="finn.html">finn package</a></li> </ul> diff --git a/docs/finn/getting_started.rst b/docs/finn/getting_started.rst index b1c1fa32556ecc6c5c43491f356085f43df7c706..d42e9dd94bb37f64fd6a821f96e0419f48fd0430 100644 --- a/docs/finn/getting_started.rst +++ b/docs/finn/getting_started.rst @@ -11,7 +11,7 @@ Requirements * Ubuntu 18.04 * Docker -* A working Vivado installation +* A working Vivado 2019.1 installation * A `VIVADO_PATH` environment variable pointing to the Vivado installation directory (e.g. the directory where settings64.sh is located) Running FINN in Docker diff --git a/docs/finn/index.rst b/docs/finn/index.rst index a41e76f02a979bff4e8bfaf59f46f4f08e37a76e..af903f9ea4bb6b0f8d9d22de20eacdaa4fb707f9 100644 --- a/docs/finn/index.rst +++ b/docs/finn/index.rst @@ -26,7 +26,7 @@ What is FINN? :maxdepth: 2 :hidden: - end_to_end_flow getting_started + end_to_end_flow source_code/finn