diff --git a/docs/finn/_build/doctrees/environment.pickle b/docs/finn/_build/doctrees/environment.pickle index 51e2174164b9d812a1605a0513facd9b57694f72..dba4d47e1c9b2a4634a95e9da9d46e13cda6f0f5 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/finn.analysis.doctree b/docs/finn/_build/doctrees/finn.analysis.doctree deleted file mode 100644 index 877b6934ee2a179b23a2a1db3032203b49c64d1d..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/finn.analysis.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/finn.analysis.fpgadataflow.doctree b/docs/finn/_build/doctrees/finn.analysis.fpgadataflow.doctree deleted file mode 100644 index ce076452ef97983fe53e92414ba6b5ffdb62ed3d..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/finn.analysis.fpgadataflow.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/finn.core.doctree b/docs/finn/_build/doctrees/finn.core.doctree deleted file mode 100644 index 42de8dd2dc313da5cad831d24ca7df8591edd6e9..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/finn.core.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/finn.custom_op.doctree b/docs/finn/_build/doctrees/finn.custom_op.doctree deleted file mode 100644 index 7d19abf2f1afbb901cd38f4f93521b39b267a901..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/finn.custom_op.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/finn.custom_op.fpgadataflow.doctree b/docs/finn/_build/doctrees/finn.custom_op.fpgadataflow.doctree deleted file mode 100644 index c7ddea653cf17ff4357736dc47386fd9c191a573..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/finn.custom_op.fpgadataflow.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/finn.doctree b/docs/finn/_build/doctrees/finn.doctree deleted file mode 100644 index c33914005c5d855aada62f6ac4af061572c1a372..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/finn.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/finn.transformation.doctree b/docs/finn/_build/doctrees/finn.transformation.doctree deleted file mode 100644 index 44f905b2dac89f2ca45ec3df016e71c6dae0bb1a..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/finn.transformation.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/finn.transformation.fpgadataflow.doctree b/docs/finn/_build/doctrees/finn.transformation.fpgadataflow.doctree deleted file mode 100644 index 3be267ae731d9ca4705f33e70fe3573704d71133..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/finn.transformation.fpgadataflow.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/finn.transformation.streamline.doctree b/docs/finn/_build/doctrees/finn.transformation.streamline.doctree deleted file mode 100644 index 0ed5c3c78330a8486aa53a2a7ffd10047941752e..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/finn.transformation.streamline.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/finn.util.doctree b/docs/finn/_build/doctrees/finn.util.doctree deleted file mode 100644 index 3d9ce38ffe05238e025e59c9a14ca4b780f5afd0..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/finn.util.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/modules.doctree b/docs/finn/_build/doctrees/modules.doctree index 2ab6f8d5dbe5155d3e1ebec57f89ff8361812750..d16dc0ea5ca22e82f0372b266abb3a9700ec5a2d 100644 Binary files a/docs/finn/_build/doctrees/modules.doctree and b/docs/finn/_build/doctrees/modules.doctree differ diff --git a/docs/finn/_build/doctrees/source_code/analysis.doctree b/docs/finn/_build/doctrees/source_code/analysis.doctree deleted file mode 100644 index c282b8da4a5cd36489c6eab04b20183bc31802b2..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/analysis.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/analysis.fpgadataflow.doctree b/docs/finn/_build/doctrees/source_code/analysis.fpgadataflow.doctree deleted file mode 100644 index bd8290e0350478b8096847dd0ad7da10b9e372d9..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/analysis.fpgadataflow.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/analysis/analysis.doctree b/docs/finn/_build/doctrees/source_code/analysis/analysis.doctree deleted file mode 100644 index d9f2e18007a92975994cb5b194cfaadeac307bab..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/analysis/analysis.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/analysis/analysis.fpgadataflow.doctree b/docs/finn/_build/doctrees/source_code/analysis/analysis.fpgadataflow.doctree deleted file mode 100644 index d4b4b69e8f0331bf8c8322c116de583ec945a682..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/analysis/analysis.fpgadataflow.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.doctree b/docs/finn/_build/doctrees/source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.doctree deleted file mode 100644 index d2a9383f4aadf300d64d26b7d54850798cdf74f6..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.analysis.fpgadataflow.res_estimation.doctree b/docs/finn/_build/doctrees/source_code/finn.analysis.fpgadataflow.res_estimation.doctree deleted file mode 100644 index 8b1fa4f0540c52d0bbbb4d5e7cb4a5923acf7d64..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.analysis.fpgadataflow.res_estimation.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.analysis.topology.doctree b/docs/finn/_build/doctrees/source_code/finn.analysis.topology.doctree deleted file mode 100644 index 451f72dee0acfd8238d8ab0bc0cfe36bdd8f955d..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.analysis.topology.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.analysis.verify_custom_nodes.doctree b/docs/finn/_build/doctrees/source_code/finn.analysis.verify_custom_nodes.doctree deleted file mode 100644 index b8b840f01e19afe06f90d50f68fb939bdf400311..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.analysis.verify_custom_nodes.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.core.datatype.doctree b/docs/finn/_build/doctrees/source_code/finn.core.datatype.doctree deleted file mode 100644 index e2576c7df3a7905e05ad1e9dd13a228f05b6eaff..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.core.datatype.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.core.execute_custom_node.doctree b/docs/finn/_build/doctrees/source_code/finn.core.execute_custom_node.doctree deleted file mode 100644 index ab4f77e7bdba1d31b3967260f86eeb114389c2cc..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.core.execute_custom_node.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.core.modelwrapper.doctree b/docs/finn/_build/doctrees/source_code/finn.core.modelwrapper.doctree deleted file mode 100644 index 3384f0c4528f2bc42bcb9c27884ac86ad9753563..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.core.modelwrapper.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.core.onnx_exec.doctree b/docs/finn/_build/doctrees/source_code/finn.core.onnx_exec.doctree deleted file mode 100644 index 7529c89d10f492df2d88b0823fb81557dcfc3ac1..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.core.onnx_exec.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.core.remote_exec.doctree b/docs/finn/_build/doctrees/source_code/finn.core.remote_exec.doctree deleted file mode 100644 index 8b4675413117862af218c9588e64c4cacc682b0a..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.core.remote_exec.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.core.rtlsim_exec.doctree b/docs/finn/_build/doctrees/source_code/finn.core.rtlsim_exec.doctree deleted file mode 100644 index 44778b6af972760799db23060282fde4f910b0ff..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.core.rtlsim_exec.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.doctree b/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.doctree deleted file mode 100644 index 44a33132d6edf7bc09b33711106b98799d663884..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.doctree b/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.doctree deleted file mode 100644 index f592107cc5cd75a779aea4343ab1b18dea38adef..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.doctree b/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.doctree deleted file mode 100644 index 12982cc9549116a8f4d603bfecbfe604ca7f34f9..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.templates.doctree b/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.templates.doctree deleted file mode 100644 index d06fe5a5e4013093e7488b6f0b88bad5964e98d2..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.templates.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.tlastmarker.doctree b/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.tlastmarker.doctree deleted file mode 100644 index 6bb7fdef37d72c0b9e21f1888ea0111464485aa2..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.tlastmarker.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.custom_op.multithreshold.doctree b/docs/finn/_build/doctrees/source_code/finn.custom_op.multithreshold.doctree deleted file mode 100644 index 40ce00f406b1ace0c7141edf75bef5d70f19a98d..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.custom_op.multithreshold.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.custom_op.registry.doctree b/docs/finn/_build/doctrees/source_code/finn.custom_op.registry.doctree deleted file mode 100644 index 676dad32797a5f4c4e6470db2bedbcc5d1bf17b3..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.custom_op.registry.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.custom_op.streamingdataflowpartition.doctree b/docs/finn/_build/doctrees/source_code/finn.custom_op.streamingdataflowpartition.doctree deleted file mode 100644 index 93ddbfe4aa871e46574ad732284f5f85b4807004..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.custom_op.streamingdataflowpartition.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.custom_op.xnorpopcount.doctree b/docs/finn/_build/doctrees/source_code/finn.custom_op.xnorpopcount.doctree deleted file mode 100644 index 5c1950c03f6c89f0c0d5dffbfa42e1f47e50b7b6..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.custom_op.xnorpopcount.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.batchnorm_to_affine.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.batchnorm_to_affine.doctree deleted file mode 100644 index 7e7c0e91d44c7655c96717fddf955046b3f2799c..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.batchnorm_to_affine.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.bipolar_to_xnor.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.bipolar_to_xnor.doctree deleted file mode 100644 index 7ab9e0301f6adb07765038346c29882bcb5cd984..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.bipolar_to_xnor.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.fold_constants.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.fold_constants.doctree deleted file mode 100644 index e663ce9c4f22c0e6f2aebca1088d4103a0c7099d..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.fold_constants.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.cleanup.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.cleanup.doctree deleted file mode 100644 index a12493641d50d9f0b593ce4914f0cf51721c0741..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.cleanup.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.codegen_ipgen.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.codegen_ipgen.doctree deleted file mode 100644 index 8fc625699983bdcacf2e12e8bd355053b8403f88..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.codegen_ipgen.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.codegen_ipstitch.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.codegen_ipstitch.doctree deleted file mode 100644 index 2d494a41e94b0710566eeb47f1f841443eb5bc97..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.codegen_ipstitch.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.codegen_npysim.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.codegen_npysim.doctree deleted file mode 100644 index 8ed36707c989351fed68500d6d91ee4f8220bbcd..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.codegen_npysim.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.compile.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.compile.doctree deleted file mode 100644 index 0a36c583dcb1c37f59ea28c0b6441ead5530b772..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.compile.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.doctree deleted file mode 100644 index a446704bded33ea28f6691f1a5ce8e403588ee07..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.create_dataflow_partition.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.create_dataflow_partition.doctree deleted file mode 100644 index 20f73c1d9fa5890a1e2ad6ec86976541fa6b41e9..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.create_dataflow_partition.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.doctree deleted file mode 100644 index 951f6fc94b4d18d3136b01ee1f84d020df532ce6..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.insert_tlastmarker.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.insert_tlastmarker.doctree deleted file mode 100644 index 632480f19e3c8921ffb158802af93470ad598bb4..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.insert_tlastmarker.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.make_deployment.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.make_deployment.doctree deleted file mode 100644 index a315244a5c8af11290208dec82478dca3c8fe7a3..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.make_deployment.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.make_pynq_driver.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.make_pynq_driver.doctree deleted file mode 100644 index b6f2de2cf25f5ddb97534175854c6acf52b6dd41..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.make_pynq_driver.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.make_pynq_proj.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.make_pynq_proj.doctree deleted file mode 100644 index 3b94d08ece6af841e15988b51c2da034e9d8b6fc..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.make_pynq_proj.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.set_exec_mode.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.set_exec_mode.doctree deleted file mode 100644 index 962143668310625211d3e74e9be3e477931ddd1b..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.set_exec_mode.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.synth_pynq_proj.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.synth_pynq_proj.doctree deleted file mode 100644 index ee626d0580922430bd18d3ef81be3e01b21cdb21..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.synth_pynq_proj.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.templates.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.templates.doctree deleted file mode 100644 index 3038d1db11c2f71dff096f655ef04f73ed291ca4..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.templates.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.general.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.general.doctree deleted file mode 100644 index 4ed74a955612d2ecd9dd00f9ee199ec6f8e1a52c..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.general.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.infer_datatypes.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.infer_datatypes.doctree deleted file mode 100644 index 3984b1d7dee35f0a18c0f11e9f01abd61bd841a5..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.infer_datatypes.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.infer_shapes.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.infer_shapes.doctree deleted file mode 100644 index 5b8271a7ccba07b43a16552a53fac02b4bd8fe61..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.infer_shapes.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.absorb.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.absorb.doctree deleted file mode 100644 index 488afd58674e2e6f64da237ed04804c455031f61..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.absorb.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.collapse_repeated.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.collapse_repeated.doctree deleted file mode 100644 index c19ec7207840b8eef6b2f951cb4741bc6856c3c2..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.collapse_repeated.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.reorder.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.reorder.doctree deleted file mode 100644 index df8d05d07f42fc84427bd2f4d63990f62a8f54cf..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.reorder.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.round_thresholds.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.round_thresholds.doctree deleted file mode 100644 index 1537b4cb415757c59fe4338f65e70047ef8beab6..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.round_thresholds.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.sign_to_thres.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.sign_to_thres.doctree deleted file mode 100644 index ce0eb33fb3b5c5388f054220d7d603ee61f2ca8f..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.sign_to_thres.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.util.basic.doctree b/docs/finn/_build/doctrees/source_code/finn.util.basic.doctree deleted file mode 100644 index c8ace62eeb3bc4308309de16cc3a2c5464b90c88..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.util.basic.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.util.data_packing.doctree b/docs/finn/_build/doctrees/source_code/finn.util.data_packing.doctree deleted file mode 100644 index c8e2f92b5f73be87502a77d68d501cf92f84d119..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.util.data_packing.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.util.fpgadataflow.doctree b/docs/finn/_build/doctrees/source_code/finn.util.fpgadataflow.doctree deleted file mode 100644 index d73ae460387d36d94911508713eb9c2e2a2b5edc..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.util.fpgadataflow.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.util.onnx.doctree b/docs/finn/_build/doctrees/source_code/finn.util.onnx.doctree deleted file mode 100644 index 37b1cca4b5168af822e2985137bca78351fa4673..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.util.onnx.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/source_code/finn.util.test.doctree b/docs/finn/_build/doctrees/source_code/finn.util.test.doctree deleted file mode 100644 index e60811840536576a89d784df9e24289cb5cba6ac..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/source_code/finn.util.test.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/src.doctree b/docs/finn/_build/doctrees/src.doctree deleted file mode 100644 index effdd10387320a6fcbce245d0bbbee330b41883e..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/src.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/src.finn.analysis.doctree b/docs/finn/_build/doctrees/src.finn.analysis.doctree deleted file mode 100644 index 4a8f4e7ce7dc0b2bb6a258960c17e41a817d3c69..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/src.finn.analysis.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/src.finn.analysis.fpgadataflow.doctree b/docs/finn/_build/doctrees/src.finn.analysis.fpgadataflow.doctree deleted file mode 100644 index e0d66e2d6de1bcb04b67fee1cf7d2aa92f98b695..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/src.finn.analysis.fpgadataflow.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/src.finn.core.doctree b/docs/finn/_build/doctrees/src.finn.core.doctree deleted file mode 100644 index 391b283db87ea052186bb28e9967c77d1120814e..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/src.finn.core.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/src.finn.custom_op.doctree b/docs/finn/_build/doctrees/src.finn.custom_op.doctree deleted file mode 100644 index 385263a26e09aff393a9678199e40ca505c41f14..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/src.finn.custom_op.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/src.finn.custom_op.fpgadataflow.doctree b/docs/finn/_build/doctrees/src.finn.custom_op.fpgadataflow.doctree deleted file mode 100644 index 7f8ef8497181b3b51e256dca3d9535b9aa6648fa..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/src.finn.custom_op.fpgadataflow.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/src.finn.doctree b/docs/finn/_build/doctrees/src.finn.doctree deleted file mode 100644 index d8bf6824f2f39ee4cc130bf10504e2d11e32ba0b..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/src.finn.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/src.finn.transformation.doctree b/docs/finn/_build/doctrees/src.finn.transformation.doctree deleted file mode 100644 index 188aa0d987f5b57ed21c44a1dcd8a0b880807335..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/src.finn.transformation.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/src.finn.transformation.fpgadataflow.doctree b/docs/finn/_build/doctrees/src.finn.transformation.fpgadataflow.doctree deleted file mode 100644 index d7140a2a9a72b9aafd1194f6c25c2600044cfa3f..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/src.finn.transformation.fpgadataflow.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/src.finn.transformation.streamline.doctree b/docs/finn/_build/doctrees/src.finn.transformation.streamline.doctree deleted file mode 100644 index fc4787c61b9dc5c94645cc5b08e29a6b1317f55a..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/src.finn.transformation.streamline.doctree and /dev/null differ diff --git a/docs/finn/_build/doctrees/src.finn.util.doctree b/docs/finn/_build/doctrees/src.finn.util.doctree deleted file mode 100644 index b8ec438f0cf9c2738df4b83f592496f2209345bd..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/doctrees/src.finn.util.doctree and /dev/null differ diff --git a/docs/finn/_build/html/.doctrees/end_to_end_flow.doctree b/docs/finn/_build/html/.doctrees/end_to_end_flow.doctree deleted file mode 100644 index 4491df3570b2d3cd46d81bb068f1076304a101e6..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/.doctrees/end_to_end_flow.doctree and /dev/null differ diff --git a/docs/finn/_build/html/.doctrees/environment.pickle b/docs/finn/_build/html/.doctrees/environment.pickle deleted file mode 100644 index 80103576d646bb6639d0aae04aacf6c40b1d3593..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/.doctrees/environment.pickle and /dev/null differ diff --git a/docs/finn/_build/html/.doctrees/getting_started.doctree b/docs/finn/_build/html/.doctrees/getting_started.doctree deleted file mode 100644 index df22a7fecaeaf94ca594133957e914504b10bb9f..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/.doctrees/getting_started.doctree and /dev/null differ diff --git a/docs/finn/_build/html/.doctrees/index.doctree b/docs/finn/_build/html/.doctrees/index.doctree deleted file mode 100644 index 85ea545f0d1de74c2305e3e13ed541c6f5529084..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/.doctrees/index.doctree and /dev/null differ diff --git a/docs/finn/_build/html/.doctrees/modules.doctree b/docs/finn/_build/html/.doctrees/modules.doctree deleted file mode 100644 index 2ab6f8d5dbe5155d3e1ebec57f89ff8361812750..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/.doctrees/modules.doctree and /dev/null differ diff --git a/docs/finn/_build/html/.doctrees/source_code.doctree b/docs/finn/_build/html/.doctrees/source_code.doctree deleted file mode 100644 index 4990dad6ddfef91c5d78ed7fdf1672d78a7a40ef..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/.doctrees/source_code.doctree and /dev/null differ diff --git a/docs/finn/_build/html/.doctrees/source_code/finn.analysis.doctree b/docs/finn/_build/html/.doctrees/source_code/finn.analysis.doctree deleted file mode 100644 index 5b78d4a9400210bebe1e8d3ffb1cf0c58cde3ae9..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/.doctrees/source_code/finn.analysis.doctree and /dev/null differ diff --git a/docs/finn/_build/html/.doctrees/source_code/finn.analysis.fpgadataflow.doctree b/docs/finn/_build/html/.doctrees/source_code/finn.analysis.fpgadataflow.doctree deleted file mode 100644 index cf4f42a3ff0da4b19a0cd112d9d7051650e47744..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/.doctrees/source_code/finn.analysis.fpgadataflow.doctree and /dev/null differ diff --git a/docs/finn/_build/html/.doctrees/source_code/finn.core.doctree b/docs/finn/_build/html/.doctrees/source_code/finn.core.doctree deleted file mode 100644 index 515b78771ea6d47c72f723398dfa31aaad4f25f4..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/.doctrees/source_code/finn.core.doctree and /dev/null differ diff --git a/docs/finn/_build/html/.doctrees/source_code/finn.custom_op.doctree b/docs/finn/_build/html/.doctrees/source_code/finn.custom_op.doctree deleted file mode 100644 index c28b05b9f09f01e8bc7bb0b0828224caafc9d9b4..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/.doctrees/source_code/finn.custom_op.doctree and /dev/null differ diff --git a/docs/finn/_build/html/.doctrees/source_code/finn.custom_op.fpgadataflow.doctree b/docs/finn/_build/html/.doctrees/source_code/finn.custom_op.fpgadataflow.doctree deleted file mode 100644 index 87980c4e555347115205ca81c434b5863b6ff31e..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/.doctrees/source_code/finn.custom_op.fpgadataflow.doctree and /dev/null differ diff --git a/docs/finn/_build/html/.doctrees/source_code/finn.doctree b/docs/finn/_build/html/.doctrees/source_code/finn.doctree deleted file mode 100644 index 9c00c3210f86308047634374db78d9815bab05ae..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/.doctrees/source_code/finn.doctree and /dev/null differ diff --git a/docs/finn/_build/html/.doctrees/source_code/finn.transformation.doctree b/docs/finn/_build/html/.doctrees/source_code/finn.transformation.doctree deleted file mode 100644 index 8517257fd55c81aa3df449dba743af1678a13412..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/.doctrees/source_code/finn.transformation.doctree and /dev/null differ diff --git a/docs/finn/_build/html/.doctrees/source_code/finn.transformation.fpgadataflow.doctree b/docs/finn/_build/html/.doctrees/source_code/finn.transformation.fpgadataflow.doctree deleted file mode 100644 index 007833da517e60e7ecb71f43079e149b5313b613..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/.doctrees/source_code/finn.transformation.fpgadataflow.doctree and /dev/null differ diff --git a/docs/finn/_build/html/.doctrees/source_code/finn.transformation.streamline.doctree b/docs/finn/_build/html/.doctrees/source_code/finn.transformation.streamline.doctree deleted file mode 100644 index 16323c25503426bed5e883cbdf7cd6cf657775df..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/.doctrees/source_code/finn.transformation.streamline.doctree and /dev/null differ diff --git a/docs/finn/_build/html/.doctrees/source_code/finn.util.doctree b/docs/finn/_build/html/.doctrees/source_code/finn.util.doctree deleted file mode 100644 index c76b2a37e1d3837d081201ec157666d46962daa1..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/.doctrees/source_code/finn.util.doctree and /dev/null differ diff --git a/docs/finn/_build/html/.doctrees/source_code/modules.doctree b/docs/finn/_build/html/.doctrees/source_code/modules.doctree deleted file mode 100644 index 041d2892a696c5476a616a12324998b02fea8af3..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/.doctrees/source_code/modules.doctree and /dev/null differ diff --git a/docs/finn/_build/html/_images/finn-flow.png b/docs/finn/_build/html/_images/finn-flow.png deleted file mode 100644 index 47aef287095c46b2f38030bca0a8d2e5d7cae2a9..0000000000000000000000000000000000000000 Binary files a/docs/finn/_build/html/_images/finn-flow.png and /dev/null differ diff --git a/docs/finn/_build/html/_sources/finn.analysis.fpgadataflow.rst.txt b/docs/finn/_build/html/_sources/finn.analysis.fpgadataflow.rst.txt deleted file mode 100644 index cd8075d753f617f4e97a851e9b54139c966a18b2..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/finn.analysis.fpgadataflow.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -finn.analysis.fpgadataflow package -================================== - -Submodules ----------- - -finn.analysis.fpgadataflow.hls\_synth\_res\_estimation module -------------------------------------------------------------- - -.. automodule:: finn.analysis.fpgadataflow.hls_synth_res_estimation - :members: - :undoc-members: - :show-inheritance: - -finn.analysis.fpgadataflow.res\_estimation module -------------------------------------------------- - -.. automodule:: finn.analysis.fpgadataflow.res_estimation - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: finn.analysis.fpgadataflow - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/finn.analysis.rst.txt b/docs/finn/_build/html/_sources/finn.analysis.rst.txt deleted file mode 100644 index e4eec7717a1119de8ef5381b67361973a9ac29c5..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/finn.analysis.rst.txt +++ /dev/null @@ -1,37 +0,0 @@ -finn.analysis package -===================== - -Subpackages ------------ - -.. toctree:: - - finn.analysis.fpgadataflow - -Submodules ----------- - -finn.analysis.topology module ------------------------------ - -.. automodule:: finn.analysis.topology - :members: - :undoc-members: - :show-inheritance: - -finn.analysis.verify\_custom\_nodes module ------------------------------------------- - -.. automodule:: finn.analysis.verify_custom_nodes - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: finn.analysis - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/finn.core.rst.txt b/docs/finn/_build/html/_sources/finn.core.rst.txt deleted file mode 100644 index 9e3ba4891b4b926c45410d30d16ae22da482ec95..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/finn.core.rst.txt +++ /dev/null @@ -1,46 +0,0 @@ -finn.core package -================= - -Submodules ----------- - -finn.core.datatype module -------------------------- - -.. automodule:: finn.core.datatype - :members: - :undoc-members: - :show-inheritance: - -finn.core.execute\_custom\_node module --------------------------------------- - -.. automodule:: finn.core.execute_custom_node - :members: - :undoc-members: - :show-inheritance: - -finn.core.modelwrapper module ------------------------------ - -.. automodule:: finn.core.modelwrapper - :members: - :undoc-members: - :show-inheritance: - -finn.core.onnx\_exec module ---------------------------- - -.. automodule:: finn.core.onnx_exec - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: finn.core - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/finn.custom_op.fpgadataflow.rst.txt b/docs/finn/_build/html/_sources/finn.custom_op.fpgadataflow.rst.txt deleted file mode 100644 index 632c021beb247e077f87c5af68d62bc51f88ecdc..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/finn.custom_op.fpgadataflow.rst.txt +++ /dev/null @@ -1,54 +0,0 @@ -finn.custom\_op.fpgadataflow package -==================================== - -Submodules ----------- - -finn.custom\_op.fpgadataflow.convolutioninputgenerator module -------------------------------------------------------------- - -.. automodule:: finn.custom_op.fpgadataflow.convolutioninputgenerator - :members: - :undoc-members: - :show-inheritance: - -finn.custom\_op.fpgadataflow.streamingfclayer\_batch module ------------------------------------------------------------ - -.. automodule:: finn.custom_op.fpgadataflow.streamingfclayer_batch - :members: - :undoc-members: - :show-inheritance: - -finn.custom\_op.fpgadataflow.streamingmaxpool\_batch module ------------------------------------------------------------ - -.. automodule:: finn.custom_op.fpgadataflow.streamingmaxpool_batch - :members: - :undoc-members: - :show-inheritance: - -finn.custom\_op.fpgadataflow.templates module ---------------------------------------------- - -.. automodule:: finn.custom_op.fpgadataflow.templates - :members: - :undoc-members: - :show-inheritance: - -finn.custom\_op.fpgadataflow.tlastmarker module ------------------------------------------------ - -.. automodule:: finn.custom_op.fpgadataflow.tlastmarker - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: finn.custom_op.fpgadataflow - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/finn.custom_op.rst.txt b/docs/finn/_build/html/_sources/finn.custom_op.rst.txt deleted file mode 100644 index a984822aee2962c945a66deb50a3fd1233d5d2d0..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/finn.custom_op.rst.txt +++ /dev/null @@ -1,53 +0,0 @@ -finn.custom\_op package -======================= - -Subpackages ------------ - -.. toctree:: - - finn.custom_op.fpgadataflow - -Submodules ----------- - -finn.custom\_op.multithreshold module -------------------------------------- - -.. automodule:: finn.custom_op.multithreshold - :members: - :undoc-members: - :show-inheritance: - -finn.custom\_op.registry module -------------------------------- - -.. automodule:: finn.custom_op.registry - :members: - :undoc-members: - :show-inheritance: - -finn.custom\_op.streamingdataflowpartition module -------------------------------------------------- - -.. automodule:: finn.custom_op.streamingdataflowpartition - :members: - :undoc-members: - :show-inheritance: - -finn.custom\_op.xnorpopcount module ------------------------------------ - -.. automodule:: finn.custom_op.xnorpopcount - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: finn.custom_op - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/finn.rst.txt b/docs/finn/_build/html/_sources/finn.rst.txt deleted file mode 100644 index 1b7a1ae72ab12aa842f0a5dee16b7de6e5f76e58..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/finn.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -finn package -============ - -Subpackages ------------ - -.. toctree:: - - finn.analysis - finn.core - finn.custom_op - finn.transformation - finn.util - -Module contents ---------------- - -.. automodule:: finn - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/finn.transformation.fpgadataflow.rst.txt b/docs/finn/_build/html/_sources/finn.transformation.fpgadataflow.rst.txt deleted file mode 100644 index 80ad49c24626365a992c64e3ad0fe3540d0c76f7..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/finn.transformation.fpgadataflow.rst.txt +++ /dev/null @@ -1,134 +0,0 @@ -finn.transformation.fpgadataflow package -======================================== - -Submodules ----------- - -finn.transformation.fpgadataflow.cleanup module ------------------------------------------------ - -.. automodule:: finn.transformation.fpgadataflow.cleanup - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.fpgadataflow.codegen\_ipgen module ------------------------------------------------------- - -.. automodule:: finn.transformation.fpgadataflow.codegen_ipgen - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.fpgadataflow.codegen\_ipstitch module ---------------------------------------------------------- - -.. automodule:: finn.transformation.fpgadataflow.codegen_ipstitch - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.fpgadataflow.codegen\_npysim module -------------------------------------------------------- - -.. automodule:: finn.transformation.fpgadataflow.codegen_npysim - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.fpgadataflow.compile module ------------------------------------------------ - -.. automodule:: finn.transformation.fpgadataflow.compile - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.fpgadataflow.convert\_to\_hls\_layers module ----------------------------------------------------------------- - -.. automodule:: finn.transformation.fpgadataflow.convert_to_hls_layers - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.fpgadataflow.create\_dataflow\_partition module -------------------------------------------------------------------- - -.. automodule:: finn.transformation.fpgadataflow.create_dataflow_partition - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.fpgadataflow.hlssynth\_ipgen module -------------------------------------------------------- - -.. automodule:: finn.transformation.fpgadataflow.hlssynth_ipgen - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.fpgadataflow.insert\_tlastmarker module ------------------------------------------------------------ - -.. automodule:: finn.transformation.fpgadataflow.insert_tlastmarker - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.fpgadataflow.make\_deployment module --------------------------------------------------------- - -.. automodule:: finn.transformation.fpgadataflow.make_deployment - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.fpgadataflow.make\_pynq\_driver module ----------------------------------------------------------- - -.. automodule:: finn.transformation.fpgadataflow.make_pynq_driver - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.fpgadataflow.make\_pynq\_proj module --------------------------------------------------------- - -.. automodule:: finn.transformation.fpgadataflow.make_pynq_proj - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.fpgadataflow.set\_sim\_mode module ------------------------------------------------------- - -.. automodule:: finn.transformation.fpgadataflow.set_sim_mode - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.fpgadataflow.synth\_pynq\_proj module ---------------------------------------------------------- - -.. automodule:: finn.transformation.fpgadataflow.synth_pynq_proj - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.fpgadataflow.templates module -------------------------------------------------- - -.. automodule:: finn.transformation.fpgadataflow.templates - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: finn.transformation.fpgadataflow - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/finn.transformation.rst.txt b/docs/finn/_build/html/_sources/finn.transformation.rst.txt deleted file mode 100644 index 172f6e300f3894dba3b13355120bcb4e23d737e1..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/finn.transformation.rst.txt +++ /dev/null @@ -1,70 +0,0 @@ -finn.transformation package -=========================== - -Subpackages ------------ - -.. toctree:: - - finn.transformation.fpgadataflow - finn.transformation.streamline - -Submodules ----------- - -finn.transformation.batchnorm\_to\_affine module ------------------------------------------------- - -.. automodule:: finn.transformation.batchnorm_to_affine - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.bipolar\_to\_xnor module --------------------------------------------- - -.. automodule:: finn.transformation.bipolar_to_xnor - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.fold\_constants module ------------------------------------------- - -.. automodule:: finn.transformation.fold_constants - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.general module ----------------------------------- - -.. automodule:: finn.transformation.general - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.infer\_datatypes module -------------------------------------------- - -.. automodule:: finn.transformation.infer_datatypes - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.infer\_shapes module ----------------------------------------- - -.. automodule:: finn.transformation.infer_shapes - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: finn.transformation - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/finn.transformation.streamline.rst.txt b/docs/finn/_build/html/_sources/finn.transformation.streamline.rst.txt deleted file mode 100644 index 33e5930952e01881dfb7e1b19eae11ebc25ac4e0..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/finn.transformation.streamline.rst.txt +++ /dev/null @@ -1,54 +0,0 @@ -finn.transformation.streamline package -====================================== - -Submodules ----------- - -finn.transformation.streamline.absorb module --------------------------------------------- - -.. automodule:: finn.transformation.streamline.absorb - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.streamline.collapse\_repeated module --------------------------------------------------------- - -.. automodule:: finn.transformation.streamline.collapse_repeated - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.streamline.reorder module ---------------------------------------------- - -.. automodule:: finn.transformation.streamline.reorder - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.streamline.round\_thresholds module -------------------------------------------------------- - -.. automodule:: finn.transformation.streamline.round_thresholds - :members: - :undoc-members: - :show-inheritance: - -finn.transformation.streamline.sign\_to\_thres module ------------------------------------------------------ - -.. automodule:: finn.transformation.streamline.sign_to_thres - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: finn.transformation.streamline - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/finn.util.rst.txt b/docs/finn/_build/html/_sources/finn.util.rst.txt deleted file mode 100644 index 1c85bcd44b63343ecab12ee12ba82c83d4fc984d..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/finn.util.rst.txt +++ /dev/null @@ -1,54 +0,0 @@ -finn.util package -================= - -Submodules ----------- - -finn.util.basic module ----------------------- - -.. automodule:: finn.util.basic - :members: - :undoc-members: - :show-inheritance: - -finn.util.data\_packing module ------------------------------- - -.. automodule:: finn.util.data_packing - :members: - :undoc-members: - :show-inheritance: - -finn.util.fpgadataflow module ------------------------------ - -.. automodule:: finn.util.fpgadataflow - :members: - :undoc-members: - :show-inheritance: - -finn.util.onnx module ---------------------- - -.. automodule:: finn.util.onnx - :members: - :undoc-members: - :show-inheritance: - -finn.util.test module ---------------------- - -.. automodule:: finn.util.test - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: finn.util - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/modules.rst.txt b/docs/finn/_build/html/_sources/modules.rst.txt index e9ff8ac1a89c7bd18e69d633121f5a4022ac6fdf..8355e03eefd869e41e11291dfcafb540e93d1b21 100644 --- a/docs/finn/_build/html/_sources/modules.rst.txt +++ b/docs/finn/_build/html/_sources/modules.rst.txt @@ -1,7 +1,7 @@ -src +finn === .. toctree:: :maxdepth: 4 - src + finn diff --git a/docs/finn/_build/html/_sources/source_code/analysis.fpgadataflow.rst.txt b/docs/finn/_build/html/_sources/source_code/analysis.fpgadataflow.rst.txt deleted file mode 100644 index ca0e9b63f6d41ec5cdd7c473712191b51bdc08cd..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/analysis.fpgadataflow.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -analysis.fpgadataflow package -============================= - -Submodules ----------- - -analysis.fpgadataflow.hls\_synth\_res\_estimation module --------------------------------------------------------- - -.. automodule:: analysis.fpgadataflow.hls_synth_res_estimation - :members: - :undoc-members: - :show-inheritance: - -analysis.fpgadataflow.res\_estimation module --------------------------------------------- - -.. automodule:: analysis.fpgadataflow.res_estimation - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: analysis.fpgadataflow - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/analysis.rst.txt b/docs/finn/_build/html/_sources/source_code/analysis.rst.txt deleted file mode 100644 index ef56533e789d92714017f5963e60abc8ebcd0422..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/analysis.rst.txt +++ /dev/null @@ -1,10 +0,0 @@ -analysis package -================ - -Subpackages ------------ - -.. toctree:: - - analysis.fpgadataflow.rst - diff --git a/docs/finn/_build/html/_sources/source_code/analysis/analysis.fpgadataflow.rst.txt b/docs/finn/_build/html/_sources/source_code/analysis/analysis.fpgadataflow.rst.txt deleted file mode 100644 index ca0e9b63f6d41ec5cdd7c473712191b51bdc08cd..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/analysis/analysis.fpgadataflow.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -analysis.fpgadataflow package -============================= - -Submodules ----------- - -analysis.fpgadataflow.hls\_synth\_res\_estimation module --------------------------------------------------------- - -.. automodule:: analysis.fpgadataflow.hls_synth_res_estimation - :members: - :undoc-members: - :show-inheritance: - -analysis.fpgadataflow.res\_estimation module --------------------------------------------- - -.. automodule:: analysis.fpgadataflow.res_estimation - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: analysis.fpgadataflow - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/analysis/analysis.rst.txt b/docs/finn/_build/html/_sources/source_code/analysis/analysis.rst.txt deleted file mode 100644 index af9d2dc6de5515d7afc3688d406ef64366040fca..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/analysis/analysis.rst.txt +++ /dev/null @@ -1,37 +0,0 @@ -analysis package -================ - -Subpackages ------------ - -.. toctree:: - - analysis.fpgadataflow - -Submodules ----------- - -analysis.topology module ------------------------- - -.. automodule:: analysis.topology - :members: - :undoc-members: - :show-inheritance: - -analysis.verify\_custom\_nodes module -------------------------------------- - -.. automodule:: analysis.verify_custom_nodes - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: analysis - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.rst.txt deleted file mode 100644 index 616064c16dfb61e9d66d7a8f9e76addd48e93ef9..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.analysis.fpgadataflow.hls\_synth\_res\_estimation module -============================================================= - -.. automodule:: finn.analysis.fpgadataflow.hls_synth_res_estimation - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.analysis.fpgadataflow.res_estimation.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.analysis.fpgadataflow.res_estimation.rst.txt deleted file mode 100644 index eb5b773b123cc686116313d1043b668601fc229f..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.analysis.fpgadataflow.res_estimation.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.analysis.fpgadataflow.res\_estimation module -================================================= - -.. automodule:: finn.analysis.fpgadataflow.res_estimation - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.analysis.topology.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.analysis.topology.rst.txt deleted file mode 100644 index 896f3fb8d704c23a58f10f9513fd00ca7f7b99b0..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.analysis.topology.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.analysis.topology module -============================= - -.. automodule:: finn.analysis.topology - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.analysis.verify_custom_nodes.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.analysis.verify_custom_nodes.rst.txt deleted file mode 100644 index 60e1a33e25e6f8751aadd3e0181225af6e24e779..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.analysis.verify_custom_nodes.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.analysis.verify\_custom\_nodes module -========================================== - -.. automodule:: finn.analysis.verify_custom_nodes - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.core.datatype.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.core.datatype.rst.txt deleted file mode 100644 index d55952ecf81556365510a3191f2b2a75a6873f72..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.core.datatype.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.core.datatype module -========================= - -.. automodule:: finn.core.datatype - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.core.execute_custom_node.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.core.execute_custom_node.rst.txt deleted file mode 100644 index 94d8ea143fadf32caf874036d6f652de9561bc1f..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.core.execute_custom_node.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.core.execute\_custom\_node module -====================================== - -.. automodule:: finn.core.execute_custom_node - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.core.modelwrapper.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.core.modelwrapper.rst.txt deleted file mode 100644 index 5bd74864ba63eda5b8a03093d02a6c54dabda973..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.core.modelwrapper.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.core.modelwrapper module -============================= - -.. automodule:: finn.core.modelwrapper - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.core.onnx_exec.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.core.onnx_exec.rst.txt deleted file mode 100644 index 87bf9d29dcf450d92529ce7987df8f59832ddd1a..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.core.onnx_exec.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.core.onnx\_exec module -=========================== - -.. automodule:: finn.core.onnx_exec - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.core.remote_exec.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.core.remote_exec.rst.txt deleted file mode 100644 index 39c470eb0e4cc32c4d604dc3df7a7c9a51532d27..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.core.remote_exec.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.core.remote\_exec module -============================= - -.. automodule:: finn.core.remote_exec - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.core.rtlsim_exec.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.core.rtlsim_exec.rst.txt deleted file mode 100644 index 9d4acef6e8a61b537280ab441d7bb0bbf48158cf..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.core.rtlsim_exec.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.core.rtlsim\_exec module -============================= - -.. automodule:: finn.core.rtlsim_exec - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.rst.txt deleted file mode 100644 index aa36e86ee210e242ae7fd3e8447bb23663a7eb2c..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.custom\_op.fpgadataflow.convolutioninputgenerator module -============================================================= - -.. automodule:: finn.custom_op.fpgadataflow.convolutioninputgenerator - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.rst.txt deleted file mode 100644 index 45a9a963a5a36e5152ff77dbe6b8ec08b1f60611..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.custom\_op.fpgadataflow.streamingfclayer\_batch module -=========================================================== - -.. automodule:: finn.custom_op.fpgadataflow.streamingfclayer_batch - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.rst.txt deleted file mode 100644 index 5bf7f666a42188a8a0e6ae2369d94fe2881694e9..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.custom\_op.fpgadataflow.streamingmaxpool\_batch module -=========================================================== - -.. automodule:: finn.custom_op.fpgadataflow.streamingmaxpool_batch - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.templates.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.templates.rst.txt deleted file mode 100644 index a630867a416a59c0d9b789289b48a930c6aca253..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.templates.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.custom\_op.fpgadataflow.templates module -============================================= - -.. automodule:: finn.custom_op.fpgadataflow.templates - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.tlastmarker.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.tlastmarker.rst.txt deleted file mode 100644 index 8a087851c655080c70b434028fdae4315bd69f57..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.tlastmarker.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.custom\_op.fpgadataflow.tlastmarker module -=============================================== - -.. automodule:: finn.custom_op.fpgadataflow.tlastmarker - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.custom_op.multithreshold.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.custom_op.multithreshold.rst.txt deleted file mode 100644 index 3cdf3cee7259a98c3e9bc95d2b1833a03fcfad98..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.custom_op.multithreshold.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.custom\_op.multithreshold module -===================================== - -.. automodule:: finn.custom_op.multithreshold - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.custom_op.registry.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.custom_op.registry.rst.txt deleted file mode 100644 index 7805e833b8d19b4a99de2466ce164e81911c179c..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.custom_op.registry.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.custom\_op.registry module -=============================== - -.. automodule:: finn.custom_op.registry - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.custom_op.streamingdataflowpartition.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.custom_op.streamingdataflowpartition.rst.txt deleted file mode 100644 index 1d07f01ce187842777676949195765bd7f841e6e..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.custom_op.streamingdataflowpartition.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.custom\_op.streamingdataflowpartition module -================================================= - -.. automodule:: finn.custom_op.streamingdataflowpartition - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.custom_op.xnorpopcount.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.custom_op.xnorpopcount.rst.txt deleted file mode 100644 index d916082782081f7ef2fb3fe02070abf4baf8e03f..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.custom_op.xnorpopcount.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.custom\_op.xnorpopcount module -=================================== - -.. automodule:: finn.custom_op.xnorpopcount - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.batchnorm_to_affine.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.batchnorm_to_affine.rst.txt deleted file mode 100644 index 8d0ecfb75c7c6af460ff7d96a1dd45d008bc50ef..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.batchnorm_to_affine.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.batchnorm\_to\_affine module -================================================ - -.. automodule:: finn.transformation.batchnorm_to_affine - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.bipolar_to_xnor.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.bipolar_to_xnor.rst.txt deleted file mode 100644 index dc34f4def8d87339c3dc6d6a69ea97238f449ecd..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.bipolar_to_xnor.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.bipolar\_to\_xnor module -============================================ - -.. automodule:: finn.transformation.bipolar_to_xnor - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.fold_constants.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.fold_constants.rst.txt deleted file mode 100644 index 792f8bfe03d04735c9571a8016ecc941a88ffd25..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.fold_constants.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.fold\_constants module -========================================== - -.. automodule:: finn.transformation.fold_constants - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.cleanup.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.cleanup.rst.txt deleted file mode 100644 index 38cc49897e6d52dfdc8e4c4694458ff3df81e6f1..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.cleanup.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.fpgadataflow.cleanup module -=============================================== - -.. automodule:: finn.transformation.fpgadataflow.cleanup - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.codegen_ipgen.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.codegen_ipgen.rst.txt deleted file mode 100644 index 158ad7602cfa17fe3c6c1e0232b46d6a0c1743ce..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.codegen_ipgen.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.fpgadataflow.codegen\_ipgen module -====================================================== - -.. automodule:: finn.transformation.fpgadataflow.codegen_ipgen - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.codegen_ipstitch.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.codegen_ipstitch.rst.txt deleted file mode 100644 index d3f7434e3b02759206119ee08591a7494e7307ad..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.codegen_ipstitch.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.fpgadataflow.codegen\_ipstitch module -========================================================= - -.. automodule:: finn.transformation.fpgadataflow.codegen_ipstitch - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.codegen_npysim.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.codegen_npysim.rst.txt deleted file mode 100644 index 28796da29a9f01ba47d2c5236db01f639f653d3b..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.codegen_npysim.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.fpgadataflow.codegen\_npysim module -======================================================= - -.. automodule:: finn.transformation.fpgadataflow.codegen_npysim - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.compile.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.compile.rst.txt deleted file mode 100644 index 3d36a046be002093b813b0b97539b869f115ba77..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.compile.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.fpgadataflow.compile module -=============================================== - -.. automodule:: finn.transformation.fpgadataflow.compile - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.rst.txt deleted file mode 100644 index 0ae11a41bf3e3720fa97dfda2406af9ce67327a8..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.fpgadataflow.convert\_to\_hls\_layers module -================================================================ - -.. automodule:: finn.transformation.fpgadataflow.convert_to_hls_layers - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.create_dataflow_partition.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.create_dataflow_partition.rst.txt deleted file mode 100644 index 4827fd5b2cc335fba321835f472da6dfd1e821af..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.create_dataflow_partition.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.fpgadataflow.create\_dataflow\_partition module -=================================================================== - -.. automodule:: finn.transformation.fpgadataflow.create_dataflow_partition - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.rst.txt deleted file mode 100644 index 47af9049f0f77e66343868d877ab43d6a03ef299..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.fpgadataflow.hlssynth\_ipgen module -======================================================= - -.. automodule:: finn.transformation.fpgadataflow.hlssynth_ipgen - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.insert_tlastmarker.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.insert_tlastmarker.rst.txt deleted file mode 100644 index d4bd00b8c3e3467df421f0efb9fd993851d5e44d..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.insert_tlastmarker.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.fpgadataflow.insert\_tlastmarker module -=========================================================== - -.. automodule:: finn.transformation.fpgadataflow.insert_tlastmarker - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.make_deployment.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.make_deployment.rst.txt deleted file mode 100644 index 130c91989090a9b1d73d12e413227c8008161930..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.make_deployment.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.fpgadataflow.make\_deployment module -======================================================== - -.. automodule:: finn.transformation.fpgadataflow.make_deployment - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.make_pynq_driver.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.make_pynq_driver.rst.txt deleted file mode 100644 index 5238f08460a4ff9580273891461e2a3409605834..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.make_pynq_driver.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.fpgadataflow.make\_pynq\_driver module -========================================================== - -.. automodule:: finn.transformation.fpgadataflow.make_pynq_driver - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.make_pynq_proj.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.make_pynq_proj.rst.txt deleted file mode 100644 index 1d040887f9a2ab2d33bf4ff9ea69ac835cbba8a7..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.make_pynq_proj.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.fpgadataflow.make\_pynq\_proj module -======================================================== - -.. automodule:: finn.transformation.fpgadataflow.make_pynq_proj - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.set_exec_mode.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.set_exec_mode.rst.txt deleted file mode 100644 index 7affa78b43e253b781deffce3044d9ca46319b96..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.set_exec_mode.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.fpgadataflow.set\_exec\_mode module -======================================================= - -.. automodule:: finn.transformation.fpgadataflow.set_exec_mode - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.synth_pynq_proj.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.synth_pynq_proj.rst.txt deleted file mode 100644 index e902991a6920a7bf4617814df95ced28a7cd268c..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.synth_pynq_proj.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.fpgadataflow.synth\_pynq\_proj module -========================================================= - -.. automodule:: finn.transformation.fpgadataflow.synth_pynq_proj - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.templates.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.templates.rst.txt deleted file mode 100644 index a62f377830c8661f9a7f106e19d3c203a8019d81..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.templates.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.fpgadataflow.templates module -================================================= - -.. automodule:: finn.transformation.fpgadataflow.templates - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.general.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.general.rst.txt deleted file mode 100644 index bfae28100b9e91d5b1d0b728d410a6ec472bc4d4..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.general.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.general module -================================== - -.. automodule:: finn.transformation.general - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.infer_datatypes.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.infer_datatypes.rst.txt deleted file mode 100644 index 939d1552157f21b451f4b583ade611b3ae41ab5d..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.infer_datatypes.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.infer\_datatypes module -=========================================== - -.. automodule:: finn.transformation.infer_datatypes - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.infer_shapes.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.infer_shapes.rst.txt deleted file mode 100644 index 9469557061e450ba356c96f615a1f438be878047..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.infer_shapes.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.infer\_shapes module -======================================== - -.. automodule:: finn.transformation.infer_shapes - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.absorb.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.absorb.rst.txt deleted file mode 100644 index 597a98944b984b1c51b978f8986e300369b533cd..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.absorb.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.streamline.absorb module -============================================ - -.. automodule:: finn.transformation.streamline.absorb - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.collapse_repeated.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.collapse_repeated.rst.txt deleted file mode 100644 index a15f72aea74e99f5beef9109f06e2afa38de6619..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.collapse_repeated.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.streamline.collapse\_repeated module -======================================================== - -.. automodule:: finn.transformation.streamline.collapse_repeated - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.reorder.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.reorder.rst.txt deleted file mode 100644 index ac969e1329f444f48df00f7101b5cd1e3da5c363..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.reorder.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.streamline.reorder module -============================================= - -.. automodule:: finn.transformation.streamline.reorder - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.round_thresholds.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.round_thresholds.rst.txt deleted file mode 100644 index 031c65d077f63a3f120211e2ab122c291c5a96e1..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.round_thresholds.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.streamline.round\_thresholds module -======================================================= - -.. automodule:: finn.transformation.streamline.round_thresholds - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.sign_to_thres.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.sign_to_thres.rst.txt deleted file mode 100644 index 166717eb352ed0044ad817dc36409a1860f3789c..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.sign_to_thres.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.transformation.streamline.sign\_to\_thres module -===================================================== - -.. automodule:: finn.transformation.streamline.sign_to_thres - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.util.basic.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.util.basic.rst.txt deleted file mode 100644 index 10e8e1ac1c9e9f7f449ce8f3a413424c529b3fa1..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.util.basic.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.util.basic module -====================== - -.. automodule:: finn.util.basic - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.util.data_packing.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.util.data_packing.rst.txt deleted file mode 100644 index 6a39cc14b157646fc5305674a18b250d4a0b0946..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.util.data_packing.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.util.data\_packing module -============================== - -.. automodule:: finn.util.data_packing - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.util.fpgadataflow.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.util.fpgadataflow.rst.txt deleted file mode 100644 index 3472ed477b9680baa99a91ce70850bedc79daf6b..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.util.fpgadataflow.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.util.fpgadataflow module -============================= - -.. automodule:: finn.util.fpgadataflow - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.util.onnx.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.util.onnx.rst.txt deleted file mode 100644 index 057cb07cadcaf5819b21bb61878b0964eecbdace..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.util.onnx.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.util.onnx module -===================== - -.. automodule:: finn.util.onnx - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/source_code/finn.util.test.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.util.test.rst.txt deleted file mode 100644 index 3fe1bc15e529a36546a589b0b43f26dee58b4511..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/source_code/finn.util.test.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -finn.util.test module -===================== - -.. automodule:: finn.util.test - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/src.finn.analysis.fpgadataflow.rst.txt b/docs/finn/_build/html/_sources/src.finn.analysis.fpgadataflow.rst.txt deleted file mode 100644 index 6f717813fff0870911a3d7a118b974eb4122b435..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/src.finn.analysis.fpgadataflow.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -src.finn.analysis.fpgadataflow package -====================================== - -Submodules ----------- - -src.finn.analysis.fpgadataflow.hls\_synth\_res\_estimation module ------------------------------------------------------------------ - -.. automodule:: src.finn.analysis.fpgadataflow.hls_synth_res_estimation - :members: - :undoc-members: - :show-inheritance: - -src.finn.analysis.fpgadataflow.res\_estimation module ------------------------------------------------------ - -.. automodule:: src.finn.analysis.fpgadataflow.res_estimation - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: src.finn.analysis.fpgadataflow - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/src.finn.analysis.rst.txt b/docs/finn/_build/html/_sources/src.finn.analysis.rst.txt deleted file mode 100644 index 2dbedcf70ee0cc1f1453b10720aa15dc5067a8de..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/src.finn.analysis.rst.txt +++ /dev/null @@ -1,37 +0,0 @@ -src.finn.analysis package -========================= - -Subpackages ------------ - -.. toctree:: - - src.finn.analysis.fpgadataflow - -Submodules ----------- - -src.finn.analysis.topology module ---------------------------------- - -.. automodule:: src.finn.analysis.topology - :members: - :undoc-members: - :show-inheritance: - -src.finn.analysis.verify\_custom\_nodes module ----------------------------------------------- - -.. automodule:: src.finn.analysis.verify_custom_nodes - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: src.finn.analysis - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/src.finn.core.rst.txt b/docs/finn/_build/html/_sources/src.finn.core.rst.txt deleted file mode 100644 index 70e442567ec0c50db787ff8a7d0be7d0b1ca2200..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/src.finn.core.rst.txt +++ /dev/null @@ -1,46 +0,0 @@ -src.finn.core package -===================== - -Submodules ----------- - -src.finn.core.datatype module ------------------------------ - -.. automodule:: src.finn.core.datatype - :members: - :undoc-members: - :show-inheritance: - -src.finn.core.execute\_custom\_node module ------------------------------------------- - -.. automodule:: src.finn.core.execute_custom_node - :members: - :undoc-members: - :show-inheritance: - -src.finn.core.modelwrapper module ---------------------------------- - -.. automodule:: src.finn.core.modelwrapper - :members: - :undoc-members: - :show-inheritance: - -src.finn.core.onnx\_exec module -------------------------------- - -.. automodule:: src.finn.core.onnx_exec - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: src.finn.core - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/src.finn.custom_op.fpgadataflow.rst.txt b/docs/finn/_build/html/_sources/src.finn.custom_op.fpgadataflow.rst.txt deleted file mode 100644 index 540114318680667a00fcd6591c8ef524c814dbd1..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/src.finn.custom_op.fpgadataflow.rst.txt +++ /dev/null @@ -1,54 +0,0 @@ -src.finn.custom\_op.fpgadataflow package -======================================== - -Submodules ----------- - -src.finn.custom\_op.fpgadataflow.convolutioninputgenerator module ------------------------------------------------------------------ - -.. automodule:: src.finn.custom_op.fpgadataflow.convolutioninputgenerator - :members: - :undoc-members: - :show-inheritance: - -src.finn.custom\_op.fpgadataflow.streamingfclayer\_batch module ---------------------------------------------------------------- - -.. automodule:: src.finn.custom_op.fpgadataflow.streamingfclayer_batch - :members: - :undoc-members: - :show-inheritance: - -src.finn.custom\_op.fpgadataflow.streamingmaxpool\_batch module ---------------------------------------------------------------- - -.. automodule:: src.finn.custom_op.fpgadataflow.streamingmaxpool_batch - :members: - :undoc-members: - :show-inheritance: - -src.finn.custom\_op.fpgadataflow.templates module -------------------------------------------------- - -.. automodule:: src.finn.custom_op.fpgadataflow.templates - :members: - :undoc-members: - :show-inheritance: - -src.finn.custom\_op.fpgadataflow.tlastmarker module ---------------------------------------------------- - -.. automodule:: src.finn.custom_op.fpgadataflow.tlastmarker - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: src.finn.custom_op.fpgadataflow - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/src.finn.custom_op.rst.txt b/docs/finn/_build/html/_sources/src.finn.custom_op.rst.txt deleted file mode 100644 index 0a9536a5e2705dc9b59be80fb4296feb0cd94c3c..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/src.finn.custom_op.rst.txt +++ /dev/null @@ -1,53 +0,0 @@ -src.finn.custom\_op package -=========================== - -Subpackages ------------ - -.. toctree:: - - src.finn.custom_op.fpgadataflow - -Submodules ----------- - -src.finn.custom\_op.multithreshold module ------------------------------------------ - -.. automodule:: src.finn.custom_op.multithreshold - :members: - :undoc-members: - :show-inheritance: - -src.finn.custom\_op.registry module ------------------------------------ - -.. automodule:: src.finn.custom_op.registry - :members: - :undoc-members: - :show-inheritance: - -src.finn.custom\_op.streamingdataflowpartition module ------------------------------------------------------ - -.. automodule:: src.finn.custom_op.streamingdataflowpartition - :members: - :undoc-members: - :show-inheritance: - -src.finn.custom\_op.xnorpopcount module ---------------------------------------- - -.. automodule:: src.finn.custom_op.xnorpopcount - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: src.finn.custom_op - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/src.finn.rst.txt b/docs/finn/_build/html/_sources/src.finn.rst.txt deleted file mode 100644 index 26a1246873a24252691c897a5b048979b93bf196..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/src.finn.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -src.finn package -================ - -Subpackages ------------ - -.. toctree:: - - src.finn.analysis - src.finn.core - src.finn.custom_op - src.finn.transformation - src.finn.util - -Module contents ---------------- - -.. automodule:: src.finn - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/src.finn.transformation.fpgadataflow.rst.txt b/docs/finn/_build/html/_sources/src.finn.transformation.fpgadataflow.rst.txt deleted file mode 100644 index c7f2b3e943c9f5ca18b89e89066edf1eb8a24a28..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/src.finn.transformation.fpgadataflow.rst.txt +++ /dev/null @@ -1,134 +0,0 @@ -src.finn.transformation.fpgadataflow package -============================================ - -Submodules ----------- - -src.finn.transformation.fpgadataflow.cleanup module ---------------------------------------------------- - -.. automodule:: src.finn.transformation.fpgadataflow.cleanup - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.fpgadataflow.codegen\_ipgen module ----------------------------------------------------------- - -.. automodule:: src.finn.transformation.fpgadataflow.codegen_ipgen - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.fpgadataflow.codegen\_ipstitch module -------------------------------------------------------------- - -.. automodule:: src.finn.transformation.fpgadataflow.codegen_ipstitch - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.fpgadataflow.codegen\_npysim module ------------------------------------------------------------ - -.. automodule:: src.finn.transformation.fpgadataflow.codegen_npysim - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.fpgadataflow.compile module ---------------------------------------------------- - -.. automodule:: src.finn.transformation.fpgadataflow.compile - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.fpgadataflow.convert\_to\_hls\_layers module --------------------------------------------------------------------- - -.. automodule:: src.finn.transformation.fpgadataflow.convert_to_hls_layers - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.fpgadataflow.create\_dataflow\_partition module ------------------------------------------------------------------------ - -.. automodule:: src.finn.transformation.fpgadataflow.create_dataflow_partition - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.fpgadataflow.hlssynth\_ipgen module ------------------------------------------------------------ - -.. automodule:: src.finn.transformation.fpgadataflow.hlssynth_ipgen - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.fpgadataflow.insert\_tlastmarker module ---------------------------------------------------------------- - -.. automodule:: src.finn.transformation.fpgadataflow.insert_tlastmarker - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.fpgadataflow.make\_deployment module ------------------------------------------------------------- - -.. automodule:: src.finn.transformation.fpgadataflow.make_deployment - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.fpgadataflow.make\_pynq\_driver module --------------------------------------------------------------- - -.. automodule:: src.finn.transformation.fpgadataflow.make_pynq_driver - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.fpgadataflow.make\_pynq\_proj module ------------------------------------------------------------- - -.. automodule:: src.finn.transformation.fpgadataflow.make_pynq_proj - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.fpgadataflow.set\_sim\_mode module ----------------------------------------------------------- - -.. automodule:: src.finn.transformation.fpgadataflow.set_sim_mode - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.fpgadataflow.synth\_pynq\_proj module -------------------------------------------------------------- - -.. automodule:: src.finn.transformation.fpgadataflow.synth_pynq_proj - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.fpgadataflow.templates module ------------------------------------------------------ - -.. automodule:: src.finn.transformation.fpgadataflow.templates - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: src.finn.transformation.fpgadataflow - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/src.finn.transformation.rst.txt b/docs/finn/_build/html/_sources/src.finn.transformation.rst.txt deleted file mode 100644 index a73e18cca9df2b1aea051395dc0fe4722f9b1cf8..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/src.finn.transformation.rst.txt +++ /dev/null @@ -1,70 +0,0 @@ -src.finn.transformation package -=============================== - -Subpackages ------------ - -.. toctree:: - - src.finn.transformation.fpgadataflow - src.finn.transformation.streamline - -Submodules ----------- - -src.finn.transformation.batchnorm\_to\_affine module ----------------------------------------------------- - -.. automodule:: src.finn.transformation.batchnorm_to_affine - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.bipolar\_to\_xnor module ------------------------------------------------- - -.. automodule:: src.finn.transformation.bipolar_to_xnor - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.fold\_constants module ----------------------------------------------- - -.. automodule:: src.finn.transformation.fold_constants - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.general module --------------------------------------- - -.. automodule:: src.finn.transformation.general - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.infer\_datatypes module ------------------------------------------------ - -.. automodule:: src.finn.transformation.infer_datatypes - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.infer\_shapes module --------------------------------------------- - -.. automodule:: src.finn.transformation.infer_shapes - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: src.finn.transformation - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/src.finn.transformation.streamline.rst.txt b/docs/finn/_build/html/_sources/src.finn.transformation.streamline.rst.txt deleted file mode 100644 index 3e765e8ef32dfcc6a2066c2c19dcb6c973c7ed9e..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/src.finn.transformation.streamline.rst.txt +++ /dev/null @@ -1,54 +0,0 @@ -src.finn.transformation.streamline package -========================================== - -Submodules ----------- - -src.finn.transformation.streamline.absorb module ------------------------------------------------- - -.. automodule:: src.finn.transformation.streamline.absorb - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.streamline.collapse\_repeated module ------------------------------------------------------------- - -.. automodule:: src.finn.transformation.streamline.collapse_repeated - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.streamline.reorder module -------------------------------------------------- - -.. automodule:: src.finn.transformation.streamline.reorder - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.streamline.round\_thresholds module ------------------------------------------------------------ - -.. automodule:: src.finn.transformation.streamline.round_thresholds - :members: - :undoc-members: - :show-inheritance: - -src.finn.transformation.streamline.sign\_to\_thres module ---------------------------------------------------------- - -.. automodule:: src.finn.transformation.streamline.sign_to_thres - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: src.finn.transformation.streamline - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/src.finn.util.rst.txt b/docs/finn/_build/html/_sources/src.finn.util.rst.txt deleted file mode 100644 index 62daf6581ef608b04f2c810c79754429276a61ae..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/src.finn.util.rst.txt +++ /dev/null @@ -1,54 +0,0 @@ -src.finn.util package -===================== - -Submodules ----------- - -src.finn.util.basic module --------------------------- - -.. automodule:: src.finn.util.basic - :members: - :undoc-members: - :show-inheritance: - -src.finn.util.data\_packing module ----------------------------------- - -.. automodule:: src.finn.util.data_packing - :members: - :undoc-members: - :show-inheritance: - -src.finn.util.fpgadataflow module ---------------------------------- - -.. automodule:: src.finn.util.fpgadataflow - :members: - :undoc-members: - :show-inheritance: - -src.finn.util.onnx module -------------------------- - -.. automodule:: src.finn.util.onnx - :members: - :undoc-members: - :show-inheritance: - -src.finn.util.test module -------------------------- - -.. automodule:: src.finn.util.test - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: src.finn.util - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_sources/src.rst.txt b/docs/finn/_build/html/_sources/src.rst.txt deleted file mode 100644 index 3a42b4fb4de306ba47aabe59e63baba804849406..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_sources/src.rst.txt +++ /dev/null @@ -1,17 +0,0 @@ -src package -=========== - -Subpackages ------------ - -.. toctree:: - - src.finn - -Module contents ---------------- - -.. automodule:: src - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/finn/_build/html/_static/alabaster.css b/docs/finn/_build/html/_static/alabaster.css deleted file mode 100644 index 0eddaeb07d19bffb50884d7bd7996418b6461a09..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_static/alabaster.css +++ /dev/null @@ -1,701 +0,0 @@ -@import url("basic.css"); - -/* -- page layout ----------------------------------------------------------- */ - -body { - font-family: Georgia, serif; - font-size: 17px; - background-color: #fff; - color: #000; - margin: 0; - padding: 0; -} - - -div.document { - width: 940px; - margin: 30px auto 0 auto; -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - margin: 0 0 0 220px; -} - -div.sphinxsidebar { - width: 220px; - font-size: 14px; - line-height: 1.5; -} - -hr { - border: 1px solid #B1B4B6; -} - -div.body { - background-color: #fff; - color: #3E4349; - padding: 0 30px 0 30px; -} - -div.body > .section { - text-align: left; -} - -div.footer { - width: 940px; - margin: 20px auto 30px auto; - font-size: 14px; - color: #888; - text-align: right; -} - -div.footer a { - color: #888; -} - -p.caption { - font-family: inherit; - font-size: inherit; -} - - -div.relations { - display: none; -} - - -div.sphinxsidebar a { - color: #444; - text-decoration: none; - border-bottom: 1px dotted #999; -} - -div.sphinxsidebar a:hover { - border-bottom: 1px solid #999; -} - -div.sphinxsidebarwrapper { - padding: 18px 10px; -} - -div.sphinxsidebarwrapper p.logo { - padding: 0; - margin: -10px 0 0 0px; - text-align: center; -} - -div.sphinxsidebarwrapper h1.logo { - margin-top: -10px; - text-align: center; - margin-bottom: 5px; - text-align: left; -} - -div.sphinxsidebarwrapper h1.logo-name { - margin-top: 0px; -} - -div.sphinxsidebarwrapper p.blurb { - margin-top: 0; - font-style: normal; -} - -div.sphinxsidebar h3, -div.sphinxsidebar h4 { - font-family: Georgia, serif; - color: #444; - font-size: 24px; - font-weight: normal; - margin: 0 0 5px 0; - padding: 0; -} - -div.sphinxsidebar h4 { - font-size: 20px; -} - -div.sphinxsidebar h3 a { - color: #444; -} - -div.sphinxsidebar p.logo a, -div.sphinxsidebar h3 a, -div.sphinxsidebar p.logo a:hover, -div.sphinxsidebar h3 a:hover { - border: none; -} - -div.sphinxsidebar p { - color: #555; - margin: 10px 0; -} - -div.sphinxsidebar ul { - margin: 10px 0; - padding: 0; - color: #000; -} - -div.sphinxsidebar ul li.toctree-l1 > a { - font-size: 120%; -} - -div.sphinxsidebar ul li.toctree-l2 > a { - font-size: 110%; -} - -div.sphinxsidebar input { - border: 1px solid #CCC; - font-family: Georgia, serif; - font-size: 1em; -} - -div.sphinxsidebar hr { - border: none; - height: 1px; - color: #AAA; - background: #AAA; - - text-align: left; - margin-left: 0; - width: 50%; -} - -div.sphinxsidebar .badge { - border-bottom: none; -} - -div.sphinxsidebar .badge:hover { - border-bottom: none; -} - -/* To address an issue with donation coming after search */ -div.sphinxsidebar h3.donation { - margin-top: 10px; -} - -/* -- body styles ----------------------------------------------------------- */ - -a { - color: #004B6B; - text-decoration: underline; -} - -a:hover { - color: #6D4100; - text-decoration: underline; -} - -div.body h1, -div.body h2, -div.body h3, -div.body h4, -div.body h5, -div.body h6 { - font-family: Georgia, serif; - font-weight: normal; - margin: 30px 0px 10px 0px; - padding: 0; -} - -div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } -div.body h2 { font-size: 180%; } -div.body h3 { font-size: 150%; } -div.body h4 { font-size: 130%; } -div.body h5 { font-size: 100%; } -div.body h6 { font-size: 100%; } - -a.headerlink { - color: #DDD; - padding: 0 4px; - text-decoration: none; -} - -a.headerlink:hover { - color: #444; - background: #EAEAEA; -} - -div.body p, div.body dd, div.body li { - line-height: 1.4em; -} - -div.admonition { - margin: 20px 0px; - padding: 10px 30px; - background-color: #EEE; - border: 1px solid #CCC; -} - -div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { - background-color: #FBFBFB; - border-bottom: 1px solid #fafafa; -} - -div.admonition p.admonition-title { - font-family: Georgia, serif; - font-weight: normal; - font-size: 24px; - margin: 0 0 10px 0; - padding: 0; - line-height: 1; -} - -div.admonition p.last { - margin-bottom: 0; -} - -div.highlight { - background-color: #fff; -} - -dt:target, .highlight { - background: #FAF3E8; -} - -div.warning { - background-color: #FCC; - border: 1px solid #FAA; -} - -div.danger { - background-color: #FCC; - border: 1px solid #FAA; - -moz-box-shadow: 2px 2px 4px #D52C2C; - -webkit-box-shadow: 2px 2px 4px #D52C2C; - box-shadow: 2px 2px 4px #D52C2C; -} - -div.error { - background-color: #FCC; - border: 1px solid #FAA; - -moz-box-shadow: 2px 2px 4px #D52C2C; - -webkit-box-shadow: 2px 2px 4px #D52C2C; - box-shadow: 2px 2px 4px #D52C2C; -} - -div.caution { - background-color: #FCC; - border: 1px solid #FAA; -} - -div.attention { - background-color: #FCC; - border: 1px solid #FAA; -} - -div.important { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.note { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.tip { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.hint { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.seealso { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.topic { - background-color: #EEE; -} - -p.admonition-title { - display: inline; -} - -p.admonition-title:after { - content: ":"; -} - -pre, tt, code { - font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; - font-size: 0.9em; -} - -.hll { - background-color: #FFC; - margin: 0 -12px; - padding: 0 12px; - display: block; -} - -img.screenshot { -} - -tt.descname, tt.descclassname, code.descname, code.descclassname { - font-size: 0.95em; -} - -tt.descname, code.descname { - padding-right: 0.08em; -} - -img.screenshot { - -moz-box-shadow: 2px 2px 4px #EEE; - -webkit-box-shadow: 2px 2px 4px #EEE; - box-shadow: 2px 2px 4px #EEE; -} - -table.docutils { - border: 1px solid #888; - -moz-box-shadow: 2px 2px 4px #EEE; - -webkit-box-shadow: 2px 2px 4px #EEE; - box-shadow: 2px 2px 4px #EEE; -} - -table.docutils td, table.docutils th { - border: 1px solid #888; - padding: 0.25em 0.7em; -} - -table.field-list, table.footnote { - border: none; - -moz-box-shadow: none; - -webkit-box-shadow: none; - box-shadow: none; -} - -table.footnote { - margin: 15px 0; - width: 100%; - border: 1px solid #EEE; - background: #FDFDFD; - font-size: 0.9em; -} - -table.footnote + table.footnote { - margin-top: -15px; - border-top: none; -} - -table.field-list th { - padding: 0 0.8em 0 0; -} - -table.field-list td { - padding: 0; -} - -table.field-list p { - margin-bottom: 0.8em; -} - -/* Cloned from - * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 - */ -.field-name { - -moz-hyphens: manual; - -ms-hyphens: manual; - -webkit-hyphens: manual; - hyphens: manual; -} - -table.footnote td.label { - width: .1px; - padding: 0.3em 0 0.3em 0.5em; -} - -table.footnote td { - padding: 0.3em 0.5em; -} - -dl { - margin: 0; - padding: 0; -} - -dl dd { - margin-left: 30px; -} - -blockquote { - margin: 0 0 0 30px; - padding: 0; -} - -ul, ol { - /* Matches the 30px from the narrow-screen "li > ul" selector below */ - margin: 10px 0 10px 30px; - padding: 0; -} - -pre { - background: #EEE; - padding: 7px 30px; - margin: 15px 0px; - line-height: 1.3em; -} - -div.viewcode-block:target { - background: #ffd; -} - -dl pre, blockquote pre, li pre { - margin-left: 0; - padding-left: 30px; -} - -tt, code { - background-color: #ecf0f3; - color: #222; - /* padding: 1px 2px; */ -} - -tt.xref, code.xref, a tt { - background-color: #FBFBFB; - border-bottom: 1px solid #fff; -} - -a.reference { - text-decoration: none; - border-bottom: 1px dotted #004B6B; -} - -/* Don't put an underline on images */ -a.image-reference, a.image-reference:hover { - border-bottom: none; -} - -a.reference:hover { - border-bottom: 1px solid #6D4100; -} - -a.footnote-reference { - text-decoration: none; - font-size: 0.7em; - vertical-align: top; - border-bottom: 1px dotted #004B6B; -} - -a.footnote-reference:hover { - border-bottom: 1px solid #6D4100; -} - -a:hover tt, a:hover code { - background: #EEE; -} - - -@media screen and (max-width: 870px) { - - div.sphinxsidebar { - display: none; - } - - div.document { - width: 100%; - - } - - div.documentwrapper { - margin-left: 0; - margin-top: 0; - margin-right: 0; - margin-bottom: 0; - } - - div.bodywrapper { - margin-top: 0; - margin-right: 0; - margin-bottom: 0; - margin-left: 0; - } - - ul { - margin-left: 0; - } - - li > ul { - /* Matches the 30px from the "ul, ol" selector above */ - margin-left: 30px; - } - - .document { - width: auto; - } - - .footer { - width: auto; - } - - .bodywrapper { - margin: 0; - } - - .footer { - width: auto; - } - - .github { - display: none; - } - - - -} - - - -@media screen and (max-width: 875px) { - - body { - margin: 0; - padding: 20px 30px; - } - - div.documentwrapper { - float: none; - background: #fff; - } - - div.sphinxsidebar { - display: block; - float: none; - width: 102.5%; - margin: 50px -30px -20px -30px; - padding: 10px 20px; - background: #333; - color: #FFF; - } - - div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, - div.sphinxsidebar h3 a { - color: #fff; - } - - div.sphinxsidebar a { - color: #AAA; - } - - div.sphinxsidebar p.logo { - display: none; - } - - div.document { - width: 100%; - margin: 0; - } - - div.footer { - display: none; - } - - div.bodywrapper { - margin: 0; - } - - div.body { - min-height: 0; - padding: 0; - } - - .rtd_doc_footer { - display: none; - } - - .document { - width: auto; - } - - .footer { - width: auto; - } - - .footer { - width: auto; - } - - .github { - display: none; - } -} - - -/* misc. */ - -.revsys-inline { - display: none!important; -} - -/* Make nested-list/multi-paragraph items look better in Releases changelog - * pages. Without this, docutils' magical list fuckery causes inconsistent - * formatting between different release sub-lists. - */ -div#changelog > div.section > ul > li > p:only-child { - margin-bottom: 0; -} - -/* Hide fugly table cell borders in ..bibliography:: directive output */ -table.docutils.citation, table.docutils.citation td, table.docutils.citation th { - border: none; - /* Below needed in some edge cases; if not applied, bottom shadows appear */ - -moz-box-shadow: none; - -webkit-box-shadow: none; - box-shadow: none; -} - - -/* relbar */ - -.related { - line-height: 30px; - width: 100%; - font-size: 0.9rem; -} - -.related.top { - border-bottom: 1px solid #EEE; - margin-bottom: 20px; -} - -.related.bottom { - border-top: 1px solid #EEE; -} - -.related ul { - padding: 0; - margin: 0; - list-style: none; -} - -.related li { - display: inline; -} - -nav#rellinks { - float: right; -} - -nav#rellinks li+li:before { - content: "|"; -} - -nav#breadcrumbs li+li:before { - content: "\00BB"; -} - -/* Hide certain items when printing */ -@media print { - div.related { - display: none; - } -} \ No newline at end of file diff --git a/docs/finn/_build/html/_static/custom.css b/docs/finn/_build/html/_static/custom.css deleted file mode 100644 index 2a924f1d6a8bc930c5296bdb2d5c2d3e39b04a1c..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/_static/custom.css +++ /dev/null @@ -1 +0,0 @@ -/* This file intentionally left blank. */ diff --git a/docs/finn/_build/html/finn.analysis.fpgadataflow.html b/docs/finn/_build/html/finn.analysis.fpgadataflow.html deleted file mode 100644 index ddec3c9231f54dfeaa939941cb099d364acd870f..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/finn.analysis.fpgadataflow.html +++ /dev/null @@ -1,224 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.analysis.fpgadataflow package — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - - <script type="text/javascript" src="_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> - <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" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <!-- Local TOC --> - <div class="local-toc"><ul> -<li><a class="reference internal" href="#">finn.analysis.fpgadataflow package</a><ul> -<li><a class="reference internal" href="#submodules">Submodules</a></li> -<li><a class="reference internal" href="#module-finn.analysis.fpgadataflow.hls_synth_res_estimation">finn.analysis.fpgadataflow.hls_synth_res_estimation module</a></li> -<li><a class="reference internal" href="#module-finn.analysis.fpgadataflow.res_estimation">finn.analysis.fpgadataflow.res_estimation module</a></li> -<li><a class="reference internal" href="#module-finn.analysis.fpgadataflow">Module contents</a></li> -</ul> -</li> -</ul> -</div> - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="index.html">Docs</a> »</li> - - <li>finn.analysis.fpgadataflow package</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="_sources/finn.analysis.fpgadataflow.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="finn-analysis-fpgadataflow-package"> -<h1>finn.analysis.fpgadataflow package<a class="headerlink" href="#finn-analysis-fpgadataflow-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-finn.analysis.fpgadataflow.hls_synth_res_estimation"> -<span id="finn-analysis-fpgadataflow-hls-synth-res-estimation-module"></span><h2>finn.analysis.fpgadataflow.hls_synth_res_estimation module<a class="headerlink" href="#module-finn.analysis.fpgadataflow.hls_synth_res_estimation" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<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> -</dd></dl> - -</div> -<div class="section" id="module-finn.analysis.fpgadataflow.res_estimation"> -<span id="finn-analysis-fpgadataflow-res-estimation-module"></span><h2>finn.analysis.fpgadataflow.res_estimation module<a class="headerlink" href="#module-finn.analysis.fpgadataflow.res_estimation" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<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> -</dd></dl> - -</div> -<div class="section" id="module-finn.analysis.fpgadataflow"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-finn.analysis.fpgadataflow" title="Permalink to this headline">¶</a></h2> -</div> -</div> - - - </div> - - </div> - <footer> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/finn.analysis.html b/docs/finn/_build/html/finn.analysis.html deleted file mode 100644 index 77cecff25613dc668c40ad967ebe87d87eb4c125..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/finn.analysis.html +++ /dev/null @@ -1,272 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.analysis package — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - - <script type="text/javascript" src="_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> - <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" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <!-- Local TOC --> - <div class="local-toc"><ul> -<li><a class="reference internal" href="#">finn.analysis package</a><ul> -<li><a class="reference internal" href="#subpackages">Subpackages</a></li> -<li><a class="reference internal" href="#submodules">Submodules</a></li> -<li><a class="reference internal" href="#module-finn.analysis.topology">finn.analysis.topology module</a></li> -<li><a class="reference internal" href="#module-finn.analysis.verify_custom_nodes">finn.analysis.verify_custom_nodes module</a></li> -<li><a class="reference internal" href="#module-finn.analysis">Module contents</a><ul> -<li><a class="reference internal" href="#how-to-write-an-analysis-pass-for-finn">How to write an analysis pass for FINN</a></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="index.html">Docs</a> »</li> - - <li>finn.analysis package</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="_sources/finn.analysis.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="finn-analysis-package"> -<h1>finn.analysis package<a class="headerlink" href="#finn-analysis-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="subpackages"> -<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="finn.analysis.fpgadataflow.html">finn.analysis.fpgadataflow package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="finn.analysis.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.analysis.fpgadataflow.html#module-finn.analysis.fpgadataflow.hls_synth_res_estimation">finn.analysis.fpgadataflow.hls_synth_res_estimation module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.analysis.fpgadataflow.html#module-finn.analysis.fpgadataflow.res_estimation">finn.analysis.fpgadataflow.res_estimation module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.analysis.fpgadataflow.html#module-finn.analysis.fpgadataflow">Module contents</a></li> -</ul> -</li> -</ul> -</div> -</div> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-finn.analysis.topology"> -<span id="finn-analysis-topology-module"></span><h2>finn.analysis.topology module<a class="headerlink" href="#module-finn.analysis.topology" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<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> -</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></dl> - -<dl class="function"> -<dt id="finn.analysis.topology.is_linear"> -<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> -</dd></dl> - -<dl class="function"> -<dt id="finn.analysis.topology.node_inputs_in_expected_order"> -<code class="sig-prename descclassname">finn.analysis.topology.</code><code class="sig-name descname">node_inputs_in_expected_order</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.analysis.topology.node_inputs_in_expected_order" title="Permalink to this definition">¶</a></dt> -<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> -</dd></dl> - -</div> -<div class="section" id="module-finn.analysis.verify_custom_nodes"> -<span id="finn-analysis-verify-custom-nodes-module"></span><h2>finn.analysis.verify_custom_nodes module<a class="headerlink" href="#module-finn.analysis.verify_custom_nodes" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<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> -</dd></dl> - -</div> -<div class="section" id="module-finn.analysis"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-finn.analysis" title="Permalink to this headline">¶</a></h2> -<div class="section" id="how-to-write-an-analysis-pass-for-finn"> -<h3>How to write an analysis pass for FINN<a class="headerlink" href="#how-to-write-an-analysis-pass-for-finn" title="Permalink to this headline">¶</a></h3> -<p>An analysis pass traverses the graph structure and produces information about -certain properties. The convention is to take in a ModelWrapper, and return -a dictionary of named properties that the analysis extracts.</p> -</div> -</div> -</div> - - - </div> - - </div> - <footer> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/finn.core.html b/docs/finn/_build/html/finn.core.html deleted file mode 100644 index f5cf18da74fa9a9c60b2dfec10d7196cd1f852fb..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/finn.core.html +++ /dev/null @@ -1,562 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.core package — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - - <script type="text/javascript" src="_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> - <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" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <!-- Local TOC --> - <div class="local-toc"><ul> -<li><a class="reference internal" href="#">finn.core package</a><ul> -<li><a class="reference internal" href="#submodules">Submodules</a></li> -<li><a class="reference internal" href="#module-finn.core.datatype">finn.core.datatype module</a></li> -<li><a class="reference internal" href="#module-finn.core.execute_custom_node">finn.core.execute_custom_node module</a></li> -<li><a class="reference internal" href="#module-finn.core.modelwrapper">finn.core.modelwrapper module</a></li> -<li><a class="reference internal" href="#module-finn.core.onnx_exec">finn.core.onnx_exec module</a></li> -<li><a class="reference internal" href="#module-finn.core">Module contents</a></li> -</ul> -</li> -</ul> -</div> - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="index.html">Docs</a> »</li> - - <li>finn.core package</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="_sources/finn.core.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="finn-core-package"> -<h1>finn.core package<a class="headerlink" href="#finn-core-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-finn.core.datatype"> -<span id="finn-core-datatype-module"></span><h2>finn.core.datatype module<a class="headerlink" href="#module-finn.core.datatype" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.core.datatype.DataType"> -<em class="property">class </em><code class="sig-prename descclassname">finn.core.datatype.</code><code class="sig-name descname">DataType</code><a class="headerlink" href="#finn.core.datatype.DataType" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p> -<p>An enumeration.</p> -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.BINARY"> -<code class="sig-name descname">BINARY</code><em class="property"> = 1</em><a class="headerlink" href="#finn.core.datatype.DataType.BINARY" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.BIPOLAR"> -<code class="sig-name descname">BIPOLAR</code><em class="property"> = 8</em><a class="headerlink" href="#finn.core.datatype.DataType.BIPOLAR" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.FLOAT32"> -<code class="sig-name descname">FLOAT32</code><em class="property"> = 16</em><a class="headerlink" href="#finn.core.datatype.DataType.FLOAT32" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.INT16"> -<code class="sig-name descname">INT16</code><em class="property"> = 14</em><a class="headerlink" href="#finn.core.datatype.DataType.INT16" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.INT2"> -<code class="sig-name descname">INT2</code><em class="property"> = 10</em><a class="headerlink" href="#finn.core.datatype.DataType.INT2" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.INT3"> -<code class="sig-name descname">INT3</code><em class="property"> = 11</em><a class="headerlink" href="#finn.core.datatype.DataType.INT3" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.INT32"> -<code class="sig-name descname">INT32</code><em class="property"> = 15</em><a class="headerlink" href="#finn.core.datatype.DataType.INT32" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.INT4"> -<code class="sig-name descname">INT4</code><em class="property"> = 12</em><a class="headerlink" href="#finn.core.datatype.DataType.INT4" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.INT8"> -<code class="sig-name descname">INT8</code><em class="property"> = 13</em><a class="headerlink" href="#finn.core.datatype.DataType.INT8" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.TERNARY"> -<code class="sig-name descname">TERNARY</code><em class="property"> = 9</em><a class="headerlink" href="#finn.core.datatype.DataType.TERNARY" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.UINT16"> -<code class="sig-name descname">UINT16</code><em class="property"> = 6</em><a class="headerlink" href="#finn.core.datatype.DataType.UINT16" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.UINT2"> -<code class="sig-name descname">UINT2</code><em class="property"> = 2</em><a class="headerlink" href="#finn.core.datatype.DataType.UINT2" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.UINT3"> -<code class="sig-name descname">UINT3</code><em class="property"> = 3</em><a class="headerlink" href="#finn.core.datatype.DataType.UINT3" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.UINT32"> -<code class="sig-name descname">UINT32</code><em class="property"> = 7</em><a class="headerlink" href="#finn.core.datatype.DataType.UINT32" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.UINT4"> -<code class="sig-name descname">UINT4</code><em class="property"> = 4</em><a class="headerlink" href="#finn.core.datatype.DataType.UINT4" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.UINT8"> -<code class="sig-name descname">UINT8</code><em class="property"> = 5</em><a class="headerlink" href="#finn.core.datatype.DataType.UINT8" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.allowed"> -<code class="sig-name descname">allowed</code><span class="sig-paren">(</span><em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.allowed" title="Permalink to this definition">¶</a></dt> -<dd><p>Check whether given value is allowed for this DataType.</p> -<p>value (float32): value to be checked</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.bitwidth"> -<code class="sig-name descname">bitwidth</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.bitwidth" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the number of bits required for this DataType.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.get_hls_datatype_str"> -<code class="sig-name descname">get_hls_datatype_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.get_hls_datatype_str" title="Permalink to this definition">¶</a></dt> -<dd><p>Return the corresponding Vivado HLS datatype name.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.get_num_possible_values"> -<code class="sig-name descname">get_num_possible_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.get_num_possible_values" title="Permalink to this definition">¶</a></dt> -<dd><p>Return the number of possible values this DataType can take. Only -implemented for integer types for now.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.get_smallest_possible"> -<code class="sig-name descname">get_smallest_possible</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.get_smallest_possible" title="Permalink to this definition">¶</a></dt> -<dd><p>Return smallest (fewest bits) possible DataType that can represent -value. Prefers unsigned integers where possible.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.is_integer"> -<code class="sig-name descname">is_integer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.is_integer" title="Permalink to this definition">¶</a></dt> -<dd><p>Return whether this DataType represents integer values only.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.max"> -<code class="sig-name descname">max</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.max" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the largest possible value allowed by this DataType.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.min"> -<code class="sig-name descname">min</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.min" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the smallest possible value allowed by this DataType.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.signed"> -<code class="sig-name descname">signed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.signed" title="Permalink to this definition">¶</a></dt> -<dd><p>Return whether this DataType can represent negative numbers.</p> -</dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.core.execute_custom_node"> -<span id="finn-core-execute-custom-node-module"></span><h2>finn.core.execute_custom_node module<a class="headerlink" href="#module-finn.core.execute_custom_node" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<dt id="finn.core.execute_custom_node.execute_custom_node"> -<code class="sig-prename descclassname">finn.core.execute_custom_node.</code><code class="sig-name descname">execute_custom_node</code><span class="sig-paren">(</span><em class="sig-param">node</em>, <em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.execute_custom_node.execute_custom_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Call custom implementation to execute a single custom node. -Input/output provided via context.</p> -</dd></dl> - -</div> -<div class="section" id="module-finn.core.modelwrapper"> -<span id="finn-core-modelwrapper-module"></span><h2>finn.core.modelwrapper module<a class="headerlink" href="#module-finn.core.modelwrapper" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.core.modelwrapper.ModelWrapper"> -<em class="property">class </em><code class="sig-prename descclassname">finn.core.modelwrapper.</code><code class="sig-name descname">ModelWrapper</code><span class="sig-paren">(</span><em class="sig-param">onnx_model_proto</em>, <em class="sig-param">make_deepcopy=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> -<p>A wrapper around ONNX ModelProto that exposes some useful utility -functions for graph manipulation and exploration.</p> -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.analysis"> -<code class="sig-name descname">analysis</code><span class="sig-paren">(</span><em class="sig-param">analysis_fxn</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.analysis" title="Permalink to this definition">¶</a></dt> -<dd><p>Run given anaylsis_fxn on this model and return resulting dict.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.check_all_tensor_shapes_specified"> -<code class="sig-name descname">check_all_tensor_shapes_specified</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.check_all_tensor_shapes_specified" title="Permalink to this definition">¶</a></dt> -<dd><p>Checks whether all tensors have a specified shape (ValueInfo). -The ONNX standard allows for intermediate activations to have no -associated ValueInfo, but FINN expects this.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.check_compatibility"> -<code class="sig-name descname">check_compatibility</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.check_compatibility" title="Permalink to this definition">¶</a></dt> -<dd><p>Checks this model for FINN compatibility: -* no embedded subgraphs -* all tensor shapes are specified, including activations -* all constants are initializers</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.find_consumer"> -<code class="sig-name descname">find_consumer</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.find_consumer" title="Permalink to this definition">¶</a></dt> -<dd><p>Find and return the node that consumes the tensor with given name. -Currently only works for linear graphs.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.find_producer"> -<code class="sig-name descname">find_producer</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.find_producer" title="Permalink to this definition">¶</a></dt> -<dd><p>Find and return the node that produces the tensor with given name. -Currently only works for linear graphs.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.get_all_tensor_names"> -<code class="sig-name descname">get_all_tensor_names</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.get_all_tensor_names" title="Permalink to this definition">¶</a></dt> -<dd><p>Return a list of all (input, output and value_info) tensor names -in the graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.get_initializer"> -<code class="sig-name descname">get_initializer</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.get_initializer" title="Permalink to this definition">¶</a></dt> -<dd><p>Get the initializer value for tensor with given name, if any.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.get_metadata_prop"> -<code class="sig-name descname">get_metadata_prop</code><span class="sig-paren">(</span><em class="sig-param">key</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.get_metadata_prop" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the value associated with metadata_prop with given key, -or None otherwise.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.get_tensor_datatype"> -<code class="sig-name descname">get_tensor_datatype</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.get_tensor_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the FINN DataType of tensor with given name.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.get_tensor_fanout"> -<code class="sig-name descname">get_tensor_fanout</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.get_tensor_fanout" title="Permalink to this definition">¶</a></dt> -<dd><p>Return the number of nodes for which the tensor with given name is -as input.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.get_tensor_shape"> -<code class="sig-name descname">get_tensor_shape</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.get_tensor_shape" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the shape of tensor with given name, if it has ValueInfoProto.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.get_tensor_valueinfo"> -<code class="sig-name descname">get_tensor_valueinfo</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.get_tensor_valueinfo" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns ValueInfoProto of tensor with given name, if it has one.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.graph"> -<em class="property">property </em><code class="sig-name descname">graph</code><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.graph" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.make_empty_exec_context"> -<code class="sig-name descname">make_empty_exec_context</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.make_empty_exec_context" title="Permalink to this definition">¶</a></dt> -<dd><p>Creates an empty execution context for this model. -The execution context is a dictionary of all tensors used for the -inference computation. Any initializer values will be taken into -account, all other tensors will be zero.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.make_new_valueinfo_name"> -<code class="sig-name descname">make_new_valueinfo_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.make_new_valueinfo_name" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a name that can be used for a new value_info.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.model"> -<em class="property">property </em><code class="sig-name descname">model</code><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.model" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.rename_tensor"> -<code class="sig-name descname">rename_tensor</code><span class="sig-paren">(</span><em class="sig-param">old_name</em>, <em class="sig-param">new_name</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.rename_tensor" title="Permalink to this definition">¶</a></dt> -<dd><p>Rename a tensor from old_name to new_name.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.save"> -<code class="sig-name descname">save</code><span class="sig-paren">(</span><em class="sig-param">filename</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.save" title="Permalink to this definition">¶</a></dt> -<dd><p>Save the wrapper ONNX ModelProto into a file with given name.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.set_initializer"> -<code class="sig-name descname">set_initializer</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em>, <em class="sig-param">tensor_value</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.set_initializer" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the initializer value for tensor with given name.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.set_metadata_prop"> -<code class="sig-name descname">set_metadata_prop</code><span class="sig-paren">(</span><em class="sig-param">key</em>, <em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.set_metadata_prop" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.set_tensor_datatype"> -<code class="sig-name descname">set_tensor_datatype</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em>, <em class="sig-param">datatype</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.set_tensor_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Sets the FINN DataType of tensor with given name.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.set_tensor_shape"> -<code class="sig-name descname">set_tensor_shape</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em>, <em class="sig-param">tensor_shape</em>, <em class="sig-param">dtype=1</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.set_tensor_shape" title="Permalink to this definition">¶</a></dt> -<dd><p>Assign shape in ValueInfoProto for tensor with given name.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.transform"> -<code class="sig-name descname">transform</code><span class="sig-paren">(</span><em class="sig-param">transformation</em>, <em class="sig-param">make_deepcopy=True</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.transform" title="Permalink to this definition">¶</a></dt> -<dd><p>Applies given Transformation repeatedly until no more changes can be made -and returns a transformed ModelWrapper instance. -If make_deepcopy is specified, operates on a new (deep)copy of model.</p> -</dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.core.onnx_exec"> -<span id="finn-core-onnx-exec-module"></span><h2>finn.core.onnx_exec module<a class="headerlink" href="#module-finn.core.onnx_exec" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<dt id="finn.core.onnx_exec.compare_execution"> -<code class="sig-prename descclassname">finn.core.onnx_exec.</code><code class="sig-name descname">compare_execution</code><span class="sig-paren">(</span><em class="sig-param">model_a</em>, <em class="sig-param">model_b</em>, <em class="sig-param">input_dict</em>, <em class="sig-param">compare_fxn=<function <lambda>></em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.onnx_exec.compare_execution" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute two ONNX models and compare their outputs using given function. -compare_fxn should take in two tensors and return a Boolean</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.core.onnx_exec.execute_node"> -<code class="sig-prename descclassname">finn.core.onnx_exec.</code><code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">node</em>, <em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.onnx_exec.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute a single node by using onnxruntime, with custom function or -if dataflow partition by using remote execution or rtlsim. -Input/output provided via context.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.core.onnx_exec.execute_onnx"> -<code class="sig-prename descclassname">finn.core.onnx_exec.</code><code class="sig-name descname">execute_onnx</code><span class="sig-paren">(</span><em class="sig-param">model</em>, <em class="sig-param">input_dict</em>, <em class="sig-param">return_full_exec_context=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.onnx_exec.execute_onnx" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute given ONNX ModelWrapper with given named inputs. -If return_full_exec_context is False, a dict of named outputs is returned -as indicated by the model.graph.output. -If return return_full_exec_context is True, the full set of tensors used by -the execution (including inputs, weights, activations and final outputs) -will be returned as a dict.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.core.onnx_exec.execute_onnx_and_make_model"> -<code class="sig-prename descclassname">finn.core.onnx_exec.</code><code class="sig-name descname">execute_onnx_and_make_model</code><span class="sig-paren">(</span><em class="sig-param">model</em>, <em class="sig-param">input_dict</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.onnx_exec.execute_onnx_and_make_model" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute given ONNX ModelWrapper with given named inputs and return a new -ModelWrapper where an initializer is provided for each tensor as taken from -the execution. This new model is useful for debugging, since it contains -all the intermediate activation values.</p> -</dd></dl> - -</div> -<div class="section" id="module-finn.core"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-finn.core" title="Permalink to this headline">¶</a></h2> -</div> -</div> - - - </div> - - </div> - <footer> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/finn.custom_op.fpgadataflow.html b/docs/finn/_build/html/finn.custom_op.fpgadataflow.html deleted file mode 100644 index b4e6808b444795b73b07dda419dcf3cfcc9b1ffd..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/finn.custom_op.fpgadataflow.html +++ /dev/null @@ -1,922 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.custom_op.fpgadataflow package — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - - <script type="text/javascript" src="_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> - <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" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <!-- Local TOC --> - <div class="local-toc"><ul> -<li><a class="reference internal" href="#">finn.custom_op.fpgadataflow package</a><ul> -<li><a class="reference internal" href="#submodules">Submodules</a></li> -<li><a class="reference internal" href="#module-finn.custom_op.fpgadataflow.convolutioninputgenerator">finn.custom_op.fpgadataflow.convolutioninputgenerator module</a></li> -<li><a class="reference internal" href="#module-finn.custom_op.fpgadataflow.streamingfclayer_batch">finn.custom_op.fpgadataflow.streamingfclayer_batch module</a></li> -<li><a class="reference internal" href="#module-finn.custom_op.fpgadataflow.streamingmaxpool_batch">finn.custom_op.fpgadataflow.streamingmaxpool_batch module</a></li> -<li><a class="reference internal" href="#module-finn.custom_op.fpgadataflow.templates">finn.custom_op.fpgadataflow.templates module</a></li> -<li><a class="reference internal" href="#module-finn.custom_op.fpgadataflow.tlastmarker">finn.custom_op.fpgadataflow.tlastmarker module</a></li> -<li><a class="reference internal" href="#module-finn.custom_op.fpgadataflow">Module contents</a></li> -</ul> -</li> -</ul> -</div> - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="index.html">Docs</a> »</li> - - <li>finn.custom_op.fpgadataflow package</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="_sources/finn.custom_op.fpgadataflow.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="finn-custom-op-fpgadataflow-package"> -<h1>finn.custom_op.fpgadataflow package<a class="headerlink" href="#finn-custom-op-fpgadataflow-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-finn.custom_op.fpgadataflow.convolutioninputgenerator"> -<span id="finn-custom-op-fpgadataflow-convolutioninputgenerator-module"></span><h2>finn.custom_op.fpgadataflow.convolutioninputgenerator module<a class="headerlink" href="#module-finn.custom_op.fpgadataflow.convolutioninputgenerator" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator"> -<em class="property">class </em><code class="sig-prename descclassname">finn.custom_op.fpgadataflow.convolutioninputgenerator.</code><code class="sig-name descname">ConvolutionInputGenerator</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.custom_op.fpgadataflow.HLSCustomOp" title="finn.custom_op.fpgadataflow.HLSCustomOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.fpgadataflow.HLSCustomOp</span></code></a></p> -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.blackboxfunction"> -<code class="sig-name descname">blackboxfunction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.blackboxfunction" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.bram_estimation"> -<code class="sig-name descname">bram_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.bram_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.dataoutstrm"> -<code class="sig-name descname">dataoutstrm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.dataoutstrm" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.defines"> -<code class="sig-name descname">defines</code><span class="sig-paren">(</span><em class="sig-param">var</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.defines" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.docompute"> -<code class="sig-name descname">docompute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.docompute" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_input_datatype"> -<code class="sig-name descname">get_input_datatype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_input_datatype" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_number_output_values"> -<code class="sig-name descname">get_number_output_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_number_output_values" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_output_datatype"> -<code class="sig-name descname">get_output_datatype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_output_datatype" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_stream_width"> -<code class="sig-name descname">get_stream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_stream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.global_includes"> -<code class="sig-name descname">global_includes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.global_includes" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.lut_estimation"> -<code class="sig-name descname">lut_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.lut_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.pragmas"> -<code class="sig-name descname">pragmas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.pragmas" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.read_npy_data"> -<code class="sig-name descname">read_npy_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.read_npy_data" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.save_as_npy"> -<code class="sig-name descname">save_as_npy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.save_as_npy" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.strm_decl"> -<code class="sig-name descname">strm_decl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.strm_decl" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.custom_op.fpgadataflow.streamingfclayer_batch"> -<span id="finn-custom-op-fpgadataflow-streamingfclayer-batch-module"></span><h2>finn.custom_op.fpgadataflow.streamingfclayer_batch module<a class="headerlink" href="#module-finn.custom_op.fpgadataflow.streamingfclayer_batch" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch"> -<em class="property">class </em><code class="sig-prename descclassname">finn.custom_op.fpgadataflow.streamingfclayer_batch.</code><code class="sig-name descname">StreamingFCLayer_Batch</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.custom_op.fpgadataflow.HLSCustomOp" title="finn.custom_op.fpgadataflow.HLSCustomOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.fpgadataflow.HLSCustomOp</span></code></a></p> -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.blackboxfunction"> -<code class="sig-name descname">blackboxfunction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.blackboxfunction" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.bram_estimation"> -<code class="sig-name descname">bram_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.bram_estimation" title="Permalink to this definition">¶</a></dt> -<dd><p>the calculations are based on: -- FINN-R: An End-to-End Deep-Learning Framework for Fast -Exploration of Quantized Neural Networks -- M. Blott, T. B. Preusser, N. J. Fraser, G. Gambardella, K. O’Brien, -Y. Umuroglu, M. Leeser and K. Vissers -- 12. Sep 2018</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.calc_tmem"> -<code class="sig-name descname">calc_tmem</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.calc_tmem" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.calc_wmem"> -<code class="sig-name descname">calc_wmem</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.calc_wmem" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.dataoutstrm"> -<code class="sig-name descname">dataoutstrm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.dataoutstrm" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.defines"> -<code class="sig-name descname">defines</code><span class="sig-paren">(</span><em class="sig-param">var</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.defines" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.docompute"> -<code class="sig-name descname">docompute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.docompute" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.generate_params"> -<code class="sig-name descname">generate_params</code><span class="sig-paren">(</span><em class="sig-param">model</em>, <em class="sig-param">path</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.generate_params" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_folded_input_shape"> -<code class="sig-name descname">get_folded_input_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_folded_input_shape" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_folded_output_shape"> -<code class="sig-name descname">get_folded_output_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_folded_output_shape" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_hls_compatible_threshold_tensor"> -<code class="sig-name descname">get_hls_compatible_threshold_tensor</code><span class="sig-paren">(</span><em class="sig-param">orig_thres_matrix</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_hls_compatible_threshold_tensor" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert the original numpy weight matrix orig_weight_matrix into -a form suitable for passing to the hlslib call: -* ensure MH % PE == 0 -* for bipolar weights&inputs, ensure thresholds are positive -* interleave rows between PEs -* reshape into (PE, TMEM, n_thres_steps) and return</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_hls_compatible_weight_tensor"> -<code class="sig-name descname">get_hls_compatible_weight_tensor</code><span class="sig-paren">(</span><em class="sig-param">orig_weight_matrix</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_hls_compatible_weight_tensor" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert the original numpy weight matrix orig_weight_matrix into -a form suitable for passing to the hlslib call: -* ensure MH % PE == 0 and MW % SIMD == 0 -* for bipolar {-1,+1} weights, convert to binary {0, 1} -* interleave rows between PEs -* reshape into (1, PE, WMEM, SIMD) and return</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_input_datatype"> -<code class="sig-name descname">get_input_datatype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_input_datatype" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_instream_width"> -<code class="sig-name descname">get_instream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_instream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_number_output_values"> -<code class="sig-name descname">get_number_output_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_number_output_values" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_output_datatype"> -<code class="sig-name descname">get_output_datatype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_output_datatype" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_outstream_width"> -<code class="sig-name descname">get_outstream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_outstream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_template_param_values"> -<code class="sig-name descname">get_template_param_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_template_param_values" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_weight_datatype"> -<code class="sig-name descname">get_weight_datatype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_weight_datatype" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.global_includes"> -<code class="sig-name descname">global_includes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.global_includes" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.lut_estimation"> -<code class="sig-name descname">lut_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.lut_estimation" title="Permalink to this definition">¶</a></dt> -<dd><p>the calculations are based on: -- FINN-R: An End-to-End Deep-Learning Framework for Fast -Exploration of Quantized Neural Networks -- M. Blott, T. B. Preusser, N. J. Fraser, G. Gambardella, K. O’Brien, -Y. Umuroglu, M. Leeser and K. Vissers -- 12. Sep 2018</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.pragmas"> -<code class="sig-name descname">pragmas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.pragmas" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.read_npy_data"> -<code class="sig-name descname">read_npy_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.read_npy_data" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.save_as_npy"> -<code class="sig-name descname">save_as_npy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.save_as_npy" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.strm_decl"> -<code class="sig-name descname">strm_decl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.strm_decl" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.custom_op.fpgadataflow.streamingmaxpool_batch"> -<span id="finn-custom-op-fpgadataflow-streamingmaxpool-batch-module"></span><h2>finn.custom_op.fpgadataflow.streamingmaxpool_batch module<a class="headerlink" href="#module-finn.custom_op.fpgadataflow.streamingmaxpool_batch" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch"> -<em class="property">class </em><code class="sig-prename descclassname">finn.custom_op.fpgadataflow.streamingmaxpool_batch.</code><code class="sig-name descname">StreamingMaxPool_Batch</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.custom_op.fpgadataflow.HLSCustomOp" title="finn.custom_op.fpgadataflow.HLSCustomOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.fpgadataflow.HLSCustomOp</span></code></a></p> -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.blackboxfunction"> -<code class="sig-name descname">blackboxfunction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.blackboxfunction" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.bram_estimation"> -<code class="sig-name descname">bram_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.bram_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.dataoutstrm"> -<code class="sig-name descname">dataoutstrm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.dataoutstrm" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.defines"> -<code class="sig-name descname">defines</code><span class="sig-paren">(</span><em class="sig-param">var</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.defines" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.docompute"> -<code class="sig-name descname">docompute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.docompute" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.get_number_output_values"> -<code class="sig-name descname">get_number_output_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.get_number_output_values" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.global_includes"> -<code class="sig-name descname">global_includes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.global_includes" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.lut_estimation"> -<code class="sig-name descname">lut_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.lut_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.pragmas"> -<code class="sig-name descname">pragmas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.pragmas" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.read_npy_data"> -<code class="sig-name descname">read_npy_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.read_npy_data" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.save_as_npy"> -<code class="sig-name descname">save_as_npy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.save_as_npy" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.strm_decl"> -<code class="sig-name descname">strm_decl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.strm_decl" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.custom_op.fpgadataflow.templates"> -<span id="finn-custom-op-fpgadataflow-templates-module"></span><h2>finn.custom_op.fpgadataflow.templates module<a class="headerlink" href="#module-finn.custom_op.fpgadataflow.templates" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-finn.custom_op.fpgadataflow.tlastmarker"> -<span id="finn-custom-op-fpgadataflow-tlastmarker-module"></span><h2>finn.custom_op.fpgadataflow.tlastmarker module<a class="headerlink" href="#module-finn.custom_op.fpgadataflow.tlastmarker" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker"> -<em class="property">class </em><code class="sig-prename descclassname">finn.custom_op.fpgadataflow.tlastmarker.</code><code class="sig-name descname">TLastMarker</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.custom_op.fpgadataflow.HLSCustomOp" title="finn.custom_op.fpgadataflow.HLSCustomOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.fpgadataflow.HLSCustomOp</span></code></a></p> -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.blackboxfunction"> -<code class="sig-name descname">blackboxfunction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.blackboxfunction" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.dataoutstrm"> -<code class="sig-name descname">dataoutstrm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.dataoutstrm" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.defines"> -<code class="sig-name descname">defines</code><span class="sig-paren">(</span><em class="sig-param">var</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.defines" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.docompute"> -<code class="sig-name descname">docompute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.docompute" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_folded_input_shape"> -<code class="sig-name descname">get_folded_input_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_folded_input_shape" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_folded_output_shape"> -<code class="sig-name descname">get_folded_output_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_folded_output_shape" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_instream_width"> -<code class="sig-name descname">get_instream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_instream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_number_output_values"> -<code class="sig-name descname">get_number_output_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_number_output_values" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_outstream_width"> -<code class="sig-name descname">get_outstream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_outstream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.global_includes"> -<code class="sig-name descname">global_includes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.global_includes" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.pragmas"> -<code class="sig-name descname">pragmas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.pragmas" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.read_npy_data"> -<code class="sig-name descname">read_npy_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.read_npy_data" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.save_as_npy"> -<code class="sig-name descname">save_as_npy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.save_as_npy" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.strm_decl"> -<code class="sig-name descname">strm_decl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.strm_decl" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.custom_op.fpgadataflow"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-finn.custom_op.fpgadataflow" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp"> -<em class="property">class </em><code class="sig-prename descclassname">finn.custom_op.fpgadataflow.</code><code class="sig-name descname">HLSCustomOp</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.custom_op.html#finn.custom_op.CustomOp" title="finn.custom_op.CustomOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.CustomOp</span></code></a></p> -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.blackboxfunction"> -<em class="property">abstract </em><code class="sig-name descname">blackboxfunction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.blackboxfunction" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.bram_estimation"> -<code class="sig-name descname">bram_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.bram_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.code_generation_ipgen"> -<code class="sig-name descname">code_generation_ipgen</code><span class="sig-paren">(</span><em class="sig-param">model</em>, <em class="sig-param">fpgapart</em>, <em class="sig-param">clk</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.code_generation_ipgen" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.code_generation_npysim"> -<code class="sig-name descname">code_generation_npysim</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.code_generation_npysim" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.compile_singlenode_code"> -<code class="sig-name descname">compile_singlenode_code</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.compile_singlenode_code" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.dataoutstrm"> -<em class="property">abstract </em><code class="sig-name descname">dataoutstrm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.dataoutstrm" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.defines"> -<em class="property">abstract </em><code class="sig-name descname">defines</code><span class="sig-paren">(</span><em class="sig-param">var</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.defines" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.docompute"> -<em class="property">abstract </em><code class="sig-name descname">docompute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.docompute" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.dynamic_input_to_npy"> -<code class="sig-name descname">dynamic_input_to_npy</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">count</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.dynamic_input_to_npy" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.exec_precompiled_singlenode_model"> -<code class="sig-name descname">exec_precompiled_singlenode_model</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.exec_precompiled_singlenode_model" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.generate_params"> -<code class="sig-name descname">generate_params</code><span class="sig-paren">(</span><em class="sig-param">model</em>, <em class="sig-param">path</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.generate_params" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.get_folded_input_shape"> -<code class="sig-name descname">get_folded_input_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.get_folded_input_shape" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.get_folded_output_shape"> -<code class="sig-name descname">get_folded_output_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.get_folded_output_shape" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.get_instream_width"> -<code class="sig-name descname">get_instream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.get_instream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.get_number_output_values"> -<em class="property">abstract </em><code class="sig-name descname">get_number_output_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.get_number_output_values" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.get_outstream_width"> -<code class="sig-name descname">get_outstream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.get_outstream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.global_includes"> -<em class="property">abstract </em><code class="sig-name descname">global_includes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.global_includes" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.ipgen_singlenode_code"> -<code class="sig-name descname">ipgen_singlenode_code</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.ipgen_singlenode_code" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.lut_estimation"> -<code class="sig-name descname">lut_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.lut_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.node_res_estimation"> -<code class="sig-name descname">node_res_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.node_res_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.npy_to_dynamic_output"> -<code class="sig-name descname">npy_to_dynamic_output</code><span class="sig-paren">(</span><em class="sig-param">context</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.npy_to_dynamic_output" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.pragmas"> -<em class="property">abstract </em><code class="sig-name descname">pragmas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.pragmas" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.read_npy_data"> -<em class="property">abstract </em><code class="sig-name descname">read_npy_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.read_npy_data" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.reset_rtlsim"> -<code class="sig-name descname">reset_rtlsim</code><span class="sig-paren">(</span><em class="sig-param">sim</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.reset_rtlsim" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.rtlsim"> -<code class="sig-name descname">rtlsim</code><span class="sig-paren">(</span><em class="sig-param">sim</em>, <em class="sig-param">inp</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.rtlsim" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.save_as_npy"> -<em class="property">abstract </em><code class="sig-name descname">save_as_npy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.save_as_npy" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.strm_decl"> -<em class="property">abstract </em><code class="sig-name descname">strm_decl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.strm_decl" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.HLSCustomOp.toggle_clk"> -<code class="sig-name descname">toggle_clk</code><span class="sig-paren">(</span><em class="sig-param">sim</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.HLSCustomOp.toggle_clk" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -</div> - - - </div> - - </div> - <footer> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/finn.custom_op.html b/docs/finn/_build/html/finn.custom_op.html deleted file mode 100644 index 692212b13e6df8aa92a43ebedcb9973430edcab0..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/finn.custom_op.html +++ /dev/null @@ -1,460 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.custom_op package — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - - <script type="text/javascript" src="_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> - <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" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <!-- Local TOC --> - <div class="local-toc"><ul> -<li><a class="reference internal" href="#">finn.custom_op package</a><ul> -<li><a class="reference internal" href="#subpackages">Subpackages</a></li> -<li><a class="reference internal" href="#submodules">Submodules</a></li> -<li><a class="reference internal" href="#module-finn.custom_op.multithreshold">finn.custom_op.multithreshold module</a></li> -<li><a class="reference internal" href="#module-finn.custom_op.registry">finn.custom_op.registry module</a></li> -<li><a class="reference internal" href="#module-finn.custom_op.streamingdataflowpartition">finn.custom_op.streamingdataflowpartition module</a></li> -<li><a class="reference internal" href="#module-finn.custom_op.xnorpopcount">finn.custom_op.xnorpopcount module</a></li> -<li><a class="reference internal" href="#module-finn.custom_op">Module contents</a></li> -</ul> -</li> -</ul> -</div> - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="index.html">Docs</a> »</li> - - <li>finn.custom_op package</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="_sources/finn.custom_op.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="finn-custom-op-package"> -<h1>finn.custom_op package<a class="headerlink" href="#finn-custom-op-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="subpackages"> -<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="finn.custom_op.fpgadataflow.html">finn.custom_op.fpgadataflow package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="finn.custom_op.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.convolutioninputgenerator">finn.custom_op.fpgadataflow.convolutioninputgenerator module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.streamingfclayer_batch">finn.custom_op.fpgadataflow.streamingfclayer_batch module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.streamingmaxpool_batch">finn.custom_op.fpgadataflow.streamingmaxpool_batch module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.templates">finn.custom_op.fpgadataflow.templates module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.tlastmarker">finn.custom_op.fpgadataflow.tlastmarker module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow">Module contents</a></li> -</ul> -</li> -</ul> -</div> -</div> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-finn.custom_op.multithreshold"> -<span id="finn-custom-op-multithreshold-module"></span><h2>finn.custom_op.multithreshold module<a class="headerlink" href="#module-finn.custom_op.multithreshold" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.custom_op.multithreshold.MultiThreshold"> -<em class="property">class </em><code class="sig-prename descclassname">finn.custom_op.multithreshold.</code><code class="sig-name descname">MultiThreshold</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.multithreshold.MultiThreshold" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.custom_op.CustomOp" title="finn.custom_op.CustomOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.CustomOp</span></code></a></p> -<dl class="method"> -<dt id="finn.custom_op.multithreshold.MultiThreshold.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.multithreshold.MultiThreshold.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.multithreshold.MultiThreshold.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.multithreshold.MultiThreshold.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.multithreshold.MultiThreshold.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.multithreshold.MultiThreshold.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.multithreshold.MultiThreshold.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.multithreshold.MultiThreshold.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.multithreshold.MultiThreshold.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.multithreshold.MultiThreshold.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -<dl class="function"> -<dt id="finn.custom_op.multithreshold.compare"> -<code class="sig-prename descclassname">finn.custom_op.multithreshold.</code><code class="sig-name descname">compare</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.multithreshold.compare" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="function"> -<dt id="finn.custom_op.multithreshold.multithreshold"> -<code class="sig-prename descclassname">finn.custom_op.multithreshold.</code><code class="sig-name descname">multithreshold</code><span class="sig-paren">(</span><em class="sig-param">v</em>, <em class="sig-param">thresholds</em>, <em class="sig-param">out_scale=None</em>, <em class="sig-param">out_bias=None</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.multithreshold.multithreshold" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</div> -<div class="section" id="module-finn.custom_op.registry"> -<span id="finn-custom-op-registry-module"></span><h2>finn.custom_op.registry module<a class="headerlink" href="#module-finn.custom_op.registry" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<dt id="finn.custom_op.registry.getCustomOp"> -<code class="sig-prename descclassname">finn.custom_op.registry.</code><code class="sig-name descname">getCustomOp</code><span class="sig-paren">(</span><em class="sig-param">node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.registry.getCustomOp" title="Permalink to this definition">¶</a></dt> -<dd><p>Return a FINN CustomOp instance for the given ONNX node, if it exists.</p> -</dd></dl> - -</div> -<div class="section" id="module-finn.custom_op.streamingdataflowpartition"> -<span id="finn-custom-op-streamingdataflowpartition-module"></span><h2>finn.custom_op.streamingdataflowpartition module<a class="headerlink" href="#module-finn.custom_op.streamingdataflowpartition" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition"> -<em class="property">class </em><code class="sig-prename descclassname">finn.custom_op.streamingdataflowpartition.</code><code class="sig-name descname">StreamingDataflowPartition</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.custom_op.CustomOp" title="finn.custom_op.CustomOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.CustomOp</span></code></a></p> -<dl class="method"> -<dt id="finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.custom_op.xnorpopcount"> -<span id="finn-custom-op-xnorpopcount-module"></span><h2>finn.custom_op.xnorpopcount module<a class="headerlink" href="#module-finn.custom_op.xnorpopcount" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.custom_op.xnorpopcount.XnorPopcountMatMul"> -<em class="property">class </em><code class="sig-prename descclassname">finn.custom_op.xnorpopcount.</code><code class="sig-name descname">XnorPopcountMatMul</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.xnorpopcount.XnorPopcountMatMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.custom_op.CustomOp" title="finn.custom_op.CustomOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.CustomOp</span></code></a></p> -<dl class="method"> -<dt id="finn.custom_op.xnorpopcount.XnorPopcountMatMul.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.xnorpopcount.XnorPopcountMatMul.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.xnorpopcount.XnorPopcountMatMul.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.xnorpopcount.XnorPopcountMatMul.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.xnorpopcount.XnorPopcountMatMul.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.xnorpopcount.XnorPopcountMatMul.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.xnorpopcount.XnorPopcountMatMul.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.xnorpopcount.XnorPopcountMatMul.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.xnorpopcount.XnorPopcountMatMul.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.xnorpopcount.XnorPopcountMatMul.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -<dl class="function"> -<dt id="finn.custom_op.xnorpopcount.xnorpopcountmatmul"> -<code class="sig-prename descclassname">finn.custom_op.xnorpopcount.</code><code class="sig-name descname">xnorpopcountmatmul</code><span class="sig-paren">(</span><em class="sig-param">inp0</em>, <em class="sig-param">inp1</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.xnorpopcount.xnorpopcountmatmul" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</div> -<div class="section" id="module-finn.custom_op"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-finn.custom_op" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.custom_op.CustomOp"> -<em class="property">class </em><code class="sig-prename descclassname">finn.custom_op.</code><code class="sig-name descname">CustomOp</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.CustomOp" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p> -<dl class="method"> -<dt id="finn.custom_op.CustomOp.execute_node"> -<em class="property">abstract </em><code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.CustomOp.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.CustomOp.get_nodeattr"> -<code class="sig-name descname">get_nodeattr</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.CustomOp.get_nodeattr" title="Permalink to this definition">¶</a></dt> -<dd><p>Get a node attribute by name. Data is stored inside the ONNX node’s -AttributeProto container. Attribute must be part of get_nodeattr_types. -Default value is returned if attribute is not set.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.CustomOp.get_nodeattr_types"> -<em class="property">abstract </em><code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.CustomOp.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.CustomOp.infer_node_datatype"> -<em class="property">abstract </em><code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.CustomOp.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.CustomOp.make_shape_compatible_op"> -<em class="property">abstract </em><code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.CustomOp.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.CustomOp.set_nodeattr"> -<code class="sig-name descname">set_nodeattr</code><span class="sig-paren">(</span><em class="sig-param">name</em>, <em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.CustomOp.set_nodeattr" title="Permalink to this definition">¶</a></dt> -<dd><p>Set a node attribute by name. Data is stored inside the ONNX node’s -AttributeProto container. Attribute must be part of get_nodeattr_types.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.CustomOp.verify_node"> -<em class="property">abstract </em><code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.CustomOp.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -</div> -</div> - - - </div> - - </div> - <footer> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/finn.html b/docs/finn/_build/html/finn.html deleted file mode 100644 index 6151be1f9e74a6933615c114e118f00a454231b0..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/finn.html +++ /dev/null @@ -1,314 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn package — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - - <script type="text/javascript" src="_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> - <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" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <!-- Local TOC --> - <div class="local-toc"><ul> -<li><a class="reference internal" href="#">finn package</a><ul> -<li><a class="reference internal" href="#subpackages">Subpackages</a></li> -<li><a class="reference internal" href="#module-finn">Module contents</a></li> -</ul> -</li> -</ul> -</div> - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="index.html">Docs</a> »</li> - - <li>finn package</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="_sources/finn.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="finn-package"> -<h1>finn package<a class="headerlink" href="#finn-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="subpackages"> -<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="finn.analysis.html">finn.analysis package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="finn.analysis.html#subpackages">Subpackages</a><ul> -<li class="toctree-l3"><a class="reference internal" href="finn.analysis.fpgadataflow.html">finn.analysis.fpgadataflow package</a><ul> -<li class="toctree-l4"><a class="reference internal" href="finn.analysis.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.analysis.fpgadataflow.html#module-finn.analysis.fpgadataflow.hls_synth_res_estimation">finn.analysis.fpgadataflow.hls_synth_res_estimation module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.analysis.fpgadataflow.html#module-finn.analysis.fpgadataflow.res_estimation">finn.analysis.fpgadataflow.res_estimation module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.analysis.fpgadataflow.html#module-finn.analysis.fpgadataflow">Module contents</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="finn.analysis.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.analysis.html#module-finn.analysis.topology">finn.analysis.topology module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.analysis.html#module-finn.analysis.verify_custom_nodes">finn.analysis.verify_custom_nodes module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.analysis.html#module-finn.analysis">Module contents</a><ul> -<li class="toctree-l3"><a class="reference internal" href="finn.analysis.html#how-to-write-an-analysis-pass-for-finn">How to write an analysis pass for FINN</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="finn.core.html">finn.core package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="finn.core.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.core.html#module-finn.core.datatype">finn.core.datatype module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.core.html#module-finn.core.execute_custom_node">finn.core.execute_custom_node module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.core.html#module-finn.core.modelwrapper">finn.core.modelwrapper module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.core.html#module-finn.core.onnx_exec">finn.core.onnx_exec module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.core.html#module-finn.core">Module contents</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="finn.custom_op.html">finn.custom_op package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="finn.custom_op.html#subpackages">Subpackages</a><ul> -<li class="toctree-l3"><a class="reference internal" href="finn.custom_op.fpgadataflow.html">finn.custom_op.fpgadataflow package</a><ul> -<li class="toctree-l4"><a class="reference internal" href="finn.custom_op.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.convolutioninputgenerator">finn.custom_op.fpgadataflow.convolutioninputgenerator module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.streamingfclayer_batch">finn.custom_op.fpgadataflow.streamingfclayer_batch module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.streamingmaxpool_batch">finn.custom_op.fpgadataflow.streamingmaxpool_batch module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.templates">finn.custom_op.fpgadataflow.templates module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.tlastmarker">finn.custom_op.fpgadataflow.tlastmarker module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow">Module contents</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="finn.custom_op.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.custom_op.html#module-finn.custom_op.multithreshold">finn.custom_op.multithreshold module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.custom_op.html#module-finn.custom_op.registry">finn.custom_op.registry module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.custom_op.html#module-finn.custom_op.streamingdataflowpartition">finn.custom_op.streamingdataflowpartition module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.custom_op.html#module-finn.custom_op.xnorpopcount">finn.custom_op.xnorpopcount module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.custom_op.html#module-finn.custom_op">Module contents</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="finn.transformation.html">finn.transformation package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.html#subpackages">Subpackages</a><ul> -<li class="toctree-l3"><a class="reference internal" href="finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a><ul> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.cleanup">finn.transformation.fpgadataflow.cleanup module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.codegen_ipgen">finn.transformation.fpgadataflow.codegen_ipgen module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.codegen_ipstitch">finn.transformation.fpgadataflow.codegen_ipstitch module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.codegen_npysim">finn.transformation.fpgadataflow.codegen_npysim module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.compile">finn.transformation.fpgadataflow.compile module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.convert_to_hls_layers">finn.transformation.fpgadataflow.convert_to_hls_layers module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.create_dataflow_partition">finn.transformation.fpgadataflow.create_dataflow_partition module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.hlssynth_ipgen">finn.transformation.fpgadataflow.hlssynth_ipgen module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.insert_tlastmarker">finn.transformation.fpgadataflow.insert_tlastmarker module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.make_deployment">finn.transformation.fpgadataflow.make_deployment module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.make_pynq_driver">finn.transformation.fpgadataflow.make_pynq_driver module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.make_pynq_proj">finn.transformation.fpgadataflow.make_pynq_proj module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.fpgadataflow.html#finn-transformation-fpgadataflow-set-sim-mode-module">finn.transformation.fpgadataflow.set_sim_mode module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.synth_pynq_proj">finn.transformation.fpgadataflow.synth_pynq_proj module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.templates">finn.transformation.fpgadataflow.templates module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow">Module contents</a></li> -</ul> -</li> -<li class="toctree-l3"><a class="reference internal" href="finn.transformation.streamline.html">finn.transformation.streamline package</a><ul> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.streamline.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.streamline.html#module-finn.transformation.streamline.absorb">finn.transformation.streamline.absorb module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.streamline.html#module-finn.transformation.streamline.collapse_repeated">finn.transformation.streamline.collapse_repeated module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.streamline.html#module-finn.transformation.streamline.reorder">finn.transformation.streamline.reorder module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.streamline.html#module-finn.transformation.streamline.round_thresholds">finn.transformation.streamline.round_thresholds module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.streamline.html#module-finn.transformation.streamline.sign_to_thres">finn.transformation.streamline.sign_to_thres module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.streamline.html#module-finn.transformation.streamline">Module contents</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.html#module-finn.transformation.batchnorm_to_affine">finn.transformation.batchnorm_to_affine module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.html#module-finn.transformation.bipolar_to_xnor">finn.transformation.bipolar_to_xnor module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.html#module-finn.transformation.fold_constants">finn.transformation.fold_constants module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.html#module-finn.transformation.general">finn.transformation.general module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.html#module-finn.transformation.infer_datatypes">finn.transformation.infer_datatypes module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.html#module-finn.transformation.infer_shapes">finn.transformation.infer_shapes module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.html#module-finn.transformation">Module contents</a><ul> -<li class="toctree-l3"><a class="reference internal" href="finn.transformation.html#guide-to-writing-finn-transformations">Guide to writing FINN transformations</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="finn.util.html">finn.util package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="finn.util.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.util.html#module-finn.util.basic">finn.util.basic module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.util.html#module-finn.util.data_packing">finn.util.data_packing module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.util.html#module-finn.util.fpgadataflow">finn.util.fpgadataflow module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.util.html#module-finn.util.onnx">finn.util.onnx module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.util.html#module-finn.util.test">finn.util.test module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.util.html#module-finn.util">Module contents</a></li> -</ul> -</li> -</ul> -</div> -</div> -<div class="section" id="module-finn"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-finn" title="Permalink to this headline">¶</a></h2> -</div> -</div> - - - </div> - - </div> - <footer> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/finn.transformation.fpgadataflow.html b/docs/finn/_build/html/finn.transformation.fpgadataflow.html deleted file mode 100644 index 878f3de3419379036f7e778601297bc49218c8b3..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/finn.transformation.fpgadataflow.html +++ /dev/null @@ -1,432 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.fpgadataflow package — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - - <script type="text/javascript" src="_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> - <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" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="index.html">Docs</a> »</li> - - <li>finn.transformation.fpgadataflow package</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="_sources/finn.transformation.fpgadataflow.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="finn-transformation-fpgadataflow-package"> -<h1>finn.transformation.fpgadataflow package<a class="headerlink" href="#finn-transformation-fpgadataflow-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-finn.transformation.fpgadataflow.cleanup"> -<span id="finn-transformation-fpgadataflow-cleanup-module"></span><h2>finn.transformation.fpgadataflow.cleanup module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.cleanup" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.cleanup.CleanUp"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.cleanup.</code><code class="sig-name descname">CleanUp</code><a class="headerlink" href="#finn.transformation.fpgadataflow.cleanup.CleanUp" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Remove any generated files for fpgadataflow nodes.</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.cleanup.CleanUp.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.cleanup.CleanUp.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.fpgadataflow.codegen_ipgen"> -<span id="finn-transformation-fpgadataflow-codegen-ipgen-module"></span><h2>finn.transformation.fpgadataflow.codegen_ipgen module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.codegen_ipgen" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.codegen_ipgen.</code><code class="sig-name descname">CodeGen_ipgen</code><span class="sig-paren">(</span><em class="sig-param">fpgapart</em>, <em class="sig-param">clk</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Code generation for all nodes in model</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.fpgadataflow.codegen_ipstitch"> -<span id="finn-transformation-fpgadataflow-codegen-ipstitch-module"></span><h2>finn.transformation.fpgadataflow.codegen_ipstitch module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.codegen_ipstitch" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.codegen_ipstitch.</code><code class="sig-name descname">CodeGen_ipstitch</code><span class="sig-paren">(</span><em class="sig-param">fpgapart</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Create a Vivado IP Block Design project from all the generated IPs of a -graph. All nodes in the graph must have the fpgadataflow backend attribute, -and the CodeGen_ipgen transformation must have been previously run on -the graph. The resulting block design is also packaged as IP.</p> -<p>Outcome if successful: sets the vivado_stitch_proj attribute in the ONNX -ModelProto’s metadata_props field, with the created project dir as the -value. A make_project.tcl script is also placed under the same folder, -which is called to instantiate the per-layer IPs and stitch them together. -The packaged block design IP can be found under the ip subdirectory.</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.fpgadataflow.codegen_npysim"> -<span id="finn-transformation-fpgadataflow-codegen-npysim-module"></span><h2>finn.transformation.fpgadataflow.codegen_npysim module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.codegen_npysim" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.codegen_npysim.</code><code class="sig-name descname">CodeGen_npysim</code><a class="headerlink" href="#finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Code generation for all nodes in model</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.fpgadataflow.compile"> -<span id="finn-transformation-fpgadataflow-compile-module"></span><h2>finn.transformation.fpgadataflow.compile module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.compile" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.compile.Compile"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.compile.</code><code class="sig-name descname">Compile</code><a class="headerlink" href="#finn.transformation.fpgadataflow.compile.Compile" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Compile for all nodes in model</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.compile.Compile.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.compile.Compile.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.fpgadataflow.convert_to_hls_layers"> -<span id="finn-transformation-fpgadataflow-convert-to-hls-layers-module"></span><h2>finn.transformation.fpgadataflow.convert_to_hls_layers module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.convert_to_hls_layers" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.convert_to_hls_layers.</code><code class="sig-name descname">InferBinaryStreamingFCLayer</code><a class="headerlink" href="#finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Convert pairs of binary XnorPopcountMatMul layers to -StreamingFCLayer_Batch layers. Any immediately following MultiThreshold -layers will also be absorbed into the MVTU.</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.fpgadataflow.create_dataflow_partition"> -<span id="finn-transformation-fpgadataflow-create-dataflow-partition-module"></span><h2>finn.transformation.fpgadataflow.create_dataflow_partition module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.create_dataflow_partition" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.create_dataflow_partition.</code><code class="sig-name descname">CreateDataflowPartition</code><a class="headerlink" href="#finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Split a graph into two graphs; one which contains non-FINN-dataflow nodes -and a StreamingDataflowPartition node, and another which only contains -FINN dataflow nodes. The StreamingDataflowPartition has a model attribute -that indicates the filename for the second graph that only contains -dataflow nodes. No action is taken if there are no dataflow nodes.</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.fpgadataflow.hlssynth_ipgen"> -<span id="finn-transformation-fpgadataflow-hlssynth-ipgen-module"></span><h2>finn.transformation.fpgadataflow.hlssynth_ipgen module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.hlssynth_ipgen" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.hlssynth_ipgen.</code><code class="sig-name descname">HLSSynth_IPGen</code><a class="headerlink" href="#finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Compile for all nodes in model</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.fpgadataflow.insert_tlastmarker"> -<span id="finn-transformation-fpgadataflow-insert-tlastmarker-module"></span><h2>finn.transformation.fpgadataflow.insert_tlastmarker module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.insert_tlastmarker" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.insert_tlastmarker.</code><code class="sig-name descname">InsertTLastMarker</code><a class="headerlink" href="#finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Ensure that the graph is terminated with a TLastMarker node, inserting -one if necessary.</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.fpgadataflow.make_deployment"> -<span id="finn-transformation-fpgadataflow-make-deployment-module"></span><h2>finn.transformation.fpgadataflow.make_deployment module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.make_deployment" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.make_deployment.</code><code class="sig-name descname">DeployToPYNQ</code><span class="sig-paren">(</span><em class="sig-param">ip</em>, <em class="sig-param">username</em>, <em class="sig-param">password</em>, <em class="sig-param">target_dir</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Collects all necessary files for deployment and copies them to the PYNQ board. -Expects information about PYNQ board to make scp possible: -* ip address of board -* username and password for board -* target directory where the files are stored on the board</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.fpgadataflow.make_pynq_driver"> -<span id="finn-transformation-fpgadataflow-make-pynq-driver-module"></span><h2>finn.transformation.fpgadataflow.make_pynq_driver module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.make_pynq_driver" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.make_pynq_driver.</code><code class="sig-name descname">MakePYNQDriver</code><a class="headerlink" href="#finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Create PYNQ Python code to correctly interface the generated -accelerator, including data packing/unpacking. The MakePYNQProject -transformation must have been already applied.</p> -<p>Outcome if successful: sets the pynq_driver_dir attribute in the ONNX -ModelProto’s metadata_props field, with the created driver dir as the -value.</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.fpgadataflow.make_pynq_proj"> -<span id="finn-transformation-fpgadataflow-make-pynq-proj-module"></span><h2>finn.transformation.fpgadataflow.make_pynq_proj module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.make_pynq_proj" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.make_pynq_proj.</code><code class="sig-name descname">MakePYNQProject</code><span class="sig-paren">(</span><em class="sig-param">platform</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Create a Vivado PYNQ overlay project (including the shell infrastructure) -from the already-stitched IP block for this graph. -All nodes in the graph must have the fpgadataflow backend attribute, -and the CodeGen_ipstitch transformation must have been previously run on -the graph.</p> -<p>Outcome if successful: sets the vivado_pynq_proj attribute in the ONNX -ModelProto’s metadata_props field, with the created project dir as the -value.</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="finn-transformation-fpgadataflow-set-sim-mode-module"> -<h2>finn.transformation.fpgadataflow.set_sim_mode module<a class="headerlink" href="#finn-transformation-fpgadataflow-set-sim-mode-module" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-finn.transformation.fpgadataflow.synth_pynq_proj"> -<span id="finn-transformation-fpgadataflow-synth-pynq-proj-module"></span><h2>finn.transformation.fpgadataflow.synth_pynq_proj module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.synth_pynq_proj" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.synth_pynq_proj.</code><code class="sig-name descname">SynthPYNQProject</code><a class="headerlink" href="#finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Run synthesis for the PYNQ project for this graph. The MakePYNQProject -transformation must be applied prior to this transformation.</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.fpgadataflow.templates"> -<span id="finn-transformation-fpgadataflow-templates-module"></span><h2>finn.transformation.fpgadataflow.templates module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.templates" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-finn.transformation.fpgadataflow"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-finn.transformation.fpgadataflow" title="Permalink to this headline">¶</a></h2> -</div> -</div> - - - </div> - - </div> - <footer> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/finn.transformation.html b/docs/finn/_build/html/finn.transformation.html deleted file mode 100644 index 0407b0f9c34f15be6b0c1733b26419d5418a8c17..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/finn.transformation.html +++ /dev/null @@ -1,397 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation package — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - - <script type="text/javascript" src="_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> - <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" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="index.html">Docs</a> »</li> - - <li>finn.transformation package</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="_sources/finn.transformation.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="finn-transformation-package"> -<h1>finn.transformation package<a class="headerlink" href="#finn-transformation-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="subpackages"> -<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.cleanup">finn.transformation.fpgadataflow.cleanup module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.codegen_ipgen">finn.transformation.fpgadataflow.codegen_ipgen module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.codegen_ipstitch">finn.transformation.fpgadataflow.codegen_ipstitch module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.codegen_npysim">finn.transformation.fpgadataflow.codegen_npysim module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.compile">finn.transformation.fpgadataflow.compile module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.convert_to_hls_layers">finn.transformation.fpgadataflow.convert_to_hls_layers module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.create_dataflow_partition">finn.transformation.fpgadataflow.create_dataflow_partition module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.hlssynth_ipgen">finn.transformation.fpgadataflow.hlssynth_ipgen module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.insert_tlastmarker">finn.transformation.fpgadataflow.insert_tlastmarker module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.make_deployment">finn.transformation.fpgadataflow.make_deployment module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.make_pynq_driver">finn.transformation.fpgadataflow.make_pynq_driver module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.make_pynq_proj">finn.transformation.fpgadataflow.make_pynq_proj module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.fpgadataflow.html#finn-transformation-fpgadataflow-set-sim-mode-module">finn.transformation.fpgadataflow.set_sim_mode module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.synth_pynq_proj">finn.transformation.fpgadataflow.synth_pynq_proj module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.templates">finn.transformation.fpgadataflow.templates module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow">Module contents</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="finn.transformation.streamline.html">finn.transformation.streamline package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.streamline.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.streamline.html#module-finn.transformation.streamline.absorb">finn.transformation.streamline.absorb module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.streamline.html#module-finn.transformation.streamline.collapse_repeated">finn.transformation.streamline.collapse_repeated module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.streamline.html#module-finn.transformation.streamline.reorder">finn.transformation.streamline.reorder module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.streamline.html#module-finn.transformation.streamline.round_thresholds">finn.transformation.streamline.round_thresholds module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.streamline.html#module-finn.transformation.streamline.sign_to_thres">finn.transformation.streamline.sign_to_thres module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.transformation.streamline.html#module-finn.transformation.streamline">Module contents</a></li> -</ul> -</li> -</ul> -</div> -</div> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-finn.transformation.batchnorm_to_affine"> -<span id="finn-transformation-batchnorm-to-affine-module"></span><h2>finn.transformation.batchnorm_to_affine module<a class="headerlink" href="#module-finn.transformation.batchnorm_to_affine" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.batchnorm_to_affine.BatchNormToAffine"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.batchnorm_to_affine.</code><code class="sig-name descname">BatchNormToAffine</code><a class="headerlink" href="#finn.transformation.batchnorm_to_affine.BatchNormToAffine" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Replaces any test-time BatchNorm layers with Mul-Add layers.</p> -<dl class="method"> -<dt id="finn.transformation.batchnorm_to_affine.BatchNormToAffine.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.batchnorm_to_affine.BatchNormToAffine.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.bipolar_to_xnor"> -<span id="finn-transformation-bipolar-to-xnor-module"></span><h2>finn.transformation.bipolar_to_xnor module<a class="headerlink" href="#module-finn.transformation.bipolar_to_xnor" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.bipolar_to_xnor.</code><code class="sig-name descname">ConvertBipolarMatMulToXnorPopcount</code><a class="headerlink" href="#finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Convert MatMul nodes with all-bipolar inputs to XnorPopcountMatMul -and associated result correction.</p> -<dl class="method"> -<dt id="finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.fold_constants"> -<span id="finn-transformation-fold-constants-module"></span><h2>finn.transformation.fold_constants module<a class="headerlink" href="#module-finn.transformation.fold_constants" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.fold_constants.FoldConstants"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fold_constants.</code><code class="sig-name descname">FoldConstants</code><a class="headerlink" href="#finn.transformation.fold_constants.FoldConstants" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Replace the output of a node with const-only inputs with a precomputed -result.</p> -<dl class="method"> -<dt id="finn.transformation.fold_constants.FoldConstants.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fold_constants.FoldConstants.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.general"> -<span id="finn-transformation-general-module"></span><h2>finn.transformation.general module<a class="headerlink" href="#module-finn.transformation.general" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.general.ConvertSubToAdd"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.general.</code><code class="sig-name descname">ConvertSubToAdd</code><a class="headerlink" href="#finn.transformation.general.ConvertSubToAdd" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Convert sub nodes to add nodes of appropriate sign.</p> -<dl class="method"> -<dt id="finn.transformation.general.ConvertSubToAdd.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.general.ConvertSubToAdd.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.general.GiveRandomTensorNames"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.general.</code><code class="sig-name descname">GiveRandomTensorNames</code><a class="headerlink" href="#finn.transformation.general.GiveRandomTensorNames" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Give random tensor names to all tensors.</p> -<dl class="method"> -<dt id="finn.transformation.general.GiveRandomTensorNames.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.general.GiveRandomTensorNames.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.general.GiveReadableTensorNames"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.general.</code><code class="sig-name descname">GiveReadableTensorNames</code><a class="headerlink" href="#finn.transformation.general.GiveReadableTensorNames" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Give more human-readable names to all internal tensors. It’s recommended -to apply give_unique_node_names prior to this transform.</p> -<dl class="method"> -<dt id="finn.transformation.general.GiveReadableTensorNames.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.general.GiveReadableTensorNames.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.general.GiveUniqueNodeNames"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.general.</code><code class="sig-name descname">GiveUniqueNodeNames</code><a class="headerlink" href="#finn.transformation.general.GiveUniqueNodeNames" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Give unique names to each node in the graph using enumeration.</p> -<dl class="method"> -<dt id="finn.transformation.general.GiveUniqueNodeNames.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.general.GiveUniqueNodeNames.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.infer_datatypes"> -<span id="finn-transformation-infer-datatypes-module"></span><h2>finn.transformation.infer_datatypes module<a class="headerlink" href="#module-finn.transformation.infer_datatypes" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.infer_datatypes.InferDataTypes"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.infer_datatypes.</code><code class="sig-name descname">InferDataTypes</code><a class="headerlink" href="#finn.transformation.infer_datatypes.InferDataTypes" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Infer FINN DataType info for all intermediate/output tensors based on -inputs and node type.</p> -<dl class="method"> -<dt id="finn.transformation.infer_datatypes.InferDataTypes.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.infer_datatypes.InferDataTypes.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.infer_shapes"> -<span id="finn-transformation-infer-shapes-module"></span><h2>finn.transformation.infer_shapes module<a class="headerlink" href="#module-finn.transformation.infer_shapes" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.infer_shapes.InferShapes"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.infer_shapes.</code><code class="sig-name descname">InferShapes</code><a class="headerlink" href="#finn.transformation.infer_shapes.InferShapes" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Ensure every tensor in the model has a specified shape (ValueInfo).</p> -<dl class="method"> -<dt id="finn.transformation.infer_shapes.InferShapes.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.infer_shapes.InferShapes.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-finn.transformation" title="Permalink to this headline">¶</a></h2> -<div class="section" id="guide-to-writing-finn-transformations"> -<h3>Guide to writing FINN transformations<a class="headerlink" href="#guide-to-writing-finn-transformations" title="Permalink to this headline">¶</a></h3> -<ul class="simple"> -<li><p>Your transformation must inherit the Transformation abstract base class.</p></li> -<li><p>Your transformation’s apply function should take in a ModelWrapper, and return -a tuple with (transformed_model: ModelWrapper, model_was_changed: Bool)</p></li> -<li><p>The transformations are meant to be applied using the .transform function -in ModelWrapper. This makes a deep copy of the input model by default, so -you don’t have to.</p></li> -<li><p>model_was_changed indicates whether your transformation made any changes to -the model. If you know your transformation needs to be called only once and -repeated calls have no further effect, you can return False even if the model -was changed.</p></li> -<li><p>You MUST return model_was_changed=False at some point when your transformation -is called multiple times, otherwise apply_repeated() will loop infinitely.</p></li> -<li><p>If you cannot guarantee that the transformation will reach a fixed point, -you must declare this, return model_was_changed = False and let the user -manually re-apply the transform.</p></li> -</ul> -<dl class="class"> -<dt id="finn.transformation.Transformation"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.</code><code class="sig-name descname">Transformation</code><a class="headerlink" href="#finn.transformation.Transformation" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p> -<dl class="method"> -<dt id="finn.transformation.Transformation.apply"> -<em class="property">abstract </em><code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.Transformation.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -</div> -</div> - - - </div> - - </div> - <footer> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/finn.transformation.streamline.html b/docs/finn/_build/html/finn.transformation.streamline.html deleted file mode 100644 index 71b17814dc8cd54e1d43ffee62da4bf40399ef46..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/finn.transformation.streamline.html +++ /dev/null @@ -1,378 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.streamline package — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - - <script type="text/javascript" src="_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> - <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" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <!-- Local TOC --> - <div class="local-toc"><ul> -<li><a class="reference internal" href="#">finn.transformation.streamline package</a><ul> -<li><a class="reference internal" href="#submodules">Submodules</a></li> -<li><a class="reference internal" href="#module-finn.transformation.streamline.absorb">finn.transformation.streamline.absorb module</a></li> -<li><a class="reference internal" href="#module-finn.transformation.streamline.collapse_repeated">finn.transformation.streamline.collapse_repeated module</a></li> -<li><a class="reference internal" href="#module-finn.transformation.streamline.reorder">finn.transformation.streamline.reorder module</a></li> -<li><a class="reference internal" href="#module-finn.transformation.streamline.round_thresholds">finn.transformation.streamline.round_thresholds module</a></li> -<li><a class="reference internal" href="#module-finn.transformation.streamline.sign_to_thres">finn.transformation.streamline.sign_to_thres module</a></li> -<li><a class="reference internal" href="#module-finn.transformation.streamline">Module contents</a></li> -</ul> -</li> -</ul> -</div> - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="index.html">Docs</a> »</li> - - <li>finn.transformation.streamline package</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="_sources/finn.transformation.streamline.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="finn-transformation-streamline-package"> -<h1>finn.transformation.streamline package<a class="headerlink" href="#finn-transformation-streamline-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-finn.transformation.streamline.absorb"> -<span id="finn-transformation-streamline-absorb-module"></span><h2>finn.transformation.streamline.absorb module<a class="headerlink" href="#module-finn.transformation.streamline.absorb" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.absorb.</code><code class="sig-name descname">Absorb1BitMulIntoMatMul</code><a class="headerlink" href="#finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Absorb bipolar or binary multiplications into the preciding matrix -multiply.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.absorb.</code><code class="sig-name descname">AbsorbAddIntoMultiThreshold</code><a class="headerlink" href="#finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Absorb preceding Add ops into MultiThreshold by updating the threshold -values. Only scalar/1D add vectors can be absorbed.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.absorb.</code><code class="sig-name descname">AbsorbMulIntoMultiThreshold</code><a class="headerlink" href="#finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Absorb preceding Mul ops into MultiThreshold by updating the threshold -values. Only <em>positive</em> scalar/1D mul vectors can be absorbed.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.streamline.absorb.FactorOutMulSignMagnitude"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.absorb.</code><code class="sig-name descname">FactorOutMulSignMagnitude</code><a class="headerlink" href="#finn.transformation.streamline.absorb.FactorOutMulSignMagnitude" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Split multiply-by-constant nodes into two multiply-by-constant nodes, -where the first node is a bipolar vector (of signs) and the second is a -vector of magnitudes.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.absorb.FactorOutMulSignMagnitude.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.absorb.FactorOutMulSignMagnitude.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.streamline.collapse_repeated"> -<span id="finn-transformation-streamline-collapse-repeated-module"></span><h2>finn.transformation.streamline.collapse_repeated module<a class="headerlink" href="#module-finn.transformation.streamline.collapse_repeated" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.streamline.collapse_repeated.CollapseRepeatedAdd"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.collapse_repeated.</code><code class="sig-name descname">CollapseRepeatedAdd</code><a class="headerlink" href="#finn.transformation.streamline.collapse_repeated.CollapseRepeatedAdd" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp" title="finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp</span></code></a></p> -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.streamline.collapse_repeated.CollapseRepeatedMul"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.collapse_repeated.</code><code class="sig-name descname">CollapseRepeatedMul</code><a class="headerlink" href="#finn.transformation.streamline.collapse_repeated.CollapseRepeatedMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp" title="finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp</span></code></a></p> -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.collapse_repeated.</code><code class="sig-name descname">CollapseRepeatedOp</code><span class="sig-paren">(</span><em class="sig-param">op_name</em>, <em class="sig-param">make_collapsed_param_fxn</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Collapse repeated consecutive operations with constant parameters into -a single operation. make_collapsed_param_fxn must take two tensors and -return a tensor which gives the equivalent result using a single op.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.streamline.reorder"> -<span id="finn-transformation-streamline-reorder-module"></span><h2>finn.transformation.streamline.reorder module<a class="headerlink" href="#module-finn.transformation.streamline.reorder" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.streamline.reorder.MoveAddPastMul"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.reorder.</code><code class="sig-name descname">MoveAddPastMul</code><a class="headerlink" href="#finn.transformation.streamline.reorder.MoveAddPastMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Move add operations past multiply operations. The aim is to have them -next to each other such that they can be collapsed into a single add.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.reorder.MoveAddPastMul.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.reorder.MoveAddPastMul.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.streamline.reorder.MoveScalarAddPastMatMul"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.reorder.</code><code class="sig-name descname">MoveScalarAddPastMatMul</code><a class="headerlink" href="#finn.transformation.streamline.reorder.MoveScalarAddPastMatMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Move scalar add operations past matmul operations. We want to have adds -next to each other such that they can be collapsed into a single add.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.reorder.MoveScalarAddPastMatMul.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.reorder.MoveScalarAddPastMatMul.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.streamline.reorder.MoveScalarMulPastMatMul"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.reorder.</code><code class="sig-name descname">MoveScalarMulPastMatMul</code><a class="headerlink" href="#finn.transformation.streamline.reorder.MoveScalarMulPastMatMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Move scalar mul operations past matmul operations. We want to have muls -next to each other such that they can be collapsed into a single mul.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.reorder.MoveScalarMulPastMatMul.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.reorder.MoveScalarMulPastMatMul.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.streamline.round_thresholds"> -<span id="finn-transformation-streamline-round-thresholds-module"></span><h2>finn.transformation.streamline.round_thresholds module<a class="headerlink" href="#module-finn.transformation.streamline.round_thresholds" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.streamline.round_thresholds.RoundAndClipThresholds"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.round_thresholds.</code><code class="sig-name descname">RoundAndClipThresholds</code><a class="headerlink" href="#finn.transformation.streamline.round_thresholds.RoundAndClipThresholds" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>For MultiThreshold nodes operating on integer inputs, round up -thresholds values to the nearest integer. Additionally, if the input -is unsigned, sets negative thresholds to zero.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.round_thresholds.RoundAndClipThresholds.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.round_thresholds.RoundAndClipThresholds.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.streamline.sign_to_thres"> -<span id="finn-transformation-streamline-sign-to-thres-module"></span><h2>finn.transformation.streamline.sign_to_thres module<a class="headerlink" href="#module-finn.transformation.streamline.sign_to_thres" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.streamline.sign_to_thres.ConvertSignToThres"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.sign_to_thres.</code><code class="sig-name descname">ConvertSignToThres</code><a class="headerlink" href="#finn.transformation.streamline.sign_to_thres.ConvertSignToThres" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Convert Sign node instances to MultiThreshold with threshold at 0.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.sign_to_thres.ConvertSignToThres.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.sign_to_thres.ConvertSignToThres.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-finn.transformation.streamline"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-finn.transformation.streamline" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.transformation.streamline.Streamline"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.</code><code class="sig-name descname">Streamline</code><a class="headerlink" href="#finn.transformation.streamline.Streamline" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Apply the streamlining transform, see arXiv:1709.04060.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.Streamline.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.Streamline.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -</div> - - - </div> - - </div> - <footer> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/finn.util.html b/docs/finn/_build/html/finn.util.html deleted file mode 100644 index 43db0f7d42f93137e07110ae9707429096ae3e05..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/finn.util.html +++ /dev/null @@ -1,473 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.util package — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - - <script type="text/javascript" src="_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> - <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" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <!-- Local TOC --> - <div class="local-toc"><ul> -<li><a class="reference internal" href="#">finn.util package</a><ul> -<li><a class="reference internal" href="#submodules">Submodules</a></li> -<li><a class="reference internal" href="#module-finn.util.basic">finn.util.basic module</a></li> -<li><a class="reference internal" href="#module-finn.util.data_packing">finn.util.data_packing module</a></li> -<li><a class="reference internal" href="#module-finn.util.fpgadataflow">finn.util.fpgadataflow module</a></li> -<li><a class="reference internal" href="#module-finn.util.onnx">finn.util.onnx module</a></li> -<li><a class="reference internal" href="#module-finn.util.test">finn.util.test module</a></li> -<li><a class="reference internal" href="#module-finn.util">Module contents</a></li> -</ul> -</li> -</ul> -</div> - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="index.html">Docs</a> »</li> - - <li>finn.util package</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="_sources/finn.util.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="finn-util-package"> -<h1>finn.util package<a class="headerlink" href="#finn-util-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-finn.util.basic"> -<span id="finn-util-basic-module"></span><h2>finn.util.basic module<a class="headerlink" href="#module-finn.util.basic" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.util.basic.CppBuilder"> -<em class="property">class </em><code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">CppBuilder</code><a class="headerlink" href="#finn.util.basic.CppBuilder" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> -<dl class="method"> -<dt id="finn.util.basic.CppBuilder.append_includes"> -<code class="sig-name descname">append_includes</code><span class="sig-paren">(</span><em class="sig-param">library_path</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.CppBuilder.append_includes" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.util.basic.CppBuilder.append_sources"> -<code class="sig-name descname">append_sources</code><span class="sig-paren">(</span><em class="sig-param">cpp_file</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.CppBuilder.append_sources" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.util.basic.CppBuilder.build"> -<code class="sig-name descname">build</code><span class="sig-paren">(</span><em class="sig-param">code_gen_dir</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.CppBuilder.build" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.util.basic.CppBuilder.set_executable_path"> -<code class="sig-name descname">set_executable_path</code><span class="sig-paren">(</span><em class="sig-param">path</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.CppBuilder.set_executable_path" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.calculate_signed_dot_prod_range"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">calculate_signed_dot_prod_range</code><span class="sig-paren">(</span><em class="sig-param">dt_a</em>, <em class="sig-param">dt_b</em>, <em class="sig-param">len</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.calculate_signed_dot_prod_range" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the (min,max) values a dot product between two signed vectors of -types dt_a and dt_b of len elements can take.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.gen_finn_dt_tensor"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">gen_finn_dt_tensor</code><span class="sig-paren">(</span><em class="sig-param">finn_dt</em>, <em class="sig-param">tensor_shape</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.gen_finn_dt_tensor" title="Permalink to this definition">¶</a></dt> -<dd><p>Generates random tensor in given shape and with given FINN DataType</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.get_by_name"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">get_by_name</code><span class="sig-paren">(</span><em class="sig-param">container</em>, <em class="sig-param">name</em>, <em class="sig-param">name_field='name'</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.get_by_name" title="Permalink to this definition">¶</a></dt> -<dd><p>Return item from container by .name field if it exists, None otherwise</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.get_finn_root"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">get_finn_root</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.get_finn_root" title="Permalink to this definition">¶</a></dt> -<dd><p>Return the root directory that FINN is cloned into.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.interleave_matrix_outer_dim_from_partitions"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">interleave_matrix_outer_dim_from_partitions</code><span class="sig-paren">(</span><em class="sig-param">matrix</em>, <em class="sig-param">n_partitions</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.interleave_matrix_outer_dim_from_partitions" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.make_build_dir"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">make_build_dir</code><span class="sig-paren">(</span><em class="sig-param">prefix=''</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.make_build_dir" title="Permalink to this definition">¶</a></dt> -<dd><p>Creates a temporary folder with given prefix to be used as a build dir. -Use this function instead of tempfile.mkdtemp to ensure any generated files -will survive on the host after the FINN Docker container exits.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.pad_tensor_to_multiple_of"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">pad_tensor_to_multiple_of</code><span class="sig-paren">(</span><em class="sig-param">ndarray</em>, <em class="sig-param">pad_to_dims</em>, <em class="sig-param">val=0</em>, <em class="sig-param">distr_pad=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.pad_tensor_to_multiple_of" title="Permalink to this definition">¶</a></dt> -<dd><p>Pad each dimension of given NumPy ndarray using val, so that each -dimension is a multiple of the respective value in pad_to_dims. -1 means -do not pad that particular dimension. If distr_pad is False, all padding -will be inserted after the existing values; otherwise it will be split -evenly between before and after the existing values, with one extra value -inserted after if the padding amount is not divisible by two.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.random_string"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">random_string</code><span class="sig-paren">(</span><em class="sig-param">stringLength=6</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.random_string" title="Permalink to this definition">¶</a></dt> -<dd><p>Randomly generate a string of letters and digits.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.remove_by_name"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">remove_by_name</code><span class="sig-paren">(</span><em class="sig-param">container</em>, <em class="sig-param">name</em>, <em class="sig-param">name_field='name'</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.remove_by_name" title="Permalink to this definition">¶</a></dt> -<dd><p>Remove item from container by .name field if it exists</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.roundup_to_integer_multiple"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">roundup_to_integer_multiple</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">factor</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.roundup_to_integer_multiple" title="Permalink to this definition">¶</a></dt> -<dd><p>Round up integer x to the nearest integer multiple of integer factor. -Returns x if factor is set to -1. Both x and factor must otherwise be -positive.</p> -</dd></dl> - -</div> -<div class="section" id="module-finn.util.data_packing"> -<span id="finn-util-data-packing-module"></span><h2>finn.util.data_packing module<a class="headerlink" href="#module-finn.util.data_packing" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<dt id="finn.util.data_packing.array2hexstring"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">array2hexstring</code><span class="sig-paren">(</span><em class="sig-param">array</em>, <em class="sig-param">dtype</em>, <em class="sig-param">pad_to_nbits</em>, <em class="sig-param">prefix='0x'</em>, <em class="sig-param">reverse=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.array2hexstring" title="Permalink to this definition">¶</a></dt> -<dd><p>Pack given one-dimensional NumPy array with FINN DataType dtype into a hex -string. -Any BIPOLAR values will be converted to a single bit with a 0 representing --1. -pad_to_nbits is used to prepend leading zeros to ensure packed strings of -fixed width. The minimum value for pad_to_nbits is 4, since a single hex -digit is four bits. reverse can be used to reverse the array prior to -packing.</p> -<p>Examples: -array2hexstring([1, 1, 1, 0], DataType.BINARY, 4) = “0xe†-array2hexstring([1, 1, 1, 0], DataType.BINARY, 8) = “0x0e†-array2hexstring([1, 1, 0, 1], DataType.BINARY, 4, reverse=True) = “0xb†-array2hexstring([1, 1, 1, 0], DataType.BINARY, 8, reverse=True) = “0x07â€</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.finnpy_to_packed_bytearray"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">finnpy_to_packed_bytearray</code><span class="sig-paren">(</span><em class="sig-param">ndarray</em>, <em class="sig-param">dtype</em>, <em class="sig-param">reverse_inner=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.finnpy_to_packed_bytearray" title="Permalink to this definition">¶</a></dt> -<dd><p>Given a numpy ndarray with FINN DataType dtype, pack the innermost -dimension and return the packed representation as an ndarray of uint8. -The packed innermost dimension will be padded to the nearest multiple -of 8 bits. The returned ndarray has the same number of dimensions as the -input.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.hexstring2npbytearray"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">hexstring2npbytearray</code><span class="sig-paren">(</span><em class="sig-param">hexstring</em>, <em class="sig-param">remove_prefix='0x'</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.hexstring2npbytearray" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert a hex string into a NumPy array of dtype uint8. Examples:</p> -<p>hexstring2npbytearray(“0f01â€) = array([15, 1], dtype=uint8)</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.npbytearray2hexstring"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">npbytearray2hexstring</code><span class="sig-paren">(</span><em class="sig-param">npbytearray</em>, <em class="sig-param">prefix='0x'</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.npbytearray2hexstring" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert a NumPy array of uint8 dtype into a hex string. Examples:</p> -<p>npbytearray2hexstring(array([15, 1], dtype=uint8)) = “0x0f01â€</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.npy_to_rtlsim_input"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">npy_to_rtlsim_input</code><span class="sig-paren">(</span><em class="sig-param">input_file</em>, <em class="sig-param">input_dtype</em>, <em class="sig-param">pad_to_nbits</em>, <em class="sig-param">reverse_inner=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.npy_to_rtlsim_input" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert the multidimensional NumPy array of integers (stored as floats) -from input_file into a flattened sequence of Python arbitrary-precision -integers, packing the innermost dimension. See -finn.util.basic.pack_innermost_dim_as_hex_string() for more info on how the -packing works. If reverse_inner is set, the innermost dimension will be -reversed prior to packing.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.numpy_to_hls_code"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">numpy_to_hls_code</code><span class="sig-paren">(</span><em class="sig-param">ndarray</em>, <em class="sig-param">dtype</em>, <em class="sig-param">hls_var_name</em>, <em class="sig-param">pack_innermost_dim=True</em>, <em class="sig-param">no_decl=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.numpy_to_hls_code" title="Permalink to this definition">¶</a></dt> -<dd><p>Return C++ code representation of a numpy ndarray with FINN DataType -dtype, using hls_var_name as the resulting C++ variable name. If -pack_innermost_dim is specified, the innermost dimension of the ndarray -will be packed into a hex string using array2hexstring. If no_decl is -set to True, no variable name and type will be generated as part of the -emitted string.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.pack_innermost_dim_as_hex_string"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">pack_innermost_dim_as_hex_string</code><span class="sig-paren">(</span><em class="sig-param">ndarray</em>, <em class="sig-param">dtype</em>, <em class="sig-param">pad_to_nbits</em>, <em class="sig-param">reverse_inner=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.pack_innermost_dim_as_hex_string" title="Permalink to this definition">¶</a></dt> -<dd><p>Pack the innermost dimension of the given numpy ndarray into hex -strings using array2hexstring. Examples:</p> -<p>A = [[1, 1, 1, 0], [0, 1, 1, 0]] -eA = [“0eâ€, “06â€] -pack_innermost_dim_as_hex_string(A, DataType.BINARY, 8) == eA -B = [[[3, 3], [3, 3]], [[1, 3], [3, 1]]] -eB = [[ “0fâ€, “0fâ€], [“07â€, “0dâ€]] -pack_innermost_dim_as_hex_string(B, DataType.UINT2, 8) == eB</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.packed_bytearray_to_finnpy"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">packed_bytearray_to_finnpy</code><span class="sig-paren">(</span><em class="sig-param">packed_bytearray</em>, <em class="sig-param">dtype</em>, <em class="sig-param">output_shape=None</em>, <em class="sig-param">reverse_inner=False</em>, <em class="sig-param">reverse_endian=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.packed_bytearray_to_finnpy" title="Permalink to this definition">¶</a></dt> -<dd><p>Given a packed numpy uint8 ndarray, unpack it into a FINN array of -given DataType. output_shape can be specified to remove padding from the -packed dimension, or set to None to be inferred from the input.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.rtlsim_output_to_npy"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">rtlsim_output_to_npy</code><span class="sig-paren">(</span><em class="sig-param">output</em>, <em class="sig-param">path</em>, <em class="sig-param">dtype</em>, <em class="sig-param">shape</em>, <em class="sig-param">packedBits</em>, <em class="sig-param">targetBits</em>, <em class="sig-param">reverse_inner=True</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.rtlsim_output_to_npy" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert a flattened sequence of Python arbitrary-precision integers -output into a NumPy array, saved as npy file at path. Each arbitrary-precision -integer is assumed to be a packed array of targetBits-bit elements, which -will be unpacked as the innermost dimension of the NumPy array.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.unpack_innermost_dim_from_hex_string"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">unpack_innermost_dim_from_hex_string</code><span class="sig-paren">(</span><em class="sig-param">ndarray</em>, <em class="sig-param">dtype</em>, <em class="sig-param">out_shape</em>, <em class="sig-param">reverse_inner=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.unpack_innermost_dim_from_hex_string" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert a NumPy array of hex strings into a FINN NumPy array by unpacking -the hex strings into the specified data type. out_shape can be specified -such that any padding in the packing dimension is removed. If reverse_inner -is set, the innermost unpacked dimension will be reversed.</p> -</dd></dl> - -</div> -<div class="section" id="module-finn.util.fpgadataflow"> -<span id="finn-util-fpgadataflow-module"></span><h2>finn.util.fpgadataflow module<a class="headerlink" href="#module-finn.util.fpgadataflow" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="finn.util.fpgadataflow.IPGenBuilder"> -<em class="property">class </em><code class="sig-prename descclassname">finn.util.fpgadataflow.</code><code class="sig-name descname">IPGenBuilder</code><a class="headerlink" href="#finn.util.fpgadataflow.IPGenBuilder" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> -<dl class="method"> -<dt id="finn.util.fpgadataflow.IPGenBuilder.append_tcl"> -<code class="sig-name descname">append_tcl</code><span class="sig-paren">(</span><em class="sig-param">tcl_script</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.fpgadataflow.IPGenBuilder.append_tcl" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.util.fpgadataflow.IPGenBuilder.build"> -<code class="sig-name descname">build</code><span class="sig-paren">(</span><em class="sig-param">code_gen_dir</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.fpgadataflow.IPGenBuilder.build" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.util.fpgadataflow.IPGenBuilder.set_ipgen_path"> -<code class="sig-name descname">set_ipgen_path</code><span class="sig-paren">(</span><em class="sig-param">path</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.fpgadataflow.IPGenBuilder.set_ipgen_path" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="function"> -<dt id="finn.util.fpgadataflow.pyverilate_stitched_ip"> -<code class="sig-prename descclassname">finn.util.fpgadataflow.</code><code class="sig-name descname">pyverilate_stitched_ip</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.fpgadataflow.pyverilate_stitched_ip" title="Permalink to this definition">¶</a></dt> -<dd><p>Given a model with stitched IP, return a PyVerilator sim object.</p> -</dd></dl> - -</div> -<div class="section" id="module-finn.util.onnx"> -<span id="finn-util-onnx-module"></span><h2>finn.util.onnx module<a class="headerlink" href="#module-finn.util.onnx" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<dt id="finn.util.onnx.valueinfo_to_tensor"> -<code class="sig-prename descclassname">finn.util.onnx.</code><code class="sig-name descname">valueinfo_to_tensor</code><span class="sig-paren">(</span><em class="sig-param">vi</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.onnx.valueinfo_to_tensor" title="Permalink to this definition">¶</a></dt> -<dd><p>Creates an all-zeroes numpy tensor from a ValueInfoProto.</p> -</dd></dl> - -</div> -<div class="section" id="module-finn.util.test"> -<span id="finn-util-test-module"></span><h2>finn.util.test module<a class="headerlink" href="#module-finn.util.test" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<dt id="finn.util.test.get_test_model_def_fxn"> -<code class="sig-prename descclassname">finn.util.test.</code><code class="sig-name descname">get_test_model_def_fxn</code><span class="sig-paren">(</span><em class="sig-param">netname</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.test.get_test_model_def_fxn" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="function"> -<dt id="finn.util.test.get_test_model_trained"> -<code class="sig-prename descclassname">finn.util.test.</code><code class="sig-name descname">get_test_model_trained</code><span class="sig-paren">(</span><em class="sig-param">netname</em>, <em class="sig-param">wbits</em>, <em class="sig-param">abits</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.test.get_test_model_trained" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="function"> -<dt id="finn.util.test.get_test_model_untrained"> -<code class="sig-prename descclassname">finn.util.test.</code><code class="sig-name descname">get_test_model_untrained</code><span class="sig-paren">(</span><em class="sig-param">netname</em>, <em class="sig-param">wbits</em>, <em class="sig-param">abits</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.test.get_test_model_untrained" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="function"> -<dt id="finn.util.test.get_trained_checkpoint"> -<code class="sig-prename descclassname">finn.util.test.</code><code class="sig-name descname">get_trained_checkpoint</code><span class="sig-paren">(</span><em class="sig-param">netname</em>, <em class="sig-param">wbits</em>, <em class="sig-param">abits</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.test.get_trained_checkpoint" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</div> -<div class="section" id="module-finn.util"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-finn.util" title="Permalink to this headline">¶</a></h2> -</div> -</div> - - - </div> - - </div> - <footer> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/modules.html b/docs/finn/_build/html/modules.html index 7c636d62bfd1cf05ba02863e78905095c5857239..51ddff4229c4cd3061102432e6062432d0c5b7c6 100644 --- a/docs/finn/_build/html/modules.html +++ b/docs/finn/_build/html/modules.html @@ -8,7 +8,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>src — FINN documentation</title> + <title><no title> — FINN documentation</title> @@ -127,7 +127,7 @@ <li><a href="index.html">Docs</a> »</li> - <li>src</li> + <li><no title></li> <li class="wy-breadcrumbs-aside"> @@ -146,10 +146,9 @@ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> - <div class="section" id="src"> -<h1>src<a class="headerlink" href="#src" title="Permalink to this headline">¶</a></h1> + <p>finn +===</p> <div class="toctree-wrapper compound"> -</div> </div> diff --git a/docs/finn/_build/html/objects.inv b/docs/finn/_build/html/objects.inv index 2a4e77eea14176ccb516ab4444a424fe97632698..c4f824352f5aefbdf0ed1bf3ed0e4c5174c7e58b 100644 Binary files a/docs/finn/_build/html/objects.inv and b/docs/finn/_build/html/objects.inv differ diff --git a/docs/finn/_build/html/searchindex.js b/docs/finn/_build/html/searchindex.js index 92106d0fc815ed50700aaf4ab614eac233b083b0..d49f110e523558380b2106e0920833a8d38f95c3 100644 --- a/docs/finn/_build/html/searchindex.js +++ b/docs/finn/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["end_to_end_flow","getting_started","index","modules","source_code","source_code/finn","source_code/finn.analysis","source_code/finn.analysis.fpgadataflow","source_code/finn.core","source_code/finn.custom_op","source_code/finn.custom_op.fpgadataflow","source_code/finn.transformation","source_code/finn.transformation.fpgadataflow","source_code/finn.transformation.streamline","source_code/finn.util","source_code/modules"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:56},filenames:["end_to_end_flow.rst","getting_started.rst","index.rst","modules.rst","source_code.rst","source_code/finn.rst","source_code/finn.analysis.rst","source_code/finn.analysis.fpgadataflow.rst","source_code/finn.core.rst","source_code/finn.custom_op.rst","source_code/finn.custom_op.fpgadataflow.rst","source_code/finn.transformation.rst","source_code/finn.transformation.fpgadataflow.rst","source_code/finn.transformation.streamline.rst","source_code/finn.util.rst","source_code/modules.rst"],objects:{"":{finn:[5,0,0,"-"]},"finn.analysis":{fpgadataflow:[7,0,0,"-"],topology:[6,0,0,"-"],verify_custom_nodes:[6,0,0,"-"]},"finn.analysis.fpgadataflow":{hls_synth_res_estimation:[7,0,0,"-"],res_estimation:[7,0,0,"-"]},"finn.analysis.fpgadataflow.hls_synth_res_estimation":{hls_synth_res_estimation:[7,1,1,""]},"finn.analysis.fpgadataflow.res_estimation":{res_estimation:[7,1,1,""]},"finn.analysis.topology":{all_tensors_f32:[6,1,1,""],get_per_tensor_fanouts:[6,1,1,""],is_linear:[6,1,1,""],node_inputs_in_expected_order:[6,1,1,""]},"finn.analysis.verify_custom_nodes":{verify_nodes:[6,1,1,""]},"finn.core":{datatype:[8,0,0,"-"],execute_custom_node:[8,0,0,"-"],modelwrapper:[8,0,0,"-"],onnx_exec:[8,0,0,"-"],remote_exec:[8,0,0,"-"],rtlsim_exec:[8,0,0,"-"]},"finn.core.datatype":{DataType:[8,2,1,""]},"finn.core.datatype.DataType":{BINARY:[8,3,1,""],BIPOLAR:[8,3,1,""],FLOAT32:[8,3,1,""],INT16:[8,3,1,""],INT2:[8,3,1,""],INT32:[8,3,1,""],INT3:[8,3,1,""],INT4:[8,3,1,""],INT8:[8,3,1,""],TERNARY:[8,3,1,""],UINT16:[8,3,1,""],UINT2:[8,3,1,""],UINT32:[8,3,1,""],UINT3:[8,3,1,""],UINT4:[8,3,1,""],UINT8:[8,3,1,""],allowed:[8,4,1,""],bitwidth:[8,4,1,""],get_hls_datatype_str:[8,4,1,""],get_num_possible_values:[8,4,1,""],get_smallest_possible:[8,4,1,""],is_integer:[8,4,1,""],max:[8,4,1,""],min:[8,4,1,""],signed:[8,4,1,""]},"finn.core.execute_custom_node":{execute_custom_node:[8,1,1,""]},"finn.core.modelwrapper":{ModelWrapper:[8,2,1,""]},"finn.core.modelwrapper.ModelWrapper":{analysis:[8,4,1,""],check_all_tensor_shapes_specified:[8,4,1,""],check_compatibility:[8,4,1,""],find_consumer:[8,4,1,""],find_producer:[8,4,1,""],get_all_tensor_names:[8,4,1,""],get_initializer:[8,4,1,""],get_metadata_prop:[8,4,1,""],get_tensor_datatype:[8,4,1,""],get_tensor_fanout:[8,4,1,""],get_tensor_shape:[8,4,1,""],get_tensor_valueinfo:[8,4,1,""],graph:[8,4,1,""],make_empty_exec_context:[8,4,1,""],make_new_valueinfo_name:[8,4,1,""],model:[8,4,1,""],rename_tensor:[8,4,1,""],save:[8,4,1,""],set_initializer:[8,4,1,""],set_metadata_prop:[8,4,1,""],set_tensor_datatype:[8,4,1,""],set_tensor_shape:[8,4,1,""],transform:[8,4,1,""]},"finn.core.onnx_exec":{compare_execution:[8,1,1,""],execute_node:[8,1,1,""],execute_onnx:[8,1,1,""],execute_onnx_and_make_model:[8,1,1,""]},"finn.core.remote_exec":{remote_exec:[8,1,1,""]},"finn.core.rtlsim_exec":{rtlsim_exec:[8,1,1,""]},"finn.custom_op":{CustomOp:[9,2,1,""],fpgadataflow:[10,0,0,"-"],multithreshold:[9,0,0,"-"],registry:[9,0,0,"-"],streamingdataflowpartition:[9,0,0,"-"],xnorpopcount:[9,0,0,"-"]},"finn.custom_op.CustomOp":{execute_node:[9,4,1,""],get_nodeattr:[9,4,1,""],get_nodeattr_types:[9,4,1,""],infer_node_datatype:[9,4,1,""],make_shape_compatible_op:[9,4,1,""],set_nodeattr:[9,4,1,""],verify_node:[9,4,1,""]},"finn.custom_op.fpgadataflow":{HLSCustomOp:[10,2,1,""],convolutioninputgenerator:[10,0,0,"-"],streamingfclayer_batch:[10,0,0,"-"],streamingmaxpool_batch:[10,0,0,"-"],templates:[10,0,0,"-"],tlastmarker:[10,0,0,"-"]},"finn.custom_op.fpgadataflow.HLSCustomOp":{blackboxfunction:[10,4,1,""],bram_estimation:[10,4,1,""],code_generation_ipgen:[10,4,1,""],code_generation_npysim:[10,4,1,""],compile_singlenode_code:[10,4,1,""],dataoutstrm:[10,4,1,""],defines:[10,4,1,""],docompute:[10,4,1,""],dynamic_input_to_npy:[10,4,1,""],exec_precompiled_singlenode_model:[10,4,1,""],execute_node:[10,4,1,""],generate_params:[10,4,1,""],get_folded_input_shape:[10,4,1,""],get_folded_output_shape:[10,4,1,""],get_instream_width:[10,4,1,""],get_nodeattr_types:[10,4,1,""],get_number_output_values:[10,4,1,""],get_outstream_width:[10,4,1,""],global_includes:[10,4,1,""],ipgen_singlenode_code:[10,4,1,""],lut_estimation:[10,4,1,""],node_res_estimation:[10,4,1,""],npy_to_dynamic_output:[10,4,1,""],pragmas:[10,4,1,""],read_npy_data:[10,4,1,""],reset_rtlsim:[10,4,1,""],rtlsim:[10,4,1,""],save_as_npy:[10,4,1,""],strm_decl:[10,4,1,""],toggle_clk:[10,4,1,""]},"finn.custom_op.fpgadataflow.convolutioninputgenerator":{ConvolutionInputGenerator:[10,2,1,""]},"finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator":{blackboxfunction:[10,4,1,""],bram_estimation:[10,4,1,""],dataoutstrm:[10,4,1,""],defines:[10,4,1,""],docompute:[10,4,1,""],execute_node:[10,4,1,""],get_input_datatype:[10,4,1,""],get_nodeattr_types:[10,4,1,""],get_number_output_values:[10,4,1,""],get_output_datatype:[10,4,1,""],get_stream_width:[10,4,1,""],global_includes:[10,4,1,""],infer_node_datatype:[10,4,1,""],lut_estimation:[10,4,1,""],make_shape_compatible_op:[10,4,1,""],pragmas:[10,4,1,""],read_npy_data:[10,4,1,""],save_as_npy:[10,4,1,""],strm_decl:[10,4,1,""],verify_node:[10,4,1,""]},"finn.custom_op.fpgadataflow.streamingfclayer_batch":{StreamingFCLayer_Batch:[10,2,1,""]},"finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch":{blackboxfunction:[10,4,1,""],bram_estimation:[10,4,1,""],calc_tmem:[10,4,1,""],calc_wmem:[10,4,1,""],dataoutstrm:[10,4,1,""],defines:[10,4,1,""],docompute:[10,4,1,""],execute_node:[10,4,1,""],generate_params:[10,4,1,""],get_folded_input_shape:[10,4,1,""],get_folded_output_shape:[10,4,1,""],get_hls_compatible_threshold_tensor:[10,4,1,""],get_hls_compatible_weight_tensor:[10,4,1,""],get_input_datatype:[10,4,1,""],get_instream_width:[10,4,1,""],get_nodeattr_types:[10,4,1,""],get_number_output_values:[10,4,1,""],get_output_datatype:[10,4,1,""],get_outstream_width:[10,4,1,""],get_template_param_values:[10,4,1,""],get_weight_datatype:[10,4,1,""],global_includes:[10,4,1,""],infer_node_datatype:[10,4,1,""],lut_estimation:[10,4,1,""],make_shape_compatible_op:[10,4,1,""],pragmas:[10,4,1,""],read_npy_data:[10,4,1,""],save_as_npy:[10,4,1,""],strm_decl:[10,4,1,""],verify_node:[10,4,1,""]},"finn.custom_op.fpgadataflow.streamingmaxpool_batch":{StreamingMaxPool_Batch:[10,2,1,""]},"finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch":{blackboxfunction:[10,4,1,""],bram_estimation:[10,4,1,""],dataoutstrm:[10,4,1,""],defines:[10,4,1,""],docompute:[10,4,1,""],get_nodeattr_types:[10,4,1,""],get_number_output_values:[10,4,1,""],global_includes:[10,4,1,""],infer_node_datatype:[10,4,1,""],lut_estimation:[10,4,1,""],make_shape_compatible_op:[10,4,1,""],pragmas:[10,4,1,""],read_npy_data:[10,4,1,""],save_as_npy:[10,4,1,""],strm_decl:[10,4,1,""],verify_node:[10,4,1,""]},"finn.custom_op.fpgadataflow.tlastmarker":{TLastMarker:[10,2,1,""]},"finn.custom_op.fpgadataflow.tlastmarker.TLastMarker":{blackboxfunction:[10,4,1,""],dataoutstrm:[10,4,1,""],defines:[10,4,1,""],docompute:[10,4,1,""],execute_node:[10,4,1,""],get_folded_input_shape:[10,4,1,""],get_folded_output_shape:[10,4,1,""],get_instream_width:[10,4,1,""],get_nodeattr_types:[10,4,1,""],get_number_output_values:[10,4,1,""],get_outstream_width:[10,4,1,""],global_includes:[10,4,1,""],infer_node_datatype:[10,4,1,""],make_shape_compatible_op:[10,4,1,""],pragmas:[10,4,1,""],read_npy_data:[10,4,1,""],save_as_npy:[10,4,1,""],strm_decl:[10,4,1,""],verify_node:[10,4,1,""]},"finn.custom_op.multithreshold":{MultiThreshold:[9,2,1,""],compare:[9,1,1,""],multithreshold:[9,1,1,""]},"finn.custom_op.multithreshold.MultiThreshold":{execute_node:[9,4,1,""],get_nodeattr_types:[9,4,1,""],infer_node_datatype:[9,4,1,""],make_shape_compatible_op:[9,4,1,""],verify_node:[9,4,1,""]},"finn.custom_op.registry":{getCustomOp:[9,1,1,""]},"finn.custom_op.streamingdataflowpartition":{StreamingDataflowPartition:[9,2,1,""]},"finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition":{execute_node:[9,4,1,""],get_nodeattr_types:[9,4,1,""],infer_node_datatype:[9,4,1,""],make_shape_compatible_op:[9,4,1,""],verify_node:[9,4,1,""]},"finn.custom_op.xnorpopcount":{XnorPopcountMatMul:[9,2,1,""],xnorpopcountmatmul:[9,1,1,""]},"finn.custom_op.xnorpopcount.XnorPopcountMatMul":{execute_node:[9,4,1,""],get_nodeattr_types:[9,4,1,""],infer_node_datatype:[9,4,1,""],make_shape_compatible_op:[9,4,1,""],verify_node:[9,4,1,""]},"finn.transformation":{Transformation:[11,2,1,""],batchnorm_to_affine:[11,0,0,"-"],bipolar_to_xnor:[11,0,0,"-"],fold_constants:[11,0,0,"-"],fpgadataflow:[12,0,0,"-"],general:[11,0,0,"-"],infer_datatypes:[11,0,0,"-"],infer_shapes:[11,0,0,"-"],streamline:[13,0,0,"-"]},"finn.transformation.Transformation":{apply:[11,4,1,""]},"finn.transformation.batchnorm_to_affine":{BatchNormToAffine:[11,2,1,""]},"finn.transformation.batchnorm_to_affine.BatchNormToAffine":{apply:[11,4,1,""]},"finn.transformation.bipolar_to_xnor":{ConvertBipolarMatMulToXnorPopcount:[11,2,1,""]},"finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount":{apply:[11,4,1,""]},"finn.transformation.fold_constants":{FoldConstants:[11,2,1,""]},"finn.transformation.fold_constants.FoldConstants":{apply:[11,4,1,""]},"finn.transformation.fpgadataflow":{cleanup:[12,0,0,"-"],codegen_ipgen:[12,0,0,"-"],codegen_ipstitch:[12,0,0,"-"],codegen_npysim:[12,0,0,"-"],compile:[12,0,0,"-"],convert_to_hls_layers:[12,0,0,"-"],create_dataflow_partition:[12,0,0,"-"],hlssynth_ipgen:[12,0,0,"-"],insert_tlastmarker:[12,0,0,"-"],make_deployment:[12,0,0,"-"],make_pynq_driver:[12,0,0,"-"],make_pynq_proj:[12,0,0,"-"],set_exec_mode:[12,0,0,"-"],synth_pynq_proj:[12,0,0,"-"],templates:[12,0,0,"-"]},"finn.transformation.fpgadataflow.cleanup":{CleanUp:[12,2,1,""]},"finn.transformation.fpgadataflow.cleanup.CleanUp":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.codegen_ipgen":{CodeGen_ipgen:[12,2,1,""]},"finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.codegen_ipstitch":{CodeGen_ipstitch:[12,2,1,""]},"finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.codegen_npysim":{CodeGen_npysim:[12,2,1,""]},"finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.compile":{Compile:[12,2,1,""]},"finn.transformation.fpgadataflow.compile.Compile":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.convert_to_hls_layers":{InferBinaryStreamingFCLayer:[12,2,1,""]},"finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.create_dataflow_partition":{CreateDataflowPartition:[12,2,1,""]},"finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.hlssynth_ipgen":{HLSSynth_IPGen:[12,2,1,""]},"finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.insert_tlastmarker":{InsertTLastMarker:[12,2,1,""]},"finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.make_deployment":{DeployToPYNQ:[12,2,1,""]},"finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.make_pynq_driver":{MakePYNQDriver:[12,2,1,""]},"finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.make_pynq_proj":{MakePYNQProject:[12,2,1,""]},"finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.set_exec_mode":{SetExecMode:[12,2,1,""]},"finn.transformation.fpgadataflow.set_exec_mode.SetExecMode":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.synth_pynq_proj":{SynthPYNQProject:[12,2,1,""]},"finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject":{apply:[12,4,1,""]},"finn.transformation.general":{ConvertSubToAdd:[11,2,1,""],GiveRandomTensorNames:[11,2,1,""],GiveReadableTensorNames:[11,2,1,""],GiveUniqueNodeNames:[11,2,1,""]},"finn.transformation.general.ConvertSubToAdd":{apply:[11,4,1,""]},"finn.transformation.general.GiveRandomTensorNames":{apply:[11,4,1,""]},"finn.transformation.general.GiveReadableTensorNames":{apply:[11,4,1,""]},"finn.transformation.general.GiveUniqueNodeNames":{apply:[11,4,1,""]},"finn.transformation.infer_datatypes":{InferDataTypes:[11,2,1,""]},"finn.transformation.infer_datatypes.InferDataTypes":{apply:[11,4,1,""]},"finn.transformation.infer_shapes":{InferShapes:[11,2,1,""]},"finn.transformation.infer_shapes.InferShapes":{apply:[11,4,1,""]},"finn.transformation.streamline":{Streamline:[13,2,1,""],absorb:[13,0,0,"-"],collapse_repeated:[13,0,0,"-"],reorder:[13,0,0,"-"],round_thresholds:[13,0,0,"-"],sign_to_thres:[13,0,0,"-"]},"finn.transformation.streamline.Streamline":{apply:[13,4,1,""]},"finn.transformation.streamline.absorb":{Absorb1BitMulIntoMatMul:[13,2,1,""],AbsorbAddIntoMultiThreshold:[13,2,1,""],AbsorbMulIntoMultiThreshold:[13,2,1,""],FactorOutMulSignMagnitude:[13,2,1,""]},"finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul":{apply:[13,4,1,""]},"finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold":{apply:[13,4,1,""]},"finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold":{apply:[13,4,1,""]},"finn.transformation.streamline.absorb.FactorOutMulSignMagnitude":{apply:[13,4,1,""]},"finn.transformation.streamline.collapse_repeated":{CollapseRepeatedAdd:[13,2,1,""],CollapseRepeatedMul:[13,2,1,""],CollapseRepeatedOp:[13,2,1,""]},"finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp":{apply:[13,4,1,""]},"finn.transformation.streamline.reorder":{MoveAddPastMul:[13,2,1,""],MoveScalarAddPastMatMul:[13,2,1,""],MoveScalarMulPastMatMul:[13,2,1,""]},"finn.transformation.streamline.reorder.MoveAddPastMul":{apply:[13,4,1,""]},"finn.transformation.streamline.reorder.MoveScalarAddPastMatMul":{apply:[13,4,1,""]},"finn.transformation.streamline.reorder.MoveScalarMulPastMatMul":{apply:[13,4,1,""]},"finn.transformation.streamline.round_thresholds":{RoundAndClipThresholds:[13,2,1,""]},"finn.transformation.streamline.round_thresholds.RoundAndClipThresholds":{apply:[13,4,1,""]},"finn.transformation.streamline.sign_to_thres":{ConvertSignToThres:[13,2,1,""]},"finn.transformation.streamline.sign_to_thres.ConvertSignToThres":{apply:[13,4,1,""]},"finn.util":{basic:[14,0,0,"-"],data_packing:[14,0,0,"-"],fpgadataflow:[14,0,0,"-"],onnx:[14,0,0,"-"],test:[14,0,0,"-"]},"finn.util.basic":{CppBuilder:[14,2,1,""],calculate_signed_dot_prod_range:[14,1,1,""],gen_finn_dt_tensor:[14,1,1,""],get_by_name:[14,1,1,""],get_finn_root:[14,1,1,""],interleave_matrix_outer_dim_from_partitions:[14,1,1,""],make_build_dir:[14,1,1,""],pad_tensor_to_multiple_of:[14,1,1,""],random_string:[14,1,1,""],remove_by_name:[14,1,1,""],roundup_to_integer_multiple:[14,1,1,""]},"finn.util.basic.CppBuilder":{append_includes:[14,4,1,""],append_sources:[14,4,1,""],build:[14,4,1,""],set_executable_path:[14,4,1,""]},"finn.util.data_packing":{array2hexstring:[14,1,1,""],finnpy_to_packed_bytearray:[14,1,1,""],hexstring2npbytearray:[14,1,1,""],npbytearray2hexstring:[14,1,1,""],npy_to_rtlsim_input:[14,1,1,""],numpy_to_hls_code:[14,1,1,""],pack_innermost_dim_as_hex_string:[14,1,1,""],packed_bytearray_to_finnpy:[14,1,1,""],rtlsim_output_to_npy:[14,1,1,""],unpack_innermost_dim_from_hex_string:[14,1,1,""]},"finn.util.fpgadataflow":{IPGenBuilder:[14,2,1,""],pyverilate_stitched_ip:[14,1,1,""]},"finn.util.fpgadataflow.IPGenBuilder":{append_tcl:[14,4,1,""],build:[14,4,1,""],set_ipgen_path:[14,4,1,""]},"finn.util.onnx":{valueinfo_to_tensor:[14,1,1,""]},"finn.util.test":{get_test_model_def_fxn:[14,1,1,""],get_test_model_trained:[14,1,1,""],get_test_model_untrained:[14,1,1,""],get_trained_checkpoint:[14,1,1,""]},finn:{analysis:[6,0,0,"-"],core:[8,0,0,"-"],custom_op:[9,0,0,"-"],transformation:[11,0,0,"-"],util:[14,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","attribute","Python attribute"],"4":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:attribute","4":"py:method"},terms:{"0f01":14,"0x07":14,"0x0e":14,"0x0f01":14,"0xb":14,"0xe":14,"600px":[],"abstract":[9,10,11],"boolean":8,"class":[8,9,10,11,12,13,14],"const":11,"default":[9,10,11],"enum":8,"final":8,"float":14,"function":[1,8,11,14],"import":1,"new":[1,2,8],"return":[6,7,8,9,10,11,13,14],"static":6,"true":[8,14],"try":1,"var":10,For:13,HLS:[2,8],IPs:12,PEs:10,The:[1,2,6,8,11,12,13,14],There:1,Use:[8,14],abc:[9,11],abit:14,about:[2,6,12],abov:1,absorb1bitmulintomatmul:13,absorb:[5,11,12],absorbaddintomultithreshold:13,absorbmulintomultithreshold:13,acceler:[1,12],account:8,action:12,activ:8,add:[11,13],adding:1,addit:1,addition:13,address:12,after:14,aim:13,align:[],all:[1,6,8,9,10,11,12,14],all_tensors_f32:6,allow:8,alreadi:12,also:[9,10,12],amount:14,analysi:[5,8,15],analysis_fxn:8,anaylsis_fxn:8,ani:[1,8,11,12,14],annot:[6,9,10],anoth:12,append_includ:14,append_sourc:14,append_tcl:14,appli:[8,11,12,13],apply_rep:11,appropri:[1,11],arbitrari:14,architectur:2,argument:1,around:8,arrai:14,array2hexstr:14,arxiv:13,assign:8,associ:[8,11],assum:14,attribut:[6,9,10,12],attribute_nam:[9,10],attributeproto:[9,10],back:1,backend:12,base:[8,9,10,11,12,13,14],basic:[5,15],batchnorm:11,batchnorm_to_affin:[5,15],batchnormtoaffin:11,been:12,befor:14,between:[10,14],binari:[8,10,12,13,14],bipolar:[8,10,11,13,14],bipolar_to_xnor:[5,15],bit:[8,14],bitfil:1,bitwidth:8,blackboxfunct:10,block:12,blott:10,board:12,bool:[6,11],both:14,bram_estim:10,brevita:2,brien:10,browser:1,build:14,built:6,calc_tmem:10,calc_wmem:10,calcul:10,calculate_signed_dot_prod_rang:14,call:[1,8,10,11,12],can:[1,2,8,11,12,13,14],cannot:11,center:[],centerpiec:2,certain:6,chang:[1,8,11],check:[6,8,9,10],check_all_tensor_shapes_specifi:8,check_compat:8,cleanup:[5,11],clk:[10,12],clone:[1,14],code:[12,14],code_gen_dir:14,code_generation_ipgen:10,code_generation_npysim:10,codegen_ipgen:[5,11],codegen_ipstitch:[5,11],codegen_npysim:[5,11],collaps:13,collapse_rep:[5,11],collapserepeatedadd:13,collapserepeatedmul:13,collapserepeatedop:13,collect:[1,12],colloqui:2,come:[1,6],command:1,commun:2,compar:[8,9],compare_execut:8,compare_fxn:8,compat:[8,9,10],compil:[2,5,11],compile_singlenode_cod:10,complet:1,compon:2,comput:[1,8],consecut:13,constant:[6,8,13],construct:2,consum:8,contain:[1,2,8,9,12,14],content:15,context:[8,9,10],contribut:2,convent:6,convert:[1,10,11,12,13,14],convert_to_hls_lay:[5,11],convertbipolarmatmultoxnorpopcount:11,convertsigntothr:13,convertsubtoadd:11,convolutioninputgener:[5,9],copi:[8,11,12],core:[5,15],corner:2,correct:11,correctli:[1,6,9,10,12],correspond:[2,8,9,10],count:10,cpp_file:14,cppbuilder:14,creat:[1,8,12,14],create_dataflow_partit:[5,11],createdataflowpartit:12,current:[2,8],custom:[1,2,6,8],custom_op:[5,15],customop:[9,10],data:[9,12,14],data_pack:[5,15],dataflow:[2,8,12],dataoutstrm:10,datatyp:[5,9,10,11,14,15],debug:8,declar:11,deep:[2,8,10,11],default_v:[9,10],default_valu:[9,10],defin:10,depend:1,deploi:1,deploy:12,deploytopynq:12,design:[1,12],detail:2,develop:2,dict:[8,9,10],dictionari:[6,8],differ:1,digit:14,dimens:14,dimension:14,dir:[12,14],directori:[1,12,14],distr_pad:14,divis:14,dnn:[],doc:2,docker:14,dockerfil:1,docomput:10,doe:1,don:11,done:6,dot:14,down:1,driver:12,dt_a:14,dt_b:14,dtype:[6,8,9,10,14],dynam:6,dynamic_input_to_npi:10,each:[2,6,8,11,13,14],editor:1,effect:11,either:1,element:14,embed:8,emit:14,emphasi:2,empti:8,end:10,ensur:[10,11,12,14],entir:1,enumer:[8,11],environ:1,equal:[9,10],equival:13,estim:7,even:11,evenli:14,everi:11,everyth:1,exampl:[1,14],excel:1,exec_precompiled_singlenode_model:10,execut:[8,9,10],execute_custom_nod:[5,15],execute_nod:[8,9,10],execute_onnx:8,execute_onnx_and_make_model:8,execution_context:8,exist:[9,14],exit:14,expect:[6,8,9,10,12],experi:2,experiment:2,explor:[2,8,10],expos:8,extens:1,extra:[1,6,14],extract:[6,7],f5c6bd32ae93ec103a88152214baedff4ce1850d81065bfc:1,factor:14,factoroutmulsignmagnitud:13,fals:[8,11,14],familiar:1,fan:6,fast:10,fewest:8,field:[12,14],file:[1,8,12,14],filenam:[8,12],find:8,find_consum:8,find_produc:8,finn:[],finn_dt:14,finnpy_to_packed_bytearrai:14,first:[6,13],fix:[11,14],flatten:14,float32:[6,8],flow:[],fold_const:[5,15],foldconst:11,folder:[1,12,14],follow:[1,2,6,12],form:10,forward:1,found:[2,12],four:14,fpga:[1,2],fpgadataflow:[5,6,9,11,15],fpgapart:[10,12],framework:[2,10],fraser:10,from:[1,2,7,8,12,14],full:8,further:11,gambardella:10,gen_finn_dt_tensor:14,gener:[2,5,12,14,15],generate_param:10,get:[8,9],get_all_tensor_nam:8,get_by_nam:14,get_finn_root:14,get_folded_input_shap:10,get_folded_output_shap:10,get_hls_compatible_threshold_tensor:10,get_hls_compatible_weight_tensor:10,get_hls_datatype_str:8,get_initi:8,get_input_datatyp:10,get_instream_width:10,get_metadata_prop:8,get_nodeattr:9,get_nodeattr_typ:[9,10],get_num_possible_valu:8,get_number_output_valu:10,get_output_datatyp:10,get_outstream_width:10,get_per_tensor_fanout:6,get_smallest_poss:8,get_stream_width:10,get_template_param_valu:10,get_tensor_datatyp:8,get_tensor_fanout:8,get_tensor_shap:8,get_tensor_valueinfo:8,get_test_model_def_fxn:14,get_test_model_train:14,get_test_model_untrain:14,get_trained_checkpoint:14,get_weight_datatyp:10,getcustomop:9,github:2,give:[1,11,13],give_unique_node_nam:11,given:[6,7,8,9,10,14],giverandomtensornam:11,givereadabletensornam:11,giveuniquenodenam:11,global_includ:10,graph:[6,8,9,10,11,12],graphic:2,guarante:11,guid:5,hand:2,has:[6,8,11,12,14],have:[1,6,8,11,12,13],height:[],help:1,hex:14,hexstr:14,hexstring2npbytearrai:14,high:1,highli:2,hls_synth_res_estim:[5,6],hls_var_nam:14,hlscustomop:10,hlslib:[2,10],hlssynth_ipgen:[5,11],homepag:2,host:[1,14],how:[5,14],http:1,human:11,imag:[],img:[],immedi:12,implement:8,includ:[2,8,12],index:[],indic:[8,9,10,11,12],infer:[1,2,8,9,10,11,14],infer_datatyp:[5,15],infer_node_datatyp:[9,10],infer_shap:[5,15],inferbinarystreamingfclay:12,inferdatatyp:11,infershap:11,infinit:11,info:[11,14],info_messag:6,inform:[6,12],infrastructur:12,inherit:11,initi:[6,8],innermost:14,inp0:9,inp1:9,inp:10,input:[6,8,9,10,11,13,14],input_dict:8,input_dtyp:14,input_fil:14,insert:[12,14],insert_tlastmark:[5,11],inserttlastmark:12,insid:[1,9],instal:1,instanc:[8,9,10,13],instanti:12,instead:14,int16:8,int2:8,int32:8,int3:8,int4:8,int8:8,integ:[8,13,14],intend:[],interfac:12,interleav:10,interleave_matrix_outer_dim_from_partit:14,intermedi:[8,11],intern:11,involv:1,ipgen_singlenode_cod:10,ipgenbuild:14,is_integ:8,is_linear:6,item:14,jupyt:2,kei:8,know:11,lab:2,lambda:8,largest:8,launch:1,layer:[11,12],lead:14,learn:[2,10],leeser:10,len:14,let:11,letter:14,librari:2,library_path:14,like:1,linear:[6,8],link:[1,2],list:[6,8],locat:1,look:[1,6],loop:11,lut_estim:10,made:[8,11],magnitud:13,mai:1,make:[1,11,12],make_build_dir:14,make_collapsed_param_fxn:13,make_deepcopi:8,make_deploy:[5,11],make_empty_exec_context:8,make_new_valueinfo_nam:8,make_project:12,make_pynq_driv:[5,11],make_pynq_proj:[5,11],make_shape_compatible_op:[9,10],makepynqdriv:12,makepynqproject:12,mani:1,manipul:8,manual:11,matmul:[11,13],matrix:[10,13,14],max:[8,14],mean:14,meant:11,member:[9,10],metadata_prop:[8,12],min:[8,14],minimum:14,mixtur:6,mkdtemp:14,mode:[1,12],model:[6,7,8,9,10,11,12,13,14],model_a:8,model_b:8,model_was_chang:11,modelproto:[8,12],modelwrapp:[5,6,11,15],modul:15,modular:2,more:[2,8,11,14],mount:1,move:13,moveaddpastmul:13,movescalaraddpastmatmul:13,movescalarmulpastmatmul:13,mul:[11,13],multidimension:14,multipl:[11,13,14],multipli:13,multithreshold:[5,12,13,15],must:[9,11,12,13,14],mvtu:12,n_partit:14,n_thres_step:10,name:[6,7,8,9,11,14],name_field:14,ndarrai:14,nearest:[13,14],necessari:12,need:[7,9,10,11],neg:[8,13],netnam:14,netron:1,network:[1,2,10],neural:[2,10],new_nam:8,next:13,no_decl:14,node:[6,7,8,9,10,11,12,13],node_inputs_in_expected_ord:6,node_res_estim:10,non:12,none:[8,9,14],note:1,notebook:2,notwithstand:6,now:[6,8],npbytearrai:14,npbytearray2hexstr:14,npy:14,npy_to_dynamic_output:10,npy_to_rtlsim_input:14,number:[8,9,10,14],numpi:[10,14],numpy_to_hls_cod:14,object:[8,14],old_nam:8,onc:11,one:[6,8,12,14],ones:1,onli:[6,8,11,12,13],onlin:1,onnx:[5,8,9,10,12,15],onnx_exec:[5,15],onnx_model_proto:8,onnx_nod:[9,10],onnxruntim:8,op_nam:13,op_typ:6,open:1,oper:[8,13],ops:[6,13],option:1,order:6,orig_thres_matrix:10,orig_weight_matrix:10,origin:10,other:[8,13],otherwis:[1,8,11,14],out:6,out_bia:9,out_scal:9,out_shap:14,outcom:12,output:[8,9,10,11,14],output_shap:14,overlai:12,overview:2,own:1,pack:[12,14],pack_innermost_dim:14,pack_innermost_dim_as_hex_str:14,packag:15,packed_bytearrai:14,packed_bytearray_to_finnpi:14,packedbit:14,pad:14,pad_tensor_to_multiple_of:14,pad_to_dim:14,pad_to_nbit:14,page:[],pair:12,paramet:13,part:[9,14],particular:[9,10,14],partit:8,pass:[5,10],password:12,past:13,path:[10,14],per:12,perform:[1,9,10],permit:[9,10],place:12,platform:12,png:[],point:[1,11],port:1,posit:[10,13,14],possibl:[8,12],pragma:10,preced:13,precid:13,precis:14,precomput:11,prefer:8,prefix:14,prepend:14,preusser:10,previous:12,print:1,prior:[11,12,14],process:1,produc:[6,8],product:14,project:[2,12],properti:[6,8],provid:[1,8],pushbutton:1,pynq:12,pynq_driver_dir:12,python:[1,12,14],pyveril:[8,14],pyverilate_stitched_ip:14,qnn:[1,2],quantiz:[2,6,10],random:[11,14],random_str:14,randomli:14,rather:1,reach:11,read:2,read_npy_data:10,readabl:11,readthedoc:[],recommend:11,refer:2,reflect:1,registri:[5,15],relat:2,remot:8,remote_exec:[5,15],remov:[12,14],remove_by_nam:14,remove_prefix:14,renam:8,rename_tensor:8,reorder:[5,11],repeat:[11,13],repeatedli:8,replac:11,repo:1,repositori:[1,2],repositroi:[],repres:[8,14],represent:14,requir:[8,9,10],res_estim:[5,6],research:2,reset_rtlsim:10,reshap:10,resourc:[1,7],respect:14,result:[6,7,8,11,12,13,14],return_full_exec_context:8,returned_dict:[9,10],revers:14,reverse_endian:14,reverse_inn:14,right:2,root:[1,14],round:[13,14],round_threshold:[5,11],roundandclipthreshold:13,roundup_to_integer_multipl:14,row:10,rtlsim:[8,10],rtlsim_exec:[5,15],rtlsim_output_to_npi:14,run:[8,12],run_dock:1,same:[12,14],save:[8,14],save_as_npi:10,scalar:13,scale:[],scp:12,script:[1,12],search:[],second:[12,13],see:[13,14],seen:2,sep:10,separ:2,sequenc:14,server:1,set:[1,8,9,10,12,13,14],set_attribut:[],set_exec_mod:[5,11],set_executable_path:14,set_initi:8,set_ipgen_path:14,set_metadata_prop:8,set_nodeattr:9,set_sim_mod:[],set_tensor_datatyp:8,set_tensor_shap:8,setexecmod:12,setsimmod:[],settings64:1,sever:1,shape:[8,9,10,11,14],shell:12,should:[1,6,8,11],sign:[8,11,13,14],sign_to_thr:[5,11],sim:[10,14],sim_mod:12,simd:10,simpli:1,sinc:[8,14],singl:[1,8,13,14],small:6,smallest:8,some:[1,2,8,11],someth:1,space:[],spawn:1,specif:2,specifi:[8,11,14],split:[12,13,14],stai:2,standard:[8,9,10],stitch:[8,12,14],store:[9,12,14],streamingdataflowpartit:[5,12,15],streamingfclayer_batch:[5,9,12],streamingmaxpool_batch:[5,9],streamlin:[5,11],string:[6,14],stringlength:14,strm_decl:10,structur:6,style:2,sub:11,subdirectori:12,subgraph:8,submodul:[5,15],subpackag:15,subset:6,success:12,suitabl:10,sure:1,surviv:14,synth_pynq_proj:[5,11],synthesi:[7,12],synthpynqproject:12,take:[1,6,8,11,13,14],taken:[2,8,12],target:[2,12],target_dir:12,targetbit:14,tcl:12,tcl_script:14,tempfil:14,templat:[5,9,11],temporari:14,tensor:[6,8,11,13,14],tensor_fanout:6,tensor_nam:[6,8],tensor_shap:[8,14],tensor_valu:8,termin:[1,12],ternari:8,test:[5,11,15],text:1,thei:13,them:[6,12,13],thi:[1,2,6,8,9,10,11,12,14],thing:2,thought:1,threshold:[9,10,13],time:[1,11],tlastmark:[5,9,12],tmem:10,togeth:12,toggle_clk:10,token:1,tool:[1,2],topolog:[5,15],train:[1,2],transform:[5,8,15],transformed_model:11,travers:6,tune:2,tupl:11,two:[2,8,12,13,14],type:[8,11,14],ubuntu:1,uint16:8,uint2:[8,14],uint32:8,uint3:8,uint4:8,uint8:[8,14],umuroglu:10,under:[2,12],uniqu:11,unpack:[12,14],unpack_innermost_dim_from_hex_str:14,unsign:[8,13],until:8,updat:[2,13],upper:2,use:2,used:[2,8,9,10,14],useful:8,user:11,usernam:12,using:[2,8,11,13,14],util:[5,8,9,10,15],val:14,valu:[8,9,10,12,13,14],value_info:8,valueinfo:[8,11],valueinfo_to_tensor:14,valueinfoproto:[8,14],variabl:[1,14],vector:[13,14],verif:6,verifi:[6,9,10],verify_custom_nod:[5,15],verify_nod:[6,9,10],version:2,via:8,view:2,visser:10,vivado:[1,2,7,8,12],vivado_path:1,vivado_pynq_proj:12,vivado_stitch_proj:12,wai:[1,6],want:13,wbit:14,websit:2,weight:[8,10],welcom:2,well:1,when:[6,11],where:[1,8,9,10,12,13],whether:[6,8,9,10,11],which:[1,2,8,9,10,12,13,14],width:14,without:1,wmem:10,work:[1,8,14],workspac:1,wrapper:8,write:[1,5],xdnn:[],xilinx:2,xnorpopcount:[5,15],xnorpopcountmatmul:[9,11,12],you:[1,11],your:[1,11],zero:[8,13,14]},titles:["FINN - End-to-End Flow","Getting Started","FINN","src","Source Code","finn package","finn.analysis package","finn.analysis.fpgadataflow package","finn.core package","finn.custom_op package","finn.custom_op.fpgadataflow package","finn.transformation package","finn.transformation.fpgadataflow package","finn.transformation.streamline package","finn.util package","finn"],titleterms:{absorb:13,analysi:[6,7],basic:14,batchnorm_to_affin:11,bipolar_to_xnor:11,cleanup:12,code:4,codegen_ipgen:12,codegen_ipstitch:12,codegen_npysim:12,collapse_rep:13,compil:[1,12],content:[5,6,7,8,9,10,11,12,13,14],convert_to_hls_lay:12,convolutioninputgener:10,core:8,create_dataflow_partit:12,custom_op:[9,10],data_pack:14,datatyp:8,develop:1,directli:1,docker:1,document:[],end:0,execute_custom_nod:8,experiment:1,finn:[0,1,2,5,6,7,8,9,10,11,12,13,14,15],flow:0,fold_const:11,fpgadataflow:[7,10,12,14],gener:11,get:1,guid:11,hls_synth_res_estim:7,hlssynth_ipgen:12,how:[1,6],indic:[],infer_datatyp:11,infer_shap:11,insert_tlastmark:12,interact:1,jenkin:1,jupyt:1,make_deploy:12,make_pynq_driv:12,make_pynq_proj:12,modelwrapp:8,modul:[5,6,7,8,9,10,11,12,13,14],multithreshold:9,notebook:1,onnx:14,onnx_exec:8,packag:[5,6,7,8,9,10,11,12,13,14],pass:6,registri:9,remote_exec:8,reorder:13,requir:1,res_estim:7,round_threshold:13,rtlsim_exec:8,run:1,set_exec_mod:12,set_sim_mod:[],shell:1,sign_to_thr:13,sourc:4,src:3,start:1,streamingdataflowpartit:9,streamingfclayer_batch:10,streamingmaxpool_batch:10,streamlin:13,submodul:[6,7,8,9,10,11,12,13,14],subpackag:[5,6,9,11],suit:1,synth_pynq_proj:12,tabl:[],templat:[10,12],test:[1,14],tlastmark:10,topolog:6,transform:[11,12,13],use:1,using:1,util:14,verify_custom_nod:6,welcom:[],what:2,write:[6,11],xnorpopcount:9}}) \ No newline at end of file +Search.setIndex({docnames:["end_to_end_flow","getting_started","index","modules","source_code","source_code/finn","source_code/finn.analysis","source_code/finn.analysis.fpgadataflow","source_code/finn.core","source_code/finn.custom_op","source_code/finn.custom_op.fpgadataflow","source_code/finn.transformation","source_code/finn.transformation.fpgadataflow","source_code/finn.transformation.streamline","source_code/finn.util","source_code/modules"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:56},filenames:["end_to_end_flow.rst","getting_started.rst","index.rst","modules.rst","source_code.rst","source_code/finn.rst","source_code/finn.analysis.rst","source_code/finn.analysis.fpgadataflow.rst","source_code/finn.core.rst","source_code/finn.custom_op.rst","source_code/finn.custom_op.fpgadataflow.rst","source_code/finn.transformation.rst","source_code/finn.transformation.fpgadataflow.rst","source_code/finn.transformation.streamline.rst","source_code/finn.util.rst","source_code/modules.rst"],objects:{"":{finn:[5,0,0,"-"]},"finn.analysis":{fpgadataflow:[7,0,0,"-"],topology:[6,0,0,"-"],verify_custom_nodes:[6,0,0,"-"]},"finn.analysis.fpgadataflow":{hls_synth_res_estimation:[7,0,0,"-"],res_estimation:[7,0,0,"-"]},"finn.analysis.fpgadataflow.hls_synth_res_estimation":{hls_synth_res_estimation:[7,1,1,""]},"finn.analysis.fpgadataflow.res_estimation":{res_estimation:[7,1,1,""]},"finn.analysis.topology":{all_tensors_f32:[6,1,1,""],get_per_tensor_fanouts:[6,1,1,""],is_linear:[6,1,1,""],node_inputs_in_expected_order:[6,1,1,""]},"finn.analysis.verify_custom_nodes":{verify_nodes:[6,1,1,""]},"finn.core":{datatype:[8,0,0,"-"],execute_custom_node:[8,0,0,"-"],modelwrapper:[8,0,0,"-"],onnx_exec:[8,0,0,"-"],remote_exec:[8,0,0,"-"],rtlsim_exec:[8,0,0,"-"]},"finn.core.datatype":{DataType:[8,2,1,""]},"finn.core.datatype.DataType":{BINARY:[8,3,1,""],BIPOLAR:[8,3,1,""],FLOAT32:[8,3,1,""],INT16:[8,3,1,""],INT2:[8,3,1,""],INT32:[8,3,1,""],INT3:[8,3,1,""],INT4:[8,3,1,""],INT8:[8,3,1,""],TERNARY:[8,3,1,""],UINT16:[8,3,1,""],UINT2:[8,3,1,""],UINT32:[8,3,1,""],UINT3:[8,3,1,""],UINT4:[8,3,1,""],UINT8:[8,3,1,""],allowed:[8,4,1,""],bitwidth:[8,4,1,""],get_hls_datatype_str:[8,4,1,""],get_num_possible_values:[8,4,1,""],get_smallest_possible:[8,4,1,""],is_integer:[8,4,1,""],max:[8,4,1,""],min:[8,4,1,""],signed:[8,4,1,""]},"finn.core.execute_custom_node":{execute_custom_node:[8,1,1,""]},"finn.core.modelwrapper":{ModelWrapper:[8,2,1,""]},"finn.core.modelwrapper.ModelWrapper":{analysis:[8,4,1,""],check_all_tensor_shapes_specified:[8,4,1,""],check_compatibility:[8,4,1,""],find_consumer:[8,4,1,""],find_producer:[8,4,1,""],get_all_tensor_names:[8,4,1,""],get_initializer:[8,4,1,""],get_metadata_prop:[8,4,1,""],get_tensor_datatype:[8,4,1,""],get_tensor_fanout:[8,4,1,""],get_tensor_shape:[8,4,1,""],get_tensor_valueinfo:[8,4,1,""],graph:[8,4,1,""],make_empty_exec_context:[8,4,1,""],make_new_valueinfo_name:[8,4,1,""],model:[8,4,1,""],rename_tensor:[8,4,1,""],save:[8,4,1,""],set_initializer:[8,4,1,""],set_metadata_prop:[8,4,1,""],set_tensor_datatype:[8,4,1,""],set_tensor_shape:[8,4,1,""],transform:[8,4,1,""]},"finn.core.onnx_exec":{compare_execution:[8,1,1,""],execute_node:[8,1,1,""],execute_onnx:[8,1,1,""],execute_onnx_and_make_model:[8,1,1,""]},"finn.core.remote_exec":{remote_exec:[8,1,1,""]},"finn.core.rtlsim_exec":{rtlsim_exec:[8,1,1,""]},"finn.custom_op":{CustomOp:[9,2,1,""],fpgadataflow:[10,0,0,"-"],multithreshold:[9,0,0,"-"],registry:[9,0,0,"-"],streamingdataflowpartition:[9,0,0,"-"],xnorpopcount:[9,0,0,"-"]},"finn.custom_op.CustomOp":{execute_node:[9,4,1,""],get_nodeattr:[9,4,1,""],get_nodeattr_types:[9,4,1,""],infer_node_datatype:[9,4,1,""],make_shape_compatible_op:[9,4,1,""],set_nodeattr:[9,4,1,""],verify_node:[9,4,1,""]},"finn.custom_op.fpgadataflow":{HLSCustomOp:[10,2,1,""],convolutioninputgenerator:[10,0,0,"-"],streamingfclayer_batch:[10,0,0,"-"],streamingmaxpool_batch:[10,0,0,"-"],templates:[10,0,0,"-"],tlastmarker:[10,0,0,"-"]},"finn.custom_op.fpgadataflow.HLSCustomOp":{blackboxfunction:[10,4,1,""],bram_estimation:[10,4,1,""],code_generation_ipgen:[10,4,1,""],code_generation_npysim:[10,4,1,""],compile_singlenode_code:[10,4,1,""],dataoutstrm:[10,4,1,""],defines:[10,4,1,""],docompute:[10,4,1,""],dynamic_input_to_npy:[10,4,1,""],exec_precompiled_singlenode_model:[10,4,1,""],execute_node:[10,4,1,""],generate_params:[10,4,1,""],get_folded_input_shape:[10,4,1,""],get_folded_output_shape:[10,4,1,""],get_instream_width:[10,4,1,""],get_nodeattr_types:[10,4,1,""],get_number_output_values:[10,4,1,""],get_outstream_width:[10,4,1,""],global_includes:[10,4,1,""],ipgen_singlenode_code:[10,4,1,""],lut_estimation:[10,4,1,""],node_res_estimation:[10,4,1,""],npy_to_dynamic_output:[10,4,1,""],pragmas:[10,4,1,""],read_npy_data:[10,4,1,""],reset_rtlsim:[10,4,1,""],rtlsim:[10,4,1,""],save_as_npy:[10,4,1,""],strm_decl:[10,4,1,""],toggle_clk:[10,4,1,""]},"finn.custom_op.fpgadataflow.convolutioninputgenerator":{ConvolutionInputGenerator:[10,2,1,""]},"finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator":{blackboxfunction:[10,4,1,""],bram_estimation:[10,4,1,""],dataoutstrm:[10,4,1,""],defines:[10,4,1,""],docompute:[10,4,1,""],execute_node:[10,4,1,""],get_input_datatype:[10,4,1,""],get_nodeattr_types:[10,4,1,""],get_number_output_values:[10,4,1,""],get_output_datatype:[10,4,1,""],get_stream_width:[10,4,1,""],global_includes:[10,4,1,""],infer_node_datatype:[10,4,1,""],lut_estimation:[10,4,1,""],make_shape_compatible_op:[10,4,1,""],pragmas:[10,4,1,""],read_npy_data:[10,4,1,""],save_as_npy:[10,4,1,""],strm_decl:[10,4,1,""],verify_node:[10,4,1,""]},"finn.custom_op.fpgadataflow.streamingfclayer_batch":{StreamingFCLayer_Batch:[10,2,1,""]},"finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch":{blackboxfunction:[10,4,1,""],bram_estimation:[10,4,1,""],calc_tmem:[10,4,1,""],calc_wmem:[10,4,1,""],dataoutstrm:[10,4,1,""],defines:[10,4,1,""],docompute:[10,4,1,""],execute_node:[10,4,1,""],generate_params:[10,4,1,""],get_folded_input_shape:[10,4,1,""],get_folded_output_shape:[10,4,1,""],get_hls_compatible_threshold_tensor:[10,4,1,""],get_hls_compatible_weight_tensor:[10,4,1,""],get_input_datatype:[10,4,1,""],get_instream_width:[10,4,1,""],get_nodeattr_types:[10,4,1,""],get_number_output_values:[10,4,1,""],get_output_datatype:[10,4,1,""],get_outstream_width:[10,4,1,""],get_template_param_values:[10,4,1,""],get_weight_datatype:[10,4,1,""],global_includes:[10,4,1,""],infer_node_datatype:[10,4,1,""],lut_estimation:[10,4,1,""],make_shape_compatible_op:[10,4,1,""],pragmas:[10,4,1,""],read_npy_data:[10,4,1,""],save_as_npy:[10,4,1,""],strm_decl:[10,4,1,""],verify_node:[10,4,1,""]},"finn.custom_op.fpgadataflow.streamingmaxpool_batch":{StreamingMaxPool_Batch:[10,2,1,""]},"finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch":{blackboxfunction:[10,4,1,""],bram_estimation:[10,4,1,""],dataoutstrm:[10,4,1,""],defines:[10,4,1,""],docompute:[10,4,1,""],get_nodeattr_types:[10,4,1,""],get_number_output_values:[10,4,1,""],global_includes:[10,4,1,""],infer_node_datatype:[10,4,1,""],lut_estimation:[10,4,1,""],make_shape_compatible_op:[10,4,1,""],pragmas:[10,4,1,""],read_npy_data:[10,4,1,""],save_as_npy:[10,4,1,""],strm_decl:[10,4,1,""],verify_node:[10,4,1,""]},"finn.custom_op.fpgadataflow.tlastmarker":{TLastMarker:[10,2,1,""]},"finn.custom_op.fpgadataflow.tlastmarker.TLastMarker":{blackboxfunction:[10,4,1,""],dataoutstrm:[10,4,1,""],defines:[10,4,1,""],docompute:[10,4,1,""],execute_node:[10,4,1,""],get_folded_input_shape:[10,4,1,""],get_folded_output_shape:[10,4,1,""],get_instream_width:[10,4,1,""],get_nodeattr_types:[10,4,1,""],get_number_output_values:[10,4,1,""],get_outstream_width:[10,4,1,""],global_includes:[10,4,1,""],infer_node_datatype:[10,4,1,""],make_shape_compatible_op:[10,4,1,""],pragmas:[10,4,1,""],read_npy_data:[10,4,1,""],save_as_npy:[10,4,1,""],strm_decl:[10,4,1,""],verify_node:[10,4,1,""]},"finn.custom_op.multithreshold":{MultiThreshold:[9,2,1,""],compare:[9,1,1,""],multithreshold:[9,1,1,""]},"finn.custom_op.multithreshold.MultiThreshold":{execute_node:[9,4,1,""],get_nodeattr_types:[9,4,1,""],infer_node_datatype:[9,4,1,""],make_shape_compatible_op:[9,4,1,""],verify_node:[9,4,1,""]},"finn.custom_op.registry":{getCustomOp:[9,1,1,""]},"finn.custom_op.streamingdataflowpartition":{StreamingDataflowPartition:[9,2,1,""]},"finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition":{execute_node:[9,4,1,""],get_nodeattr_types:[9,4,1,""],infer_node_datatype:[9,4,1,""],make_shape_compatible_op:[9,4,1,""],verify_node:[9,4,1,""]},"finn.custom_op.xnorpopcount":{XnorPopcountMatMul:[9,2,1,""],xnorpopcountmatmul:[9,1,1,""]},"finn.custom_op.xnorpopcount.XnorPopcountMatMul":{execute_node:[9,4,1,""],get_nodeattr_types:[9,4,1,""],infer_node_datatype:[9,4,1,""],make_shape_compatible_op:[9,4,1,""],verify_node:[9,4,1,""]},"finn.transformation":{Transformation:[11,2,1,""],batchnorm_to_affine:[11,0,0,"-"],bipolar_to_xnor:[11,0,0,"-"],fold_constants:[11,0,0,"-"],fpgadataflow:[12,0,0,"-"],general:[11,0,0,"-"],infer_datatypes:[11,0,0,"-"],infer_shapes:[11,0,0,"-"],streamline:[13,0,0,"-"]},"finn.transformation.Transformation":{apply:[11,4,1,""]},"finn.transformation.batchnorm_to_affine":{BatchNormToAffine:[11,2,1,""]},"finn.transformation.batchnorm_to_affine.BatchNormToAffine":{apply:[11,4,1,""]},"finn.transformation.bipolar_to_xnor":{ConvertBipolarMatMulToXnorPopcount:[11,2,1,""]},"finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount":{apply:[11,4,1,""]},"finn.transformation.fold_constants":{FoldConstants:[11,2,1,""]},"finn.transformation.fold_constants.FoldConstants":{apply:[11,4,1,""]},"finn.transformation.fpgadataflow":{cleanup:[12,0,0,"-"],codegen_ipgen:[12,0,0,"-"],codegen_ipstitch:[12,0,0,"-"],codegen_npysim:[12,0,0,"-"],compile:[12,0,0,"-"],convert_to_hls_layers:[12,0,0,"-"],create_dataflow_partition:[12,0,0,"-"],hlssynth_ipgen:[12,0,0,"-"],insert_tlastmarker:[12,0,0,"-"],make_deployment:[12,0,0,"-"],make_pynq_driver:[12,0,0,"-"],make_pynq_proj:[12,0,0,"-"],set_exec_mode:[12,0,0,"-"],synth_pynq_proj:[12,0,0,"-"],templates:[12,0,0,"-"]},"finn.transformation.fpgadataflow.cleanup":{CleanUp:[12,2,1,""]},"finn.transformation.fpgadataflow.cleanup.CleanUp":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.codegen_ipgen":{CodeGen_ipgen:[12,2,1,""]},"finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.codegen_ipstitch":{CodeGen_ipstitch:[12,2,1,""]},"finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.codegen_npysim":{CodeGen_npysim:[12,2,1,""]},"finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.compile":{Compile:[12,2,1,""]},"finn.transformation.fpgadataflow.compile.Compile":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.convert_to_hls_layers":{InferBinaryStreamingFCLayer:[12,2,1,""]},"finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.create_dataflow_partition":{CreateDataflowPartition:[12,2,1,""]},"finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.hlssynth_ipgen":{HLSSynth_IPGen:[12,2,1,""]},"finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.insert_tlastmarker":{InsertTLastMarker:[12,2,1,""]},"finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.make_deployment":{DeployToPYNQ:[12,2,1,""]},"finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.make_pynq_driver":{MakePYNQDriver:[12,2,1,""]},"finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.make_pynq_proj":{MakePYNQProject:[12,2,1,""]},"finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.set_exec_mode":{SetExecMode:[12,2,1,""]},"finn.transformation.fpgadataflow.set_exec_mode.SetExecMode":{apply:[12,4,1,""]},"finn.transformation.fpgadataflow.synth_pynq_proj":{SynthPYNQProject:[12,2,1,""]},"finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject":{apply:[12,4,1,""]},"finn.transformation.general":{ConvertSubToAdd:[11,2,1,""],GiveRandomTensorNames:[11,2,1,""],GiveReadableTensorNames:[11,2,1,""],GiveUniqueNodeNames:[11,2,1,""]},"finn.transformation.general.ConvertSubToAdd":{apply:[11,4,1,""]},"finn.transformation.general.GiveRandomTensorNames":{apply:[11,4,1,""]},"finn.transformation.general.GiveReadableTensorNames":{apply:[11,4,1,""]},"finn.transformation.general.GiveUniqueNodeNames":{apply:[11,4,1,""]},"finn.transformation.infer_datatypes":{InferDataTypes:[11,2,1,""]},"finn.transformation.infer_datatypes.InferDataTypes":{apply:[11,4,1,""]},"finn.transformation.infer_shapes":{InferShapes:[11,2,1,""]},"finn.transformation.infer_shapes.InferShapes":{apply:[11,4,1,""]},"finn.transformation.streamline":{Streamline:[13,2,1,""],absorb:[13,0,0,"-"],collapse_repeated:[13,0,0,"-"],reorder:[13,0,0,"-"],round_thresholds:[13,0,0,"-"],sign_to_thres:[13,0,0,"-"]},"finn.transformation.streamline.Streamline":{apply:[13,4,1,""]},"finn.transformation.streamline.absorb":{Absorb1BitMulIntoMatMul:[13,2,1,""],AbsorbAddIntoMultiThreshold:[13,2,1,""],AbsorbMulIntoMultiThreshold:[13,2,1,""],FactorOutMulSignMagnitude:[13,2,1,""]},"finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul":{apply:[13,4,1,""]},"finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold":{apply:[13,4,1,""]},"finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold":{apply:[13,4,1,""]},"finn.transformation.streamline.absorb.FactorOutMulSignMagnitude":{apply:[13,4,1,""]},"finn.transformation.streamline.collapse_repeated":{CollapseRepeatedAdd:[13,2,1,""],CollapseRepeatedMul:[13,2,1,""],CollapseRepeatedOp:[13,2,1,""]},"finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp":{apply:[13,4,1,""]},"finn.transformation.streamline.reorder":{MoveAddPastMul:[13,2,1,""],MoveScalarAddPastMatMul:[13,2,1,""],MoveScalarMulPastMatMul:[13,2,1,""]},"finn.transformation.streamline.reorder.MoveAddPastMul":{apply:[13,4,1,""]},"finn.transformation.streamline.reorder.MoveScalarAddPastMatMul":{apply:[13,4,1,""]},"finn.transformation.streamline.reorder.MoveScalarMulPastMatMul":{apply:[13,4,1,""]},"finn.transformation.streamline.round_thresholds":{RoundAndClipThresholds:[13,2,1,""]},"finn.transformation.streamline.round_thresholds.RoundAndClipThresholds":{apply:[13,4,1,""]},"finn.transformation.streamline.sign_to_thres":{ConvertSignToThres:[13,2,1,""]},"finn.transformation.streamline.sign_to_thres.ConvertSignToThres":{apply:[13,4,1,""]},"finn.util":{basic:[14,0,0,"-"],data_packing:[14,0,0,"-"],fpgadataflow:[14,0,0,"-"],onnx:[14,0,0,"-"],test:[14,0,0,"-"]},"finn.util.basic":{CppBuilder:[14,2,1,""],calculate_signed_dot_prod_range:[14,1,1,""],gen_finn_dt_tensor:[14,1,1,""],get_by_name:[14,1,1,""],get_finn_root:[14,1,1,""],interleave_matrix_outer_dim_from_partitions:[14,1,1,""],make_build_dir:[14,1,1,""],pad_tensor_to_multiple_of:[14,1,1,""],random_string:[14,1,1,""],remove_by_name:[14,1,1,""],roundup_to_integer_multiple:[14,1,1,""]},"finn.util.basic.CppBuilder":{append_includes:[14,4,1,""],append_sources:[14,4,1,""],build:[14,4,1,""],set_executable_path:[14,4,1,""]},"finn.util.data_packing":{array2hexstring:[14,1,1,""],finnpy_to_packed_bytearray:[14,1,1,""],hexstring2npbytearray:[14,1,1,""],npbytearray2hexstring:[14,1,1,""],npy_to_rtlsim_input:[14,1,1,""],numpy_to_hls_code:[14,1,1,""],pack_innermost_dim_as_hex_string:[14,1,1,""],packed_bytearray_to_finnpy:[14,1,1,""],rtlsim_output_to_npy:[14,1,1,""],unpack_innermost_dim_from_hex_string:[14,1,1,""]},"finn.util.fpgadataflow":{IPGenBuilder:[14,2,1,""],pyverilate_stitched_ip:[14,1,1,""]},"finn.util.fpgadataflow.IPGenBuilder":{append_tcl:[14,4,1,""],build:[14,4,1,""],set_ipgen_path:[14,4,1,""]},"finn.util.onnx":{valueinfo_to_tensor:[14,1,1,""]},"finn.util.test":{get_test_model_def_fxn:[14,1,1,""],get_test_model_trained:[14,1,1,""],get_test_model_untrained:[14,1,1,""],get_trained_checkpoint:[14,1,1,""]},finn:{analysis:[6,0,0,"-"],core:[8,0,0,"-"],custom_op:[9,0,0,"-"],transformation:[11,0,0,"-"],util:[14,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","attribute","Python attribute"],"4":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:attribute","4":"py:method"},terms:{"0f01":14,"0x07":14,"0x0e":14,"0x0f01":14,"0xb":14,"0xe":14,"abstract":[9,10,11],"boolean":8,"class":[8,9,10,11,12,13,14],"const":11,"default":[9,10,11],"enum":8,"final":8,"float":14,"function":[1,8,11,14],"import":1,"new":[1,2,8],"return":[6,7,8,9,10,11,13,14],"static":6,"true":[8,14],"try":1,"var":10,For:13,HLS:[2,8],IPs:12,PEs:10,The:[1,2,6,8,11,12,13,14],There:1,Use:[8,14],abc:[9,11],abit:14,about:[2,6,12],abov:1,absorb1bitmulintomatmul:13,absorb:[5,11,12],absorbaddintomultithreshold:13,absorbmulintomultithreshold:13,acceler:[1,12],account:8,action:12,activ:8,add:[11,13],adding:1,addit:1,addition:13,address:12,after:14,aim:13,all:[1,6,8,9,10,11,12,14],all_tensors_f32:6,allow:8,alreadi:12,also:[9,10,12],amount:14,analysi:[5,8,15],analysis_fxn:8,anaylsis_fxn:8,ani:[1,8,11,12,14],annot:[6,9,10],anoth:12,append_includ:14,append_sourc:14,append_tcl:14,appli:[8,11,12,13],apply_rep:11,appropri:[1,11],arbitrari:14,architectur:2,argument:1,around:8,arrai:14,array2hexstr:14,arxiv:13,assign:8,associ:[8,11],assum:14,attribut:[6,9,10,12],attribute_nam:[9,10],attributeproto:[9,10],back:1,backend:12,base:[8,9,10,11,12,13,14],basic:[5,15],batchnorm:11,batchnorm_to_affin:[5,15],batchnormtoaffin:11,been:12,befor:14,between:[10,14],binari:[8,10,12,13,14],bipolar:[8,10,11,13,14],bipolar_to_xnor:[5,15],bit:[8,14],bitfil:1,bitwidth:8,blackboxfunct:10,block:12,blott:10,board:12,bool:[6,11],both:14,bram_estim:10,brevita:2,brien:10,browser:1,build:14,built:6,calc_tmem:10,calc_wmem:10,calcul:10,calculate_signed_dot_prod_rang:14,call:[1,8,10,11,12],can:[1,2,8,11,12,13,14],cannot:11,centerpiec:2,certain:6,chang:[1,8,11],check:[6,8,9,10],check_all_tensor_shapes_specifi:8,check_compat:8,cleanup:[5,11],clk:[10,12],clone:[1,14],code:[12,14],code_gen_dir:14,code_generation_ipgen:10,code_generation_npysim:10,codegen_ipgen:[5,11],codegen_ipstitch:[5,11],codegen_npysim:[5,11],collaps:13,collapse_rep:[5,11],collapserepeatedadd:13,collapserepeatedmul:13,collapserepeatedop:13,collect:[1,12],colloqui:2,come:[1,6],command:1,commun:2,compar:[8,9],compare_execut:8,compare_fxn:8,compat:[8,9,10],compil:[2,5,11],compile_singlenode_cod:10,complet:1,compon:2,comput:[1,8],consecut:13,constant:[6,8,13],construct:2,consum:8,contain:[1,2,8,9,12,14],content:15,context:[8,9,10],contribut:2,convent:6,convert:[1,10,11,12,13,14],convert_to_hls_lay:[5,11],convertbipolarmatmultoxnorpopcount:11,convertsigntothr:13,convertsubtoadd:11,convolutioninputgener:[5,9],copi:[8,11,12],core:[5,15],corner:2,correct:11,correctli:[1,6,9,10,12],correspond:[2,8,9,10],count:10,cpp_file:14,cppbuilder:14,creat:[1,8,12,14],create_dataflow_partit:[5,11],createdataflowpartit:12,current:[2,8],custom:[1,2,6,8],custom_op:[5,15],customop:[9,10],data:[9,12,14],data_pack:[5,15],dataflow:[2,8,12],dataoutstrm:10,datatyp:[5,9,10,11,14,15],debug:8,declar:11,deep:[2,8,10,11],default_v:[9,10],default_valu:[9,10],defin:10,depend:1,deploi:1,deploy:12,deploytopynq:12,design:[1,12],detail:2,develop:2,dict:[8,9,10],dictionari:[6,8],differ:1,digit:14,dimens:14,dimension:14,dir:[12,14],directori:[1,12,14],distr_pad:14,divis:14,doc:2,docker:14,dockerfil:1,docomput:10,doe:1,don:11,done:6,dot:14,down:1,driver:12,dt_a:14,dt_b:14,dtype:[6,8,9,10,14],dynam:6,dynamic_input_to_npi:10,each:[2,6,8,11,13,14],editor:1,effect:11,either:1,element:14,embed:8,emit:14,emphasi:2,empti:8,end:10,ensur:[10,11,12,14],entir:1,enumer:[8,11],environ:1,equal:[9,10],equival:13,estim:7,even:11,evenli:14,everi:11,everyth:1,exampl:[1,14],excel:1,exec_precompiled_singlenode_model:10,execut:[8,9,10],execute_custom_nod:[5,15],execute_nod:[8,9,10],execute_onnx:8,execute_onnx_and_make_model:8,execution_context:8,exist:[9,14],exit:14,expect:[6,8,9,10,12],experi:2,experiment:2,explor:[2,8,10],expos:8,extens:1,extra:[1,6,14],extract:[6,7],f5c6bd32ae93ec103a88152214baedff4ce1850d81065bfc:1,factor:14,factoroutmulsignmagnitud:13,fals:[8,11,14],familiar:1,fan:6,fast:10,fewest:8,field:[12,14],file:[1,8,12,14],filenam:[8,12],find:8,find_consum:8,find_produc:8,finn:3,finn_dt:14,finnpy_to_packed_bytearrai:14,first:[6,13],fix:[11,14],flatten:14,float32:[6,8],fold_const:[5,15],foldconst:11,folder:[1,12,14],follow:[1,2,6,12],form:10,forward:1,found:[2,12],four:14,fpga:[1,2],fpgadataflow:[5,6,9,11,15],fpgapart:[10,12],framework:[2,10],fraser:10,from:[1,2,7,8,12,14],full:8,further:11,gambardella:10,gen_finn_dt_tensor:14,gener:[2,5,12,14,15],generate_param:10,get:[8,9],get_all_tensor_nam:8,get_by_nam:14,get_finn_root:14,get_folded_input_shap:10,get_folded_output_shap:10,get_hls_compatible_threshold_tensor:10,get_hls_compatible_weight_tensor:10,get_hls_datatype_str:8,get_initi:8,get_input_datatyp:10,get_instream_width:10,get_metadata_prop:8,get_nodeattr:9,get_nodeattr_typ:[9,10],get_num_possible_valu:8,get_number_output_valu:10,get_output_datatyp:10,get_outstream_width:10,get_per_tensor_fanout:6,get_smallest_poss:8,get_stream_width:10,get_template_param_valu:10,get_tensor_datatyp:8,get_tensor_fanout:8,get_tensor_shap:8,get_tensor_valueinfo:8,get_test_model_def_fxn:14,get_test_model_train:14,get_test_model_untrain:14,get_trained_checkpoint:14,get_weight_datatyp:10,getcustomop:9,github:2,give:[1,11,13],give_unique_node_nam:11,given:[6,7,8,9,10,14],giverandomtensornam:11,givereadabletensornam:11,giveuniquenodenam:11,global_includ:10,graph:[6,8,9,10,11,12],graphic:2,guarante:11,guid:5,hand:2,has:[6,8,11,12,14],have:[1,6,8,11,12,13],help:1,hex:14,hexstr:14,hexstring2npbytearrai:14,high:1,highli:2,hls_synth_res_estim:[5,6],hls_var_nam:14,hlscustomop:10,hlslib:[2,10],hlssynth_ipgen:[5,11],homepag:2,host:[1,14],how:[5,14],http:1,human:11,immedi:12,implement:8,includ:[2,8,12],indic:[8,9,10,11,12],infer:[1,2,8,9,10,11,14],infer_datatyp:[5,15],infer_node_datatyp:[9,10],infer_shap:[5,15],inferbinarystreamingfclay:12,inferdatatyp:11,infershap:11,infinit:11,info:[11,14],info_messag:6,inform:[6,12],infrastructur:12,inherit:11,initi:[6,8],innermost:14,inp0:9,inp1:9,inp:10,input:[6,8,9,10,11,13,14],input_dict:8,input_dtyp:14,input_fil:14,insert:[12,14],insert_tlastmark:[5,11],inserttlastmark:12,insid:[1,9],instal:1,instanc:[8,9,10,13],instanti:12,instead:14,int16:8,int2:8,int32:8,int3:8,int4:8,int8:8,integ:[8,13,14],interfac:12,interleav:10,interleave_matrix_outer_dim_from_partit:14,intermedi:[8,11],intern:11,involv:1,ipgen_singlenode_cod:10,ipgenbuild:14,is_integ:8,is_linear:6,item:14,jupyt:2,kei:8,know:11,lab:2,lambda:8,largest:8,launch:1,layer:[11,12],lead:14,learn:[2,10],leeser:10,len:14,let:11,letter:14,librari:2,library_path:14,like:1,linear:[6,8],link:[1,2],list:[6,8],locat:1,look:[1,6],loop:11,lut_estim:10,made:[8,11],magnitud:13,mai:1,make:[1,11,12],make_build_dir:14,make_collapsed_param_fxn:13,make_deepcopi:8,make_deploy:[5,11],make_empty_exec_context:8,make_new_valueinfo_nam:8,make_project:12,make_pynq_driv:[5,11],make_pynq_proj:[5,11],make_shape_compatible_op:[9,10],makepynqdriv:12,makepynqproject:12,mani:1,manipul:8,manual:11,matmul:[11,13],matrix:[10,13,14],max:[8,14],mean:14,meant:11,member:[9,10],metadata_prop:[8,12],min:[8,14],minimum:14,mixtur:6,mkdtemp:14,mode:[1,12],model:[6,7,8,9,10,11,12,13,14],model_a:8,model_b:8,model_was_chang:11,modelproto:[8,12],modelwrapp:[5,6,11,15],modul:15,modular:2,more:[2,8,11,14],mount:1,move:13,moveaddpastmul:13,movescalaraddpastmatmul:13,movescalarmulpastmatmul:13,mul:[11,13],multidimension:14,multipl:[11,13,14],multipli:13,multithreshold:[5,12,13,15],must:[9,11,12,13,14],mvtu:12,n_partit:14,n_thres_step:10,name:[6,7,8,9,11,14],name_field:14,ndarrai:14,nearest:[13,14],necessari:12,need:[7,9,10,11],neg:[8,13],netnam:14,netron:1,network:[1,2,10],neural:[2,10],new_nam:8,next:13,no_decl:14,node:[6,7,8,9,10,11,12,13],node_inputs_in_expected_ord:6,node_res_estim:10,non:12,none:[8,9,14],note:1,notebook:2,notwithstand:6,now:[6,8],npbytearrai:14,npbytearray2hexstr:14,npy:14,npy_to_dynamic_output:10,npy_to_rtlsim_input:14,number:[8,9,10,14],numpi:[10,14],numpy_to_hls_cod:14,object:[8,14],old_nam:8,onc:11,one:[6,8,12,14],ones:1,onli:[6,8,11,12,13],onlin:1,onnx:[5,8,9,10,12,15],onnx_exec:[5,15],onnx_model_proto:8,onnx_nod:[9,10],onnxruntim:8,op_nam:13,op_typ:6,open:1,oper:[8,13],ops:[6,13],option:1,order:6,orig_thres_matrix:10,orig_weight_matrix:10,origin:10,other:[8,13],otherwis:[1,8,11,14],out:6,out_bia:9,out_scal:9,out_shap:14,outcom:12,output:[8,9,10,11,14],output_shap:14,overlai:12,overview:2,own:1,pack:[12,14],pack_innermost_dim:14,pack_innermost_dim_as_hex_str:14,packag:15,packed_bytearrai:14,packed_bytearray_to_finnpi:14,packedbit:14,pad:14,pad_tensor_to_multiple_of:14,pad_to_dim:14,pad_to_nbit:14,pair:12,paramet:13,part:[9,14],particular:[9,10,14],partit:8,pass:[5,10],password:12,past:13,path:[10,14],per:12,perform:[1,9,10],permit:[9,10],place:12,platform:12,point:[1,11],port:1,posit:[10,13,14],possibl:[8,12],pragma:10,preced:13,precid:13,precis:14,precomput:11,prefer:8,prefix:14,prepend:14,preusser:10,previous:12,print:1,prior:[11,12,14],process:1,produc:[6,8],product:14,project:[2,12],properti:[6,8],provid:[1,8],pushbutton:1,pynq:12,pynq_driver_dir:12,python:[1,12,14],pyveril:[8,14],pyverilate_stitched_ip:14,qnn:[1,2],quantiz:[2,6,10],random:[11,14],random_str:14,randomli:14,rather:1,reach:11,read:2,read_npy_data:10,readabl:11,recommend:11,refer:2,reflect:1,registri:[5,15],relat:2,remot:8,remote_exec:[5,15],remov:[12,14],remove_by_nam:14,remove_prefix:14,renam:8,rename_tensor:8,reorder:[5,11],repeat:[11,13],repeatedli:8,replac:11,repo:1,repositori:[1,2],repres:[8,14],represent:14,requir:[8,9,10],res_estim:[5,6],research:2,reset_rtlsim:10,reshap:10,resourc:[1,7],respect:14,result:[6,7,8,11,12,13,14],return_full_exec_context:8,returned_dict:[9,10],revers:14,reverse_endian:14,reverse_inn:14,right:2,root:[1,14],round:[13,14],round_threshold:[5,11],roundandclipthreshold:13,roundup_to_integer_multipl:14,row:10,rtlsim:[8,10],rtlsim_exec:[5,15],rtlsim_output_to_npi:14,run:[8,12],run_dock:1,same:[12,14],save:[8,14],save_as_npi:10,scalar:13,scp:12,script:[1,12],second:[12,13],see:[13,14],seen:2,sep:10,separ:2,sequenc:14,server:1,set:[1,8,9,10,12,13,14],set_exec_mod:[5,11],set_executable_path:14,set_initi:8,set_ipgen_path:14,set_metadata_prop:8,set_nodeattr:9,set_tensor_datatyp:8,set_tensor_shap:8,setexecmod:12,settings64:1,sever:1,shape:[8,9,10,11,14],shell:12,should:[1,6,8,11],sign:[8,11,13,14],sign_to_thr:[5,11],sim:[10,14],sim_mod:12,simd:10,simpli:1,sinc:[8,14],singl:[1,8,13,14],small:6,smallest:8,some:[1,2,8,11],someth:1,spawn:1,specif:2,specifi:[8,11,14],split:[12,13,14],stai:2,standard:[8,9,10],stitch:[8,12,14],store:[9,12,14],streamingdataflowpartit:[5,12,15],streamingfclayer_batch:[5,9,12],streamingmaxpool_batch:[5,9],streamlin:[5,11],string:[6,14],stringlength:14,strm_decl:10,structur:6,style:2,sub:11,subdirectori:12,subgraph:8,submodul:[5,15],subpackag:15,subset:6,success:12,suitabl:10,sure:1,surviv:14,synth_pynq_proj:[5,11],synthesi:[7,12],synthpynqproject:12,take:[1,6,8,11,13,14],taken:[2,8,12],target:[2,12],target_dir:12,targetbit:14,tcl:12,tcl_script:14,tempfil:14,templat:[5,9,11],temporari:14,tensor:[6,8,11,13,14],tensor_fanout:6,tensor_nam:[6,8],tensor_shap:[8,14],tensor_valu:8,termin:[1,12],ternari:8,test:[5,11,15],text:1,thei:13,them:[6,12,13],thi:[1,2,6,8,9,10,11,12,14],thing:2,thought:1,threshold:[9,10,13],time:[1,11],tlastmark:[5,9,12],tmem:10,togeth:12,toggle_clk:10,token:1,tool:[1,2],topolog:[5,15],train:[1,2],transform:[5,8,15],transformed_model:11,travers:6,tune:2,tupl:11,two:[2,8,12,13,14],type:[8,11,14],ubuntu:1,uint16:8,uint2:[8,14],uint32:8,uint3:8,uint4:8,uint8:[8,14],umuroglu:10,under:[2,12],uniqu:11,unpack:[12,14],unpack_innermost_dim_from_hex_str:14,unsign:[8,13],until:8,updat:[2,13],upper:2,use:2,used:[2,8,9,10,14],useful:8,user:11,usernam:12,using:[2,8,11,13,14],util:[5,8,9,10,15],val:14,valu:[8,9,10,12,13,14],value_info:8,valueinfo:[8,11],valueinfo_to_tensor:14,valueinfoproto:[8,14],variabl:[1,14],vector:[13,14],verif:6,verifi:[6,9,10],verify_custom_nod:[5,15],verify_nod:[6,9,10],version:2,via:8,view:2,visser:10,vivado:[1,2,7,8,12],vivado_path:1,vivado_pynq_proj:12,vivado_stitch_proj:12,wai:[1,6],want:13,wbit:14,websit:2,weight:[8,10],welcom:2,well:1,when:[6,11],where:[1,8,9,10,12,13],whether:[6,8,9,10,11],which:[1,2,8,9,10,12,13,14],width:14,without:1,wmem:10,work:[1,8,14],workspac:1,wrapper:8,write:[1,5],xilinx:2,xnorpopcount:[5,15],xnorpopcountmatmul:[9,11,12],you:[1,11],your:[1,11],zero:[8,13,14]},titles:["FINN - End-to-End Flow","Getting Started","FINN","<no title>","Source Code","finn package","finn.analysis package","finn.analysis.fpgadataflow package","finn.core package","finn.custom_op package","finn.custom_op.fpgadataflow package","finn.transformation package","finn.transformation.fpgadataflow package","finn.transformation.streamline package","finn.util package","finn"],titleterms:{absorb:13,analysi:[6,7],basic:14,batchnorm_to_affin:11,bipolar_to_xnor:11,cleanup:12,code:4,codegen_ipgen:12,codegen_ipstitch:12,codegen_npysim:12,collapse_rep:13,compil:[1,12],content:[5,6,7,8,9,10,11,12,13,14],convert_to_hls_lay:12,convolutioninputgener:10,core:8,create_dataflow_partit:12,custom_op:[9,10],data_pack:14,datatyp:8,develop:1,directli:1,docker:1,end:0,execute_custom_nod:8,experiment:1,finn:[0,1,2,5,6,7,8,9,10,11,12,13,14,15],flow:0,fold_const:11,fpgadataflow:[7,10,12,14],gener:11,get:1,guid:11,hls_synth_res_estim:7,hlssynth_ipgen:12,how:[1,6],infer_datatyp:11,infer_shap:11,insert_tlastmark:12,interact:1,jenkin:1,jupyt:1,make_deploy:12,make_pynq_driv:12,make_pynq_proj:12,modelwrapp:8,modul:[5,6,7,8,9,10,11,12,13,14],multithreshold:9,notebook:1,onnx:14,onnx_exec:8,packag:[5,6,7,8,9,10,11,12,13,14],pass:6,registri:9,remote_exec:8,reorder:13,requir:1,res_estim:7,round_threshold:13,rtlsim_exec:8,run:1,set_exec_mod:12,shell:1,sign_to_thr:13,sourc:4,src:[],start:1,streamingdataflowpartit:9,streamingfclayer_batch:10,streamingmaxpool_batch:10,streamlin:13,submodul:[6,7,8,9,10,11,12,13,14],subpackag:[5,6,9,11],suit:1,synth_pynq_proj:12,templat:[10,12],test:[1,14],tlastmark:10,topolog:6,transform:[11,12,13],use:1,using:1,util:14,verify_custom_nod:6,what:2,write:[6,11],xnorpopcount:9}}) \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/analysis.fpgadataflow.html b/docs/finn/_build/html/source_code/analysis.fpgadataflow.html deleted file mode 100644 index 60f70aab3200dc986e40269e51fc5b1e00bad222..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/analysis.fpgadataflow.html +++ /dev/null @@ -1,226 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>analysis.fpgadataflow package — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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="prev" title="analysis package" href="analysis.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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 current"><a class="reference internal" href="../source_code.html">finn package</a><ul class="current"> -<li class="toctree-l2 current"><a class="reference internal" href="../source_code.html#subpackages">Subpackages</a><ul class="current"> -<li class="toctree-l3 current"><a class="reference internal" href="analysis.html">analysis package</a><ul class="current"> -<li class="toctree-l4 current"><a class="reference internal" href="analysis.html#subpackages">Subpackages</a></li> -</ul> -</li> -</ul> -</li> -</ul> -</li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">finn package</a> »</li> - - <li><a href="analysis.html">analysis package</a> »</li> - - <li>analysis.fpgadataflow package</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/analysis.fpgadataflow.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="analysis-fpgadataflow-package"> -<h1>analysis.fpgadataflow package<a class="headerlink" href="#analysis-fpgadataflow-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="analysis-fpgadataflow-hls-synth-res-estimation-module"> -<h2>analysis.fpgadataflow.hls_synth_res_estimation module<a class="headerlink" href="#analysis-fpgadataflow-hls-synth-res-estimation-module" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="analysis-fpgadataflow-res-estimation-module"> -<h2>analysis.fpgadataflow.res_estimation module<a class="headerlink" href="#analysis-fpgadataflow-res-estimation-module" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-contents"> -<h2>Module contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> -</div> -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - - <a href="analysis.html" class="btn btn-neutral float-left" title="analysis package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/analysis.html b/docs/finn/_build/html/source_code/analysis.html deleted file mode 100644 index fe50baa48e02af2dc138f8c09e06328ee927b213..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/analysis.html +++ /dev/null @@ -1,229 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>analysis package — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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="analysis.fpgadataflow package" href="analysis.fpgadataflow.html" /> - <link rel="prev" title="finn package" href="../source_code.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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 current"><a class="reference internal" href="../source_code.html">finn package</a><ul class="current"> -<li class="toctree-l2 current"><a class="reference internal" href="../source_code.html#subpackages">Subpackages</a><ul class="current"> -<li class="toctree-l3 current"><a class="current reference internal" href="#">analysis package</a><ul> -<li class="toctree-l4"><a class="reference internal" href="#subpackages">Subpackages</a></li> -</ul> -</li> -</ul> -</li> -</ul> -</li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">finn package</a> »</li> - - <li>analysis package</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/analysis.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="analysis-package"> -<h1>analysis package<a class="headerlink" href="#analysis-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="subpackages"> -<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="analysis.fpgadataflow.html">analysis.fpgadataflow package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="analysis.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="analysis.fpgadataflow.html#analysis-fpgadataflow-hls-synth-res-estimation-module">analysis.fpgadataflow.hls_synth_res_estimation module</a></li> -<li class="toctree-l2"><a class="reference internal" href="analysis.fpgadataflow.html#analysis-fpgadataflow-res-estimation-module">analysis.fpgadataflow.res_estimation module</a></li> -<li class="toctree-l2"><a class="reference internal" href="analysis.fpgadataflow.html#module-contents">Module contents</a></li> -</ul> -</li> -</ul> -</div> -</div> -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="analysis.fpgadataflow.html" class="btn btn-neutral float-right" title="analysis.fpgadataflow package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="../source_code.html" class="btn btn-neutral float-left" title="finn package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/analysis/analysis.fpgadataflow.html b/docs/finn/_build/html/source_code/analysis/analysis.fpgadataflow.html deleted file mode 100644 index 18949c221e0e67fcf414061f0987e5abfcbc8cc4..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/analysis/analysis.fpgadataflow.html +++ /dev/null @@ -1,231 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>analysis.fpgadataflow package — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> - <script type="text/javascript" src="../../_static/jquery.js"></script> - <script type="text/javascript" src="../../_static/underscore.js"></script> - <script type="text/javascript" src="../../_static/doctools.js"></script> - <script type="text/javascript" src="../../_static/language_data.js"></script> - - <script type="text/javascript" src="../../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> - <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="prev" title="analysis package" href="analysis.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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 current"><a class="reference internal" href="../../source_code.html">finn package</a><ul class="current"> -<li class="toctree-l2 current"><a class="reference internal" href="../../source_code.html#subpackages">Subpackages</a><ul class="current"> -<li class="toctree-l3 current"><a class="reference internal" href="analysis.html">analysis package</a><ul class="current"> -<li class="toctree-l4 current"><a class="reference internal" href="analysis.html#subpackages">Subpackages</a></li> -<li class="toctree-l4"><a class="reference internal" href="analysis.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="analysis.html#analysis-topology-module">analysis.topology module</a></li> -<li class="toctree-l4"><a class="reference internal" href="analysis.html#analysis-verify-custom-nodes-module">analysis.verify_custom_nodes module</a></li> -<li class="toctree-l4"><a class="reference internal" href="analysis.html#module-contents">Module contents</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="../../source_code.html#module-finn">Module contents</a></li> -</ul> -</li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../../index.html">Docs</a> »</li> - - <li><a href="../../source_code.html">finn package</a> »</li> - - <li><a href="analysis.html">analysis package</a> »</li> - - <li>analysis.fpgadataflow package</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../../_sources/source_code/analysis/analysis.fpgadataflow.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="analysis-fpgadataflow-package"> -<h1>analysis.fpgadataflow package<a class="headerlink" href="#analysis-fpgadataflow-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="analysis-fpgadataflow-hls-synth-res-estimation-module"> -<h2>analysis.fpgadataflow.hls_synth_res_estimation module<a class="headerlink" href="#analysis-fpgadataflow-hls-synth-res-estimation-module" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="analysis-fpgadataflow-res-estimation-module"> -<h2>analysis.fpgadataflow.res_estimation module<a class="headerlink" href="#analysis-fpgadataflow-res-estimation-module" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-contents"> -<h2>Module contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> -</div> -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - - <a href="analysis.html" class="btn btn-neutral float-left" title="analysis package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/analysis/analysis.html b/docs/finn/_build/html/source_code/analysis/analysis.html deleted file mode 100644 index 57e76a8a24778abb48f750a844e7d592cac3784d..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/analysis/analysis.html +++ /dev/null @@ -1,246 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>analysis package — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> - <script type="text/javascript" src="../../_static/jquery.js"></script> - <script type="text/javascript" src="../../_static/underscore.js"></script> - <script type="text/javascript" src="../../_static/doctools.js"></script> - <script type="text/javascript" src="../../_static/language_data.js"></script> - - <script type="text/javascript" src="../../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> - <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="analysis.fpgadataflow package" href="analysis.fpgadataflow.html" /> - <link rel="prev" title="finn package" href="../../source_code.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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 current"><a class="reference internal" href="../../source_code.html">finn package</a><ul class="current"> -<li class="toctree-l2 current"><a class="reference internal" href="../../source_code.html#subpackages">Subpackages</a><ul class="current"> -<li class="toctree-l3 current"><a class="current reference internal" href="#">analysis package</a><ul> -<li class="toctree-l4"><a class="reference internal" href="#subpackages">Subpackages</a></li> -<li class="toctree-l4"><a class="reference internal" href="#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="#analysis-topology-module">analysis.topology module</a></li> -<li class="toctree-l4"><a class="reference internal" href="#analysis-verify-custom-nodes-module">analysis.verify_custom_nodes module</a></li> -<li class="toctree-l4"><a class="reference internal" href="#module-contents">Module contents</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="../../source_code.html#module-finn">Module contents</a></li> -</ul> -</li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../../index.html">Docs</a> »</li> - - <li><a href="../../source_code.html">finn package</a> »</li> - - <li>analysis package</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../../_sources/source_code/analysis/analysis.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="analysis-package"> -<h1>analysis package<a class="headerlink" href="#analysis-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="subpackages"> -<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="analysis.fpgadataflow.html">analysis.fpgadataflow package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="analysis.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="analysis.fpgadataflow.html#analysis-fpgadataflow-hls-synth-res-estimation-module">analysis.fpgadataflow.hls_synth_res_estimation module</a></li> -<li class="toctree-l2"><a class="reference internal" href="analysis.fpgadataflow.html#analysis-fpgadataflow-res-estimation-module">analysis.fpgadataflow.res_estimation module</a></li> -<li class="toctree-l2"><a class="reference internal" href="analysis.fpgadataflow.html#module-contents">Module contents</a></li> -</ul> -</li> -</ul> -</div> -</div> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="analysis-topology-module"> -<h2>analysis.topology module<a class="headerlink" href="#analysis-topology-module" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="analysis-verify-custom-nodes-module"> -<h2>analysis.verify_custom_nodes module<a class="headerlink" href="#analysis-verify-custom-nodes-module" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-contents"> -<h2>Module contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> -</div> -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="analysis.fpgadataflow.html" class="btn btn-neutral float-right" title="analysis.fpgadataflow package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="../../source_code.html" class="btn btn-neutral float-left" title="finn package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.html b/docs/finn/_build/html/source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.html deleted file mode 100644 index a333ed66b3935eddf9f78ccc47f807e014f87939..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.html +++ /dev/null @@ -1,219 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.analysis.fpgadataflow.hls_synth_res_estimation module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.analysis.fpgadataflow.res_estimation module" href="finn.analysis.fpgadataflow.res_estimation.html" /> - <link rel="prev" title="finn.analysis.fpgadataflow package" href="finn.analysis.fpgadataflow.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.analysis.html">finn.analysis package</a> »</li> - - <li><a href="finn.analysis.fpgadataflow.html">finn.analysis.fpgadataflow package</a> »</li> - - <li>finn.analysis.fpgadataflow.hls_synth_res_estimation module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.analysis.fpgadataflow.hls_synth_res_estimation"> -<span id="finn-analysis-fpgadataflow-hls-synth-res-estimation-module"></span><h1>finn.analysis.fpgadataflow.hls_synth_res_estimation module<a class="headerlink" href="#module-finn.analysis.fpgadataflow.hls_synth_res_estimation" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<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> -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.analysis.fpgadataflow.res_estimation.html" class="btn btn-neutral float-right" title="finn.analysis.fpgadataflow.res_estimation module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.analysis.fpgadataflow.html" class="btn btn-neutral float-left" title="finn.analysis.fpgadataflow package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file 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 db2539484e93835a091139c1ef08288145baba37..bdaa8bda5f16972218db543223c3e4229cc65963 100644 --- a/docs/finn/_build/html/source_code/finn.analysis.fpgadataflow.html +++ b/docs/finn/_build/html/source_code/finn.analysis.fpgadataflow.html @@ -34,7 +34,9 @@ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <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="search" title="Search" href="../search.html" /> + <link rel="next" title="finn.core package" href="finn.core.html" /> + <link rel="prev" title="finn.analysis package" href="finn.analysis.html" /> </head> <body class="wy-body-for-nav"> @@ -127,6 +129,12 @@ <li><a href="../index.html">Docs</a> »</li> + <li><a href="../source_code.html">Source Code</a> »</li> + + <li><a href="finn.html">finn package</a> »</li> + + <li><a href="finn.analysis.html">finn.analysis package</a> »</li> + <li>finn.analysis.fpgadataflow package</li> @@ -182,6 +190,15 @@ Returns {node name : resource estimation}</p> </div> <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="finn.core.html" class="btn btn-neutral float-right" title="finn.core package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="finn.analysis.html" class="btn btn-neutral float-left" title="finn.analysis package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + <hr/> diff --git a/docs/finn/_build/html/source_code/finn.analysis.fpgadataflow.res_estimation.html b/docs/finn/_build/html/source_code/finn.analysis.fpgadataflow.res_estimation.html deleted file mode 100644 index 7e52637fc0fb47ee2ac9b6c8c2c65b35b802faf8..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.analysis.fpgadataflow.res_estimation.html +++ /dev/null @@ -1,219 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.analysis.fpgadataflow.res_estimation module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.analysis.topology module" href="finn.analysis.topology.html" /> - <link rel="prev" title="finn.analysis.fpgadataflow.hls_synth_res_estimation module" href="finn.analysis.fpgadataflow.hls_synth_res_estimation.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.analysis.html">finn.analysis package</a> »</li> - - <li><a href="finn.analysis.fpgadataflow.html">finn.analysis.fpgadataflow package</a> »</li> - - <li>finn.analysis.fpgadataflow.res_estimation module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.analysis.fpgadataflow.res_estimation.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.analysis.fpgadataflow.res_estimation"> -<span id="finn-analysis-fpgadataflow-res-estimation-module"></span><h1>finn.analysis.fpgadataflow.res_estimation module<a class="headerlink" href="#module-finn.analysis.fpgadataflow.res_estimation" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<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> -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.analysis.topology.html" class="btn btn-neutral float-right" title="finn.analysis.topology module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.analysis.fpgadataflow.hls_synth_res_estimation.html" class="btn btn-neutral float-left" title="finn.analysis.fpgadataflow.hls_synth_res_estimation module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.analysis.html b/docs/finn/_build/html/source_code/finn.analysis.html index 48d59aa2044f0bfe614218267d9fa9e148b5bde2..095e509874aefeeafb71734df3dc61fabac5a274 100644 --- a/docs/finn/_build/html/source_code/finn.analysis.html +++ b/docs/finn/_build/html/source_code/finn.analysis.html @@ -34,7 +34,9 @@ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <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="search" title="Search" href="../search.html" /> + <link rel="next" title="finn.analysis.fpgadataflow package" href="finn.analysis.fpgadataflow.html" /> + <link rel="prev" title="finn package" href="finn.html" /> </head> <body class="wy-body-for-nav"> @@ -127,6 +129,10 @@ <li><a href="../index.html">Docs</a> »</li> + <li><a href="../source_code.html">Source Code</a> »</li> + + <li><a href="finn.html">finn package</a> »</li> + <li>finn.analysis package</li> @@ -226,6 +232,15 @@ a dictionary of named properties that the analysis extracts.</p> </div> <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="finn.analysis.fpgadataflow.html" class="btn btn-neutral float-right" title="finn.analysis.fpgadataflow package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="finn.html" class="btn btn-neutral float-left" title="finn package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + <hr/> diff --git a/docs/finn/_build/html/source_code/finn.analysis.topology.html b/docs/finn/_build/html/source_code/finn.analysis.topology.html deleted file mode 100644 index f602bb8f2bf0280cab567b6dc2cefa693b8a2cee..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.analysis.topology.html +++ /dev/null @@ -1,240 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.analysis.topology module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.analysis.verify_custom_nodes module" href="finn.analysis.verify_custom_nodes.html" /> - <link rel="prev" title="finn.analysis.fpgadataflow.res_estimation module" href="finn.analysis.fpgadataflow.res_estimation.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.analysis.html">finn.analysis package</a> »</li> - - <li>finn.analysis.topology module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.analysis.topology.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.analysis.topology"> -<span id="finn-analysis-topology-module"></span><h1>finn.analysis.topology module<a class="headerlink" href="#module-finn.analysis.topology" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<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> -</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></dl> - -<dl class="function"> -<dt id="finn.analysis.topology.is_linear"> -<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> -</dd></dl> - -<dl class="function"> -<dt id="finn.analysis.topology.node_inputs_in_expected_order"> -<code class="sig-prename descclassname">finn.analysis.topology.</code><code class="sig-name descname">node_inputs_in_expected_order</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.analysis.topology.node_inputs_in_expected_order" title="Permalink to this definition">¶</a></dt> -<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> -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.analysis.verify_custom_nodes.html" class="btn btn-neutral float-right" title="finn.analysis.verify_custom_nodes module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.analysis.fpgadataflow.res_estimation.html" class="btn btn-neutral float-left" title="finn.analysis.fpgadataflow.res_estimation module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.analysis.verify_custom_nodes.html b/docs/finn/_build/html/source_code/finn.analysis.verify_custom_nodes.html deleted file mode 100644 index 5c7b82a0dea878b9e6e680e93c11dcd6db03d88f..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.analysis.verify_custom_nodes.html +++ /dev/null @@ -1,218 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.analysis.verify_custom_nodes module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.core package" href="finn.core.html" /> - <link rel="prev" title="finn.analysis.topology module" href="finn.analysis.topology.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.analysis.html">finn.analysis package</a> »</li> - - <li>finn.analysis.verify_custom_nodes module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.analysis.verify_custom_nodes.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.analysis.verify_custom_nodes"> -<span id="finn-analysis-verify-custom-nodes-module"></span><h1>finn.analysis.verify_custom_nodes module<a class="headerlink" href="#module-finn.analysis.verify_custom_nodes" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<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> -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.core.html" class="btn btn-neutral float-right" title="finn.core package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.analysis.topology.html" class="btn btn-neutral float-left" title="finn.analysis.topology module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.core.datatype.html b/docs/finn/_build/html/source_code/finn.core.datatype.html deleted file mode 100644 index 2d35ed438f8ee1cfbdcf928e2fbc5009c7046bf0..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.core.datatype.html +++ /dev/null @@ -1,354 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.core.datatype module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.core.execute_custom_node module" href="finn.core.execute_custom_node.html" /> - <link rel="prev" title="finn.core package" href="finn.core.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.core.html">finn.core package</a> »</li> - - <li>finn.core.datatype module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.core.datatype.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.core.datatype"> -<span id="finn-core-datatype-module"></span><h1>finn.core.datatype module<a class="headerlink" href="#module-finn.core.datatype" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.core.datatype.DataType"> -<em class="property">class </em><code class="sig-prename descclassname">finn.core.datatype.</code><code class="sig-name descname">DataType</code><a class="headerlink" href="#finn.core.datatype.DataType" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p> -<p>An enumeration.</p> -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.BINARY"> -<code class="sig-name descname">BINARY</code><em class="property"> = 1</em><a class="headerlink" href="#finn.core.datatype.DataType.BINARY" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.BIPOLAR"> -<code class="sig-name descname">BIPOLAR</code><em class="property"> = 8</em><a class="headerlink" href="#finn.core.datatype.DataType.BIPOLAR" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.FLOAT32"> -<code class="sig-name descname">FLOAT32</code><em class="property"> = 16</em><a class="headerlink" href="#finn.core.datatype.DataType.FLOAT32" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.INT16"> -<code class="sig-name descname">INT16</code><em class="property"> = 14</em><a class="headerlink" href="#finn.core.datatype.DataType.INT16" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.INT2"> -<code class="sig-name descname">INT2</code><em class="property"> = 10</em><a class="headerlink" href="#finn.core.datatype.DataType.INT2" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.INT3"> -<code class="sig-name descname">INT3</code><em class="property"> = 11</em><a class="headerlink" href="#finn.core.datatype.DataType.INT3" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.INT32"> -<code class="sig-name descname">INT32</code><em class="property"> = 15</em><a class="headerlink" href="#finn.core.datatype.DataType.INT32" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.INT4"> -<code class="sig-name descname">INT4</code><em class="property"> = 12</em><a class="headerlink" href="#finn.core.datatype.DataType.INT4" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.INT8"> -<code class="sig-name descname">INT8</code><em class="property"> = 13</em><a class="headerlink" href="#finn.core.datatype.DataType.INT8" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.TERNARY"> -<code class="sig-name descname">TERNARY</code><em class="property"> = 9</em><a class="headerlink" href="#finn.core.datatype.DataType.TERNARY" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.UINT16"> -<code class="sig-name descname">UINT16</code><em class="property"> = 6</em><a class="headerlink" href="#finn.core.datatype.DataType.UINT16" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.UINT2"> -<code class="sig-name descname">UINT2</code><em class="property"> = 2</em><a class="headerlink" href="#finn.core.datatype.DataType.UINT2" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.UINT3"> -<code class="sig-name descname">UINT3</code><em class="property"> = 3</em><a class="headerlink" href="#finn.core.datatype.DataType.UINT3" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.UINT32"> -<code class="sig-name descname">UINT32</code><em class="property"> = 7</em><a class="headerlink" href="#finn.core.datatype.DataType.UINT32" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.UINT4"> -<code class="sig-name descname">UINT4</code><em class="property"> = 4</em><a class="headerlink" href="#finn.core.datatype.DataType.UINT4" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="finn.core.datatype.DataType.UINT8"> -<code class="sig-name descname">UINT8</code><em class="property"> = 5</em><a class="headerlink" href="#finn.core.datatype.DataType.UINT8" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.allowed"> -<code class="sig-name descname">allowed</code><span class="sig-paren">(</span><em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.allowed" title="Permalink to this definition">¶</a></dt> -<dd><p>Check whether given value is allowed for this DataType.</p> -<p>value (float32): value to be checked</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.bitwidth"> -<code class="sig-name descname">bitwidth</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.bitwidth" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the number of bits required for this DataType.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.get_hls_datatype_str"> -<code class="sig-name descname">get_hls_datatype_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.get_hls_datatype_str" title="Permalink to this definition">¶</a></dt> -<dd><p>Return the corresponding Vivado HLS datatype name.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.get_num_possible_values"> -<code class="sig-name descname">get_num_possible_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.get_num_possible_values" title="Permalink to this definition">¶</a></dt> -<dd><p>Return the number of possible values this DataType can take. Only -implemented for integer types for now.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.get_smallest_possible"> -<code class="sig-name descname">get_smallest_possible</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.get_smallest_possible" title="Permalink to this definition">¶</a></dt> -<dd><p>Return smallest (fewest bits) possible DataType that can represent -value. Prefers unsigned integers where possible.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.is_integer"> -<code class="sig-name descname">is_integer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.is_integer" title="Permalink to this definition">¶</a></dt> -<dd><p>Return whether this DataType represents integer values only.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.max"> -<code class="sig-name descname">max</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.max" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the largest possible value allowed by this DataType.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.min"> -<code class="sig-name descname">min</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.min" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the smallest possible value allowed by this DataType.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.datatype.DataType.signed"> -<code class="sig-name descname">signed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.datatype.DataType.signed" title="Permalink to this definition">¶</a></dt> -<dd><p>Return whether this DataType can represent negative numbers.</p> -</dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.core.execute_custom_node.html" class="btn btn-neutral float-right" title="finn.core.execute_custom_node module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.core.html" class="btn btn-neutral float-left" title="finn.core package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.core.execute_custom_node.html b/docs/finn/_build/html/source_code/finn.core.execute_custom_node.html deleted file mode 100644 index 45ac552b12ec7a217bcc47c63ccb7f7ee0a5471d..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.core.execute_custom_node.html +++ /dev/null @@ -1,217 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.core.execute_custom_node module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.core.modelwrapper module" href="finn.core.modelwrapper.html" /> - <link rel="prev" title="finn.core.datatype module" href="finn.core.datatype.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.core.html">finn.core package</a> »</li> - - <li>finn.core.execute_custom_node module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.core.execute_custom_node.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.core.execute_custom_node"> -<span id="finn-core-execute-custom-node-module"></span><h1>finn.core.execute_custom_node module<a class="headerlink" href="#module-finn.core.execute_custom_node" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="finn.core.execute_custom_node.execute_custom_node"> -<code class="sig-prename descclassname">finn.core.execute_custom_node.</code><code class="sig-name descname">execute_custom_node</code><span class="sig-paren">(</span><em class="sig-param">node</em>, <em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.execute_custom_node.execute_custom_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Call custom implementation to execute a single custom node. -Input/output provided via context.</p> -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.core.modelwrapper.html" class="btn btn-neutral float-right" title="finn.core.modelwrapper module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.core.datatype.html" class="btn btn-neutral float-left" title="finn.core.datatype module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.core.html b/docs/finn/_build/html/source_code/finn.core.html index 7114bec695fb5fda3e42f05babf0bc80cfaa77dd..98aff76d9cd871b7c29d70324ff95650f894eb99 100644 --- a/docs/finn/_build/html/source_code/finn.core.html +++ b/docs/finn/_build/html/source_code/finn.core.html @@ -34,7 +34,9 @@ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <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="search" title="Search" href="../search.html" /> + <link rel="next" title="finn.custom_op package" href="finn.custom_op.html" /> + <link rel="prev" title="finn.analysis.fpgadataflow package" href="finn.analysis.fpgadataflow.html" /> </head> <body class="wy-body-for-nav"> @@ -127,6 +129,10 @@ <li><a href="../index.html">Docs</a> »</li> + <li><a href="../source_code.html">Source Code</a> »</li> + + <li><a href="finn.html">finn package</a> »</li> + <li>finn.core package</li> @@ -535,6 +541,15 @@ all the intermediate activation values.</p> </div> <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="finn.custom_op.html" class="btn btn-neutral float-right" title="finn.custom_op package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="finn.analysis.fpgadataflow.html" class="btn btn-neutral float-left" title="finn.analysis.fpgadataflow package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + <hr/> diff --git a/docs/finn/_build/html/source_code/finn.core.modelwrapper.html b/docs/finn/_build/html/source_code/finn.core.modelwrapper.html deleted file mode 100644 index a1db6121278c826421deaed513696028e025df23..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.core.modelwrapper.html +++ /dev/null @@ -1,368 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.core.modelwrapper module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.core.onnx_exec module" href="finn.core.onnx_exec.html" /> - <link rel="prev" title="finn.core.execute_custom_node module" href="finn.core.execute_custom_node.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.core.html">finn.core package</a> »</li> - - <li>finn.core.modelwrapper module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.core.modelwrapper.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.core.modelwrapper"> -<span id="finn-core-modelwrapper-module"></span><h1>finn.core.modelwrapper module<a class="headerlink" href="#module-finn.core.modelwrapper" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.core.modelwrapper.ModelWrapper"> -<em class="property">class </em><code class="sig-prename descclassname">finn.core.modelwrapper.</code><code class="sig-name descname">ModelWrapper</code><span class="sig-paren">(</span><em class="sig-param">onnx_model_proto</em>, <em class="sig-param">make_deepcopy=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> -<p>A wrapper around ONNX ModelProto that exposes some useful utility -functions for graph manipulation and exploration.</p> -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.analysis"> -<code class="sig-name descname">analysis</code><span class="sig-paren">(</span><em class="sig-param">analysis_fxn</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.analysis" title="Permalink to this definition">¶</a></dt> -<dd><p>Run given anaylsis_fxn on this model and return resulting dict.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.check_all_tensor_shapes_specified"> -<code class="sig-name descname">check_all_tensor_shapes_specified</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.check_all_tensor_shapes_specified" title="Permalink to this definition">¶</a></dt> -<dd><p>Checks whether all tensors have a specified shape (ValueInfo). -The ONNX standard allows for intermediate activations to have no -associated ValueInfo, but FINN expects this.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.check_compatibility"> -<code class="sig-name descname">check_compatibility</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.check_compatibility" title="Permalink to this definition">¶</a></dt> -<dd><p>Checks this model for FINN compatibility: -* no embedded subgraphs -* all tensor shapes are specified, including activations -* all constants are initializers</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.find_consumer"> -<code class="sig-name descname">find_consumer</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.find_consumer" title="Permalink to this definition">¶</a></dt> -<dd><p>Find and return the node that consumes the tensor with given name. -Currently only works for linear graphs.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.find_producer"> -<code class="sig-name descname">find_producer</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.find_producer" title="Permalink to this definition">¶</a></dt> -<dd><p>Find and return the node that produces the tensor with given name. -Currently only works for linear graphs.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.get_all_tensor_names"> -<code class="sig-name descname">get_all_tensor_names</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.get_all_tensor_names" title="Permalink to this definition">¶</a></dt> -<dd><p>Return a list of all (input, output and value_info) tensor names -in the graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.get_initializer"> -<code class="sig-name descname">get_initializer</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.get_initializer" title="Permalink to this definition">¶</a></dt> -<dd><p>Get the initializer value for tensor with given name, if any.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.get_metadata_prop"> -<code class="sig-name descname">get_metadata_prop</code><span class="sig-paren">(</span><em class="sig-param">key</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.get_metadata_prop" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the value associated with metadata_prop with given key, -or None otherwise.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.get_tensor_datatype"> -<code class="sig-name descname">get_tensor_datatype</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.get_tensor_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the FINN DataType of tensor with given name.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.get_tensor_fanout"> -<code class="sig-name descname">get_tensor_fanout</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.get_tensor_fanout" title="Permalink to this definition">¶</a></dt> -<dd><p>Return the number of nodes for which the tensor with given name is -as input.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.get_tensor_shape"> -<code class="sig-name descname">get_tensor_shape</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.get_tensor_shape" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the shape of tensor with given name, if it has ValueInfoProto.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.get_tensor_valueinfo"> -<code class="sig-name descname">get_tensor_valueinfo</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.get_tensor_valueinfo" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns ValueInfoProto of tensor with given name, if it has one.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.graph"> -<em class="property">property </em><code class="sig-name descname">graph</code><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.graph" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.make_empty_exec_context"> -<code class="sig-name descname">make_empty_exec_context</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.make_empty_exec_context" title="Permalink to this definition">¶</a></dt> -<dd><p>Creates an empty execution context for this model. -The execution context is a dictionary of all tensors used for the -inference computation. Any initializer values will be taken into -account, all other tensors will be zero.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.make_new_valueinfo_name"> -<code class="sig-name descname">make_new_valueinfo_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.make_new_valueinfo_name" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a name that can be used for a new value_info.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.model"> -<em class="property">property </em><code class="sig-name descname">model</code><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.model" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.rename_tensor"> -<code class="sig-name descname">rename_tensor</code><span class="sig-paren">(</span><em class="sig-param">old_name</em>, <em class="sig-param">new_name</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.rename_tensor" title="Permalink to this definition">¶</a></dt> -<dd><p>Rename a tensor from old_name to new_name.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.save"> -<code class="sig-name descname">save</code><span class="sig-paren">(</span><em class="sig-param">filename</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.save" title="Permalink to this definition">¶</a></dt> -<dd><p>Save the wrapper ONNX ModelProto into a file with given name.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.set_initializer"> -<code class="sig-name descname">set_initializer</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em>, <em class="sig-param">tensor_value</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.set_initializer" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the initializer value for tensor with given name.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.set_metadata_prop"> -<code class="sig-name descname">set_metadata_prop</code><span class="sig-paren">(</span><em class="sig-param">key</em>, <em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.set_metadata_prop" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.set_tensor_datatype"> -<code class="sig-name descname">set_tensor_datatype</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em>, <em class="sig-param">datatype</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.set_tensor_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Sets the FINN DataType of tensor with given name.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.set_tensor_shape"> -<code class="sig-name descname">set_tensor_shape</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em>, <em class="sig-param">tensor_shape</em>, <em class="sig-param">dtype=1</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.set_tensor_shape" title="Permalink to this definition">¶</a></dt> -<dd><p>Assign shape in ValueInfoProto for tensor with given name.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.core.modelwrapper.ModelWrapper.transform"> -<code class="sig-name descname">transform</code><span class="sig-paren">(</span><em class="sig-param">transformation</em>, <em class="sig-param">make_deepcopy=True</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.modelwrapper.ModelWrapper.transform" title="Permalink to this definition">¶</a></dt> -<dd><p>Applies given Transformation repeatedly until no more changes can be made -and returns a transformed ModelWrapper instance. -If make_deepcopy is specified, operates on a new (deep)copy of model.</p> -</dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.core.onnx_exec.html" class="btn btn-neutral float-right" title="finn.core.onnx_exec module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.core.execute_custom_node.html" class="btn btn-neutral float-left" title="finn.core.execute_custom_node module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.core.onnx_exec.html b/docs/finn/_build/html/source_code/finn.core.onnx_exec.html deleted file mode 100644 index a6e8dd8d9b2983016c0d9b90ffae85a09e20fbe7..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.core.onnx_exec.html +++ /dev/null @@ -1,245 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.core.onnx_exec module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.core.remote_exec module" href="finn.core.remote_exec.html" /> - <link rel="prev" title="finn.core.modelwrapper module" href="finn.core.modelwrapper.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.core.html">finn.core package</a> »</li> - - <li>finn.core.onnx_exec module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.core.onnx_exec.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.core.onnx_exec"> -<span id="finn-core-onnx-exec-module"></span><h1>finn.core.onnx_exec module<a class="headerlink" href="#module-finn.core.onnx_exec" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="finn.core.onnx_exec.compare_execution"> -<code class="sig-prename descclassname">finn.core.onnx_exec.</code><code class="sig-name descname">compare_execution</code><span class="sig-paren">(</span><em class="sig-param">model_a</em>, <em class="sig-param">model_b</em>, <em class="sig-param">input_dict</em>, <em class="sig-param">compare_fxn=<function <lambda>></em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.onnx_exec.compare_execution" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute two ONNX models and compare their outputs using given function. -compare_fxn should take in two tensors and return a Boolean</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.core.onnx_exec.execute_node"> -<code class="sig-prename descclassname">finn.core.onnx_exec.</code><code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">node</em>, <em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.onnx_exec.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute a single node by using onnxruntime, with custom function or -if dataflow partition by using remote execution or rtlsim. -Input/output provided via context.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.core.onnx_exec.execute_onnx"> -<code class="sig-prename descclassname">finn.core.onnx_exec.</code><code class="sig-name descname">execute_onnx</code><span class="sig-paren">(</span><em class="sig-param">model</em>, <em class="sig-param">input_dict</em>, <em class="sig-param">return_full_exec_context=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.onnx_exec.execute_onnx" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute given ONNX ModelWrapper with given named inputs. -If return_full_exec_context is False, a dict of named outputs is returned -as indicated by the model.graph.output. -If return return_full_exec_context is True, the full set of tensors used by -the execution (including inputs, weights, activations and final outputs) -will be returned as a dict.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.core.onnx_exec.execute_onnx_and_make_model"> -<code class="sig-prename descclassname">finn.core.onnx_exec.</code><code class="sig-name descname">execute_onnx_and_make_model</code><span class="sig-paren">(</span><em class="sig-param">model</em>, <em class="sig-param">input_dict</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.onnx_exec.execute_onnx_and_make_model" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute given ONNX ModelWrapper with given named inputs and return a new -ModelWrapper where an initializer is provided for each tensor as taken from -the execution. This new model is useful for debugging, since it contains -all the intermediate activation values.</p> -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.core.remote_exec.html" class="btn btn-neutral float-right" title="finn.core.remote_exec module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.core.modelwrapper.html" class="btn btn-neutral float-left" title="finn.core.modelwrapper module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.core.remote_exec.html b/docs/finn/_build/html/source_code/finn.core.remote_exec.html deleted file mode 100644 index 771b6d0defb24e94dd6fb366713e8cd3b9c61259..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.core.remote_exec.html +++ /dev/null @@ -1,215 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.core.remote_exec module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.core.rtlsim_exec module" href="finn.core.rtlsim_exec.html" /> - <link rel="prev" title="finn.core.onnx_exec module" href="finn.core.onnx_exec.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.core.html">finn.core package</a> »</li> - - <li>finn.core.remote_exec module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.core.remote_exec.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.core.remote_exec"> -<span id="finn-core-remote-exec-module"></span><h1>finn.core.remote_exec module<a class="headerlink" href="#module-finn.core.remote_exec" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="finn.core.remote_exec.remote_exec"> -<code class="sig-prename descclassname">finn.core.remote_exec.</code><code class="sig-name descname">remote_exec</code><span class="sig-paren">(</span><em class="sig-param">model</em>, <em class="sig-param">execution_context</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.remote_exec.remote_exec" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.core.rtlsim_exec.html" class="btn btn-neutral float-right" title="finn.core.rtlsim_exec module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.core.onnx_exec.html" class="btn btn-neutral float-left" title="finn.core.onnx_exec module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.core.rtlsim_exec.html b/docs/finn/_build/html/source_code/finn.core.rtlsim_exec.html deleted file mode 100644 index 8d6ea24d47f9d2784ee15e09d9b923487d9709f4..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.core.rtlsim_exec.html +++ /dev/null @@ -1,216 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.core.rtlsim_exec module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.custom_op package" href="finn.custom_op.html" /> - <link rel="prev" title="finn.core.remote_exec module" href="finn.core.remote_exec.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.core.html">finn.core package</a> »</li> - - <li>finn.core.rtlsim_exec module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.core.rtlsim_exec.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.core.rtlsim_exec"> -<span id="finn-core-rtlsim-exec-module"></span><h1>finn.core.rtlsim_exec module<a class="headerlink" href="#module-finn.core.rtlsim_exec" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="finn.core.rtlsim_exec.rtlsim_exec"> -<code class="sig-prename descclassname">finn.core.rtlsim_exec.</code><code class="sig-name descname">rtlsim_exec</code><span class="sig-paren">(</span><em class="sig-param">model</em>, <em class="sig-param">execution_context</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.core.rtlsim_exec.rtlsim_exec" title="Permalink to this definition">¶</a></dt> -<dd><p>Use PyVerilator to execute given model with stitched IP.</p> -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.custom_op.html" class="btn btn-neutral float-right" title="finn.custom_op package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.core.remote_exec.html" class="btn btn-neutral float-left" title="finn.core.remote_exec module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html b/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html deleted file mode 100644 index 742ecdeae9b7bcd9da67217d544f755eda425c7c..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html +++ /dev/null @@ -1,334 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.custom_op.fpgadataflow.convolutioninputgenerator module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.custom_op.fpgadataflow.streamingfclayer_batch module" href="finn.custom_op.fpgadataflow.streamingfclayer_batch.html" /> - <link rel="prev" title="finn.custom_op.fpgadataflow package" href="finn.custom_op.fpgadataflow.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.custom_op.html">finn.custom_op package</a> »</li> - - <li><a href="finn.custom_op.fpgadataflow.html">finn.custom_op.fpgadataflow package</a> »</li> - - <li>finn.custom_op.fpgadataflow.convolutioninputgenerator module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.custom_op.fpgadataflow.convolutioninputgenerator"> -<span id="finn-custom-op-fpgadataflow-convolutioninputgenerator-module"></span><h1>finn.custom_op.fpgadataflow.convolutioninputgenerator module<a class="headerlink" href="#module-finn.custom_op.fpgadataflow.convolutioninputgenerator" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator"> -<em class="property">class </em><code class="sig-prename descclassname">finn.custom_op.fpgadataflow.convolutioninputgenerator.</code><code class="sig-name descname">ConvolutionInputGenerator</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp" title="finn.custom_op.fpgadataflow.HLSCustomOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.fpgadataflow.HLSCustomOp</span></code></a></p> -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.blackboxfunction"> -<code class="sig-name descname">blackboxfunction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.blackboxfunction" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.bram_estimation"> -<code class="sig-name descname">bram_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.bram_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.dataoutstrm"> -<code class="sig-name descname">dataoutstrm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.dataoutstrm" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.defines"> -<code class="sig-name descname">defines</code><span class="sig-paren">(</span><em class="sig-param">var</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.defines" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.docompute"> -<code class="sig-name descname">docompute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.docompute" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_input_datatype"> -<code class="sig-name descname">get_input_datatype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_input_datatype" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_number_output_values"> -<code class="sig-name descname">get_number_output_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_number_output_values" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_output_datatype"> -<code class="sig-name descname">get_output_datatype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_output_datatype" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_stream_width"> -<code class="sig-name descname">get_stream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_stream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.global_includes"> -<code class="sig-name descname">global_includes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.global_includes" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.lut_estimation"> -<code class="sig-name descname">lut_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.lut_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.pragmas"> -<code class="sig-name descname">pragmas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.pragmas" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.read_npy_data"> -<code class="sig-name descname">read_npy_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.read_npy_data" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.save_as_npy"> -<code class="sig-name descname">save_as_npy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.save_as_npy" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.strm_decl"> -<code class="sig-name descname">strm_decl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.strm_decl" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.custom_op.fpgadataflow.streamingfclayer_batch.html" class="btn btn-neutral float-right" title="finn.custom_op.fpgadataflow.streamingfclayer_batch module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.custom_op.fpgadataflow.html" class="btn btn-neutral float-left" title="finn.custom_op.fpgadataflow package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file 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 f77578f0e5e399cb09ec4bd24169f46e9cd3a893..f263769e12895f4344ab63e5a5b76d4e508f4a77 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 @@ -34,7 +34,9 @@ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <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="search" title="Search" href="../search.html" /> + <link rel="next" title="finn.transformation package" href="finn.transformation.html" /> + <link rel="prev" title="finn.custom_op package" href="finn.custom_op.html" /> </head> <body class="wy-body-for-nav"> @@ -127,6 +129,12 @@ <li><a href="../index.html">Docs</a> »</li> + <li><a href="../source_code.html">Source Code</a> »</li> + + <li><a href="finn.html">finn package</a> »</li> + + <li><a href="finn.custom_op.html">finn.custom_op package</a> »</li> + <li>finn.custom_op.fpgadataflow package</li> @@ -877,6 +885,15 @@ attribute is not set</p> </div> <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="finn.transformation.html" class="btn btn-neutral float-right" title="finn.transformation package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="finn.custom_op.html" class="btn btn-neutral float-left" title="finn.custom_op package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + <hr/> diff --git a/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html b/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html deleted file mode 100644 index 87ed52c67e52e1c0471ef62b3493c29090f2b939..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html +++ /dev/null @@ -1,408 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.custom_op.fpgadataflow.streamingfclayer_batch module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.custom_op.fpgadataflow.streamingmaxpool_batch module" href="finn.custom_op.fpgadataflow.streamingmaxpool_batch.html" /> - <link rel="prev" title="finn.custom_op.fpgadataflow.convolutioninputgenerator module" href="finn.custom_op.fpgadataflow.convolutioninputgenerator.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.custom_op.html">finn.custom_op package</a> »</li> - - <li><a href="finn.custom_op.fpgadataflow.html">finn.custom_op.fpgadataflow package</a> »</li> - - <li>finn.custom_op.fpgadataflow.streamingfclayer_batch module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.custom_op.fpgadataflow.streamingfclayer_batch"> -<span id="finn-custom-op-fpgadataflow-streamingfclayer-batch-module"></span><h1>finn.custom_op.fpgadataflow.streamingfclayer_batch module<a class="headerlink" href="#module-finn.custom_op.fpgadataflow.streamingfclayer_batch" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch"> -<em class="property">class </em><code class="sig-prename descclassname">finn.custom_op.fpgadataflow.streamingfclayer_batch.</code><code class="sig-name descname">StreamingFCLayer_Batch</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp" title="finn.custom_op.fpgadataflow.HLSCustomOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.fpgadataflow.HLSCustomOp</span></code></a></p> -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.blackboxfunction"> -<code class="sig-name descname">blackboxfunction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.blackboxfunction" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.bram_estimation"> -<code class="sig-name descname">bram_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.bram_estimation" title="Permalink to this definition">¶</a></dt> -<dd><p>the calculations are based on: -- FINN-R: An End-to-End Deep-Learning Framework for Fast -Exploration of Quantized Neural Networks -- M. Blott, T. B. Preusser, N. J. Fraser, G. Gambardella, K. O’Brien, -Y. Umuroglu, M. Leeser and K. Vissers -- 12. Sep 2018</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.calc_tmem"> -<code class="sig-name descname">calc_tmem</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.calc_tmem" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.calc_wmem"> -<code class="sig-name descname">calc_wmem</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.calc_wmem" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.dataoutstrm"> -<code class="sig-name descname">dataoutstrm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.dataoutstrm" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.defines"> -<code class="sig-name descname">defines</code><span class="sig-paren">(</span><em class="sig-param">var</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.defines" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.docompute"> -<code class="sig-name descname">docompute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.docompute" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.generate_params"> -<code class="sig-name descname">generate_params</code><span class="sig-paren">(</span><em class="sig-param">model</em>, <em class="sig-param">path</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.generate_params" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_folded_input_shape"> -<code class="sig-name descname">get_folded_input_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_folded_input_shape" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_folded_output_shape"> -<code class="sig-name descname">get_folded_output_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_folded_output_shape" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_hls_compatible_threshold_tensor"> -<code class="sig-name descname">get_hls_compatible_threshold_tensor</code><span class="sig-paren">(</span><em class="sig-param">orig_thres_matrix</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_hls_compatible_threshold_tensor" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert the original numpy weight matrix orig_weight_matrix into -a form suitable for passing to the hlslib call: -* ensure MH % PE == 0 -* for bipolar weights&inputs, ensure thresholds are positive -* interleave rows between PEs -* reshape into (PE, TMEM, n_thres_steps) and return</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_hls_compatible_weight_tensor"> -<code class="sig-name descname">get_hls_compatible_weight_tensor</code><span class="sig-paren">(</span><em class="sig-param">orig_weight_matrix</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_hls_compatible_weight_tensor" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert the original numpy weight matrix orig_weight_matrix into -a form suitable for passing to the hlslib call: -* ensure MH % PE == 0 and MW % SIMD == 0 -* for bipolar {-1,+1} weights, convert to binary {0, 1} -* interleave rows between PEs -* reshape into (1, PE, WMEM, SIMD) and return</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_input_datatype"> -<code class="sig-name descname">get_input_datatype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_input_datatype" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_instream_width"> -<code class="sig-name descname">get_instream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_instream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_number_output_values"> -<code class="sig-name descname">get_number_output_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_number_output_values" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_output_datatype"> -<code class="sig-name descname">get_output_datatype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_output_datatype" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_outstream_width"> -<code class="sig-name descname">get_outstream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_outstream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_template_param_values"> -<code class="sig-name descname">get_template_param_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_template_param_values" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_weight_datatype"> -<code class="sig-name descname">get_weight_datatype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_weight_datatype" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.global_includes"> -<code class="sig-name descname">global_includes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.global_includes" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.lut_estimation"> -<code class="sig-name descname">lut_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.lut_estimation" title="Permalink to this definition">¶</a></dt> -<dd><p>the calculations are based on: -- FINN-R: An End-to-End Deep-Learning Framework for Fast -Exploration of Quantized Neural Networks -- M. Blott, T. B. Preusser, N. J. Fraser, G. Gambardella, K. O’Brien, -Y. Umuroglu, M. Leeser and K. Vissers -- 12. Sep 2018</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.pragmas"> -<code class="sig-name descname">pragmas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.pragmas" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.read_npy_data"> -<code class="sig-name descname">read_npy_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.read_npy_data" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.save_as_npy"> -<code class="sig-name descname">save_as_npy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.save_as_npy" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.strm_decl"> -<code class="sig-name descname">strm_decl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.strm_decl" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.custom_op.fpgadataflow.streamingmaxpool_batch.html" class="btn btn-neutral float-right" title="finn.custom_op.fpgadataflow.streamingmaxpool_batch module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.custom_op.fpgadataflow.convolutioninputgenerator.html" class="btn btn-neutral float-left" title="finn.custom_op.fpgadataflow.convolutioninputgenerator module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html b/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html deleted file mode 100644 index 1f0df0549bf9e5d3889633fc17a0220c60a8d29c..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html +++ /dev/null @@ -1,312 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.custom_op.fpgadataflow.streamingmaxpool_batch module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.custom_op.fpgadataflow.templates module" href="finn.custom_op.fpgadataflow.templates.html" /> - <link rel="prev" title="finn.custom_op.fpgadataflow.streamingfclayer_batch module" href="finn.custom_op.fpgadataflow.streamingfclayer_batch.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.custom_op.html">finn.custom_op package</a> »</li> - - <li><a href="finn.custom_op.fpgadataflow.html">finn.custom_op.fpgadataflow package</a> »</li> - - <li>finn.custom_op.fpgadataflow.streamingmaxpool_batch module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.custom_op.fpgadataflow.streamingmaxpool_batch"> -<span id="finn-custom-op-fpgadataflow-streamingmaxpool-batch-module"></span><h1>finn.custom_op.fpgadataflow.streamingmaxpool_batch module<a class="headerlink" href="#module-finn.custom_op.fpgadataflow.streamingmaxpool_batch" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch"> -<em class="property">class </em><code class="sig-prename descclassname">finn.custom_op.fpgadataflow.streamingmaxpool_batch.</code><code class="sig-name descname">StreamingMaxPool_Batch</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp" title="finn.custom_op.fpgadataflow.HLSCustomOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.fpgadataflow.HLSCustomOp</span></code></a></p> -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.blackboxfunction"> -<code class="sig-name descname">blackboxfunction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.blackboxfunction" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.bram_estimation"> -<code class="sig-name descname">bram_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.bram_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.dataoutstrm"> -<code class="sig-name descname">dataoutstrm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.dataoutstrm" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.defines"> -<code class="sig-name descname">defines</code><span class="sig-paren">(</span><em class="sig-param">var</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.defines" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.docompute"> -<code class="sig-name descname">docompute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.docompute" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.get_number_output_values"> -<code class="sig-name descname">get_number_output_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.get_number_output_values" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.global_includes"> -<code class="sig-name descname">global_includes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.global_includes" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.lut_estimation"> -<code class="sig-name descname">lut_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.lut_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.pragmas"> -<code class="sig-name descname">pragmas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.pragmas" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.read_npy_data"> -<code class="sig-name descname">read_npy_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.read_npy_data" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.save_as_npy"> -<code class="sig-name descname">save_as_npy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.save_as_npy" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.strm_decl"> -<code class="sig-name descname">strm_decl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.strm_decl" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.custom_op.fpgadataflow.templates.html" class="btn btn-neutral float-right" title="finn.custom_op.fpgadataflow.templates module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.custom_op.fpgadataflow.streamingfclayer_batch.html" class="btn btn-neutral float-left" title="finn.custom_op.fpgadataflow.streamingfclayer_batch module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.templates.html b/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.templates.html deleted file mode 100644 index 6a18a9d3b469827a2a7e4448b2f21caa22d5611c..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.templates.html +++ /dev/null @@ -1,212 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.custom_op.fpgadataflow.templates module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.custom_op.fpgadataflow.tlastmarker module" href="finn.custom_op.fpgadataflow.tlastmarker.html" /> - <link rel="prev" title="finn.custom_op.fpgadataflow.streamingmaxpool_batch module" href="finn.custom_op.fpgadataflow.streamingmaxpool_batch.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.custom_op.html">finn.custom_op package</a> »</li> - - <li><a href="finn.custom_op.fpgadataflow.html">finn.custom_op.fpgadataflow package</a> »</li> - - <li>finn.custom_op.fpgadataflow.templates module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.custom_op.fpgadataflow.templates.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.custom_op.fpgadataflow.templates"> -<span id="finn-custom-op-fpgadataflow-templates-module"></span><h1>finn.custom_op.fpgadataflow.templates module<a class="headerlink" href="#module-finn.custom_op.fpgadataflow.templates" title="Permalink to this headline">¶</a></h1> -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.custom_op.fpgadataflow.tlastmarker.html" class="btn btn-neutral float-right" title="finn.custom_op.fpgadataflow.tlastmarker module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.custom_op.fpgadataflow.streamingmaxpool_batch.html" class="btn btn-neutral float-left" title="finn.custom_op.fpgadataflow.streamingmaxpool_batch module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.tlastmarker.html b/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.tlastmarker.html deleted file mode 100644 index bbee90cff9a101095a1c03c3173291c3524218a0..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.tlastmarker.html +++ /dev/null @@ -1,329 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.custom_op.fpgadataflow.tlastmarker module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.custom_op.multithreshold module" href="finn.custom_op.multithreshold.html" /> - <link rel="prev" title="finn.custom_op.fpgadataflow.templates module" href="finn.custom_op.fpgadataflow.templates.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.custom_op.html">finn.custom_op package</a> »</li> - - <li><a href="finn.custom_op.fpgadataflow.html">finn.custom_op.fpgadataflow package</a> »</li> - - <li>finn.custom_op.fpgadataflow.tlastmarker module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.custom_op.fpgadataflow.tlastmarker.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.custom_op.fpgadataflow.tlastmarker"> -<span id="finn-custom-op-fpgadataflow-tlastmarker-module"></span><h1>finn.custom_op.fpgadataflow.tlastmarker module<a class="headerlink" href="#module-finn.custom_op.fpgadataflow.tlastmarker" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker"> -<em class="property">class </em><code class="sig-prename descclassname">finn.custom_op.fpgadataflow.tlastmarker.</code><code class="sig-name descname">TLastMarker</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp" title="finn.custom_op.fpgadataflow.HLSCustomOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.fpgadataflow.HLSCustomOp</span></code></a></p> -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.blackboxfunction"> -<code class="sig-name descname">blackboxfunction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.blackboxfunction" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.dataoutstrm"> -<code class="sig-name descname">dataoutstrm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.dataoutstrm" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.defines"> -<code class="sig-name descname">defines</code><span class="sig-paren">(</span><em class="sig-param">var</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.defines" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.docompute"> -<code class="sig-name descname">docompute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.docompute" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_folded_input_shape"> -<code class="sig-name descname">get_folded_input_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_folded_input_shape" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_folded_output_shape"> -<code class="sig-name descname">get_folded_output_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_folded_output_shape" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_instream_width"> -<code class="sig-name descname">get_instream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_instream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_number_output_values"> -<code class="sig-name descname">get_number_output_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_number_output_values" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_outstream_width"> -<code class="sig-name descname">get_outstream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_outstream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.global_includes"> -<code class="sig-name descname">global_includes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.global_includes" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.pragmas"> -<code class="sig-name descname">pragmas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.pragmas" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.read_npy_data"> -<code class="sig-name descname">read_npy_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.read_npy_data" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.save_as_npy"> -<code class="sig-name descname">save_as_npy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.save_as_npy" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.strm_decl"> -<code class="sig-name descname">strm_decl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.strm_decl" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.custom_op.multithreshold.html" class="btn btn-neutral float-right" title="finn.custom_op.multithreshold module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.custom_op.fpgadataflow.templates.html" class="btn btn-neutral float-left" title="finn.custom_op.fpgadataflow.templates module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file 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 e97dd9bcfa8c797fa817ce7155ce405ba3199bba..59373404b90354966140f281ac854568d71cfd8c 100644 --- a/docs/finn/_build/html/source_code/finn.custom_op.html +++ b/docs/finn/_build/html/source_code/finn.custom_op.html @@ -34,7 +34,9 @@ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <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="search" title="Search" href="../search.html" /> + <link rel="next" title="finn.custom_op.fpgadataflow package" href="finn.custom_op.fpgadataflow.html" /> + <link rel="prev" title="finn.core package" href="finn.core.html" /> </head> <body class="wy-body-for-nav"> @@ -127,6 +129,10 @@ <li><a href="../index.html">Docs</a> »</li> + <li><a href="../source_code.html">Source Code</a> »</li> + + <li><a href="finn.html">finn package</a> »</li> + <li>finn.custom_op package</li> @@ -415,6 +421,15 @@ the number of inputs is equal to the expected number</p> </div> <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="finn.custom_op.fpgadataflow.html" class="btn btn-neutral float-right" title="finn.custom_op.fpgadataflow package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="finn.core.html" class="btn btn-neutral float-left" title="finn.core package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + <hr/> diff --git a/docs/finn/_build/html/source_code/finn.custom_op.multithreshold.html b/docs/finn/_build/html/source_code/finn.custom_op.multithreshold.html deleted file mode 100644 index 0ba6f08e39c7b759fd6351b3e5765a326a1e98eb..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.custom_op.multithreshold.html +++ /dev/null @@ -1,267 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.custom_op.multithreshold module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.custom_op.registry module" href="finn.custom_op.registry.html" /> - <link rel="prev" title="finn.custom_op.fpgadataflow.tlastmarker module" href="finn.custom_op.fpgadataflow.tlastmarker.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.custom_op.html">finn.custom_op package</a> »</li> - - <li>finn.custom_op.multithreshold module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.custom_op.multithreshold.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.custom_op.multithreshold"> -<span id="finn-custom-op-multithreshold-module"></span><h1>finn.custom_op.multithreshold module<a class="headerlink" href="#module-finn.custom_op.multithreshold" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.custom_op.multithreshold.MultiThreshold"> -<em class="property">class </em><code class="sig-prename descclassname">finn.custom_op.multithreshold.</code><code class="sig-name descname">MultiThreshold</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.multithreshold.MultiThreshold" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.custom_op.html#finn.custom_op.CustomOp" title="finn.custom_op.CustomOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.CustomOp</span></code></a></p> -<dl class="method"> -<dt id="finn.custom_op.multithreshold.MultiThreshold.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.multithreshold.MultiThreshold.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.multithreshold.MultiThreshold.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.multithreshold.MultiThreshold.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.multithreshold.MultiThreshold.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.multithreshold.MultiThreshold.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.multithreshold.MultiThreshold.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.multithreshold.MultiThreshold.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.multithreshold.MultiThreshold.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.multithreshold.MultiThreshold.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -<dl class="function"> -<dt id="finn.custom_op.multithreshold.compare"> -<code class="sig-prename descclassname">finn.custom_op.multithreshold.</code><code class="sig-name descname">compare</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.multithreshold.compare" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="function"> -<dt id="finn.custom_op.multithreshold.multithreshold"> -<code class="sig-prename descclassname">finn.custom_op.multithreshold.</code><code class="sig-name descname">multithreshold</code><span class="sig-paren">(</span><em class="sig-param">v</em>, <em class="sig-param">thresholds</em>, <em class="sig-param">out_scale=None</em>, <em class="sig-param">out_bias=None</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.multithreshold.multithreshold" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.custom_op.registry.html" class="btn btn-neutral float-right" title="finn.custom_op.registry module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.custom_op.fpgadataflow.tlastmarker.html" class="btn btn-neutral float-left" title="finn.custom_op.fpgadataflow.tlastmarker module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.custom_op.registry.html b/docs/finn/_build/html/source_code/finn.custom_op.registry.html deleted file mode 100644 index 257e4a9d8d4fe8a5e104abbbb2e24570ad465012..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.custom_op.registry.html +++ /dev/null @@ -1,216 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.custom_op.registry module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.custom_op.streamingdataflowpartition module" href="finn.custom_op.streamingdataflowpartition.html" /> - <link rel="prev" title="finn.custom_op.multithreshold module" href="finn.custom_op.multithreshold.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.custom_op.html">finn.custom_op package</a> »</li> - - <li>finn.custom_op.registry module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.custom_op.registry.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.custom_op.registry"> -<span id="finn-custom-op-registry-module"></span><h1>finn.custom_op.registry module<a class="headerlink" href="#module-finn.custom_op.registry" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="finn.custom_op.registry.getCustomOp"> -<code class="sig-prename descclassname">finn.custom_op.registry.</code><code class="sig-name descname">getCustomOp</code><span class="sig-paren">(</span><em class="sig-param">node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.registry.getCustomOp" title="Permalink to this definition">¶</a></dt> -<dd><p>Return a FINN CustomOp instance for the given ONNX node, if it exists.</p> -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.custom_op.streamingdataflowpartition.html" class="btn btn-neutral float-right" title="finn.custom_op.streamingdataflowpartition module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.custom_op.multithreshold.html" class="btn btn-neutral float-left" title="finn.custom_op.multithreshold module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.custom_op.streamingdataflowpartition.html b/docs/finn/_build/html/source_code/finn.custom_op.streamingdataflowpartition.html deleted file mode 100644 index 82daf99f8093b47c33fea50d3ba844d530077dd5..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.custom_op.streamingdataflowpartition.html +++ /dev/null @@ -1,257 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.custom_op.streamingdataflowpartition module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.custom_op.xnorpopcount module" href="finn.custom_op.xnorpopcount.html" /> - <link rel="prev" title="finn.custom_op.registry module" href="finn.custom_op.registry.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.custom_op.html">finn.custom_op package</a> »</li> - - <li>finn.custom_op.streamingdataflowpartition module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.custom_op.streamingdataflowpartition.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.custom_op.streamingdataflowpartition"> -<span id="finn-custom-op-streamingdataflowpartition-module"></span><h1>finn.custom_op.streamingdataflowpartition module<a class="headerlink" href="#module-finn.custom_op.streamingdataflowpartition" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition"> -<em class="property">class </em><code class="sig-prename descclassname">finn.custom_op.streamingdataflowpartition.</code><code class="sig-name descname">StreamingDataflowPartition</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.custom_op.html#finn.custom_op.CustomOp" title="finn.custom_op.CustomOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.CustomOp</span></code></a></p> -<dl class="method"> -<dt id="finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.custom_op.xnorpopcount.html" class="btn btn-neutral float-right" title="finn.custom_op.xnorpopcount module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.custom_op.registry.html" class="btn btn-neutral float-left" title="finn.custom_op.registry module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.custom_op.xnorpopcount.html b/docs/finn/_build/html/source_code/finn.custom_op.xnorpopcount.html deleted file mode 100644 index e4e92ce4b3a82ec139d5c47427b3445a01ad84b8..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.custom_op.xnorpopcount.html +++ /dev/null @@ -1,262 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.custom_op.xnorpopcount module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation package" href="finn.transformation.html" /> - <link rel="prev" title="finn.custom_op.streamingdataflowpartition module" href="finn.custom_op.streamingdataflowpartition.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.custom_op.html">finn.custom_op package</a> »</li> - - <li>finn.custom_op.xnorpopcount module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.custom_op.xnorpopcount.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.custom_op.xnorpopcount"> -<span id="finn-custom-op-xnorpopcount-module"></span><h1>finn.custom_op.xnorpopcount module<a class="headerlink" href="#module-finn.custom_op.xnorpopcount" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.custom_op.xnorpopcount.XnorPopcountMatMul"> -<em class="property">class </em><code class="sig-prename descclassname">finn.custom_op.xnorpopcount.</code><code class="sig-name descname">XnorPopcountMatMul</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.xnorpopcount.XnorPopcountMatMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.custom_op.html#finn.custom_op.CustomOp" title="finn.custom_op.CustomOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.CustomOp</span></code></a></p> -<dl class="method"> -<dt id="finn.custom_op.xnorpopcount.XnorPopcountMatMul.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.xnorpopcount.XnorPopcountMatMul.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.xnorpopcount.XnorPopcountMatMul.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.xnorpopcount.XnorPopcountMatMul.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.xnorpopcount.XnorPopcountMatMul.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.xnorpopcount.XnorPopcountMatMul.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.xnorpopcount.XnorPopcountMatMul.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.xnorpopcount.XnorPopcountMatMul.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="finn.custom_op.xnorpopcount.XnorPopcountMatMul.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.xnorpopcount.XnorPopcountMatMul.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -<dl class="function"> -<dt id="finn.custom_op.xnorpopcount.xnorpopcountmatmul"> -<code class="sig-prename descclassname">finn.custom_op.xnorpopcount.</code><code class="sig-name descname">xnorpopcountmatmul</code><span class="sig-paren">(</span><em class="sig-param">inp0</em>, <em class="sig-param">inp1</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.custom_op.xnorpopcount.xnorpopcountmatmul" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.html" class="btn btn-neutral float-right" title="finn.transformation package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.custom_op.streamingdataflowpartition.html" class="btn btn-neutral float-left" title="finn.custom_op.streamingdataflowpartition module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.html b/docs/finn/_build/html/source_code/finn.html index 77d2c467f5c478c3e1fbe533e298ecd413503138..51b1f6b6f5fdca01ebc7036395802cd3f794dd77 100644 --- a/docs/finn/_build/html/source_code/finn.html +++ b/docs/finn/_build/html/source_code/finn.html @@ -34,7 +34,9 @@ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <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="search" title="Search" href="../search.html" /> + <link rel="next" title="finn.analysis package" href="finn.analysis.html" /> + <link rel="prev" title="Source Code" href="../source_code.html" /> </head> <body class="wy-body-for-nav"> @@ -127,6 +129,8 @@ <li><a href="../index.html">Docs</a> »</li> + <li><a href="../source_code.html">Source Code</a> »</li> + <li>finn package</li> @@ -276,6 +280,15 @@ </div> <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <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="../source_code.html" class="btn btn-neutral float-left" title="Source Code" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + <hr/> diff --git a/docs/finn/_build/html/source_code/finn.transformation.batchnorm_to_affine.html b/docs/finn/_build/html/source_code/finn.transformation.batchnorm_to_affine.html deleted file mode 100644 index 956339611f1b5aaa96d6b821c0d0b810a7c1b618..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.batchnorm_to_affine.html +++ /dev/null @@ -1,222 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.batchnorm_to_affine module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.bipolar_to_xnor module" href="finn.transformation.bipolar_to_xnor.html" /> - <link rel="prev" title="finn.transformation.streamline.sign_to_thres module" href="finn.transformation.streamline.sign_to_thres.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li>finn.transformation.batchnorm_to_affine module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.batchnorm_to_affine.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.batchnorm_to_affine"> -<span id="finn-transformation-batchnorm-to-affine-module"></span><h1>finn.transformation.batchnorm_to_affine module<a class="headerlink" href="#module-finn.transformation.batchnorm_to_affine" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.batchnorm_to_affine.BatchNormToAffine"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.batchnorm_to_affine.</code><code class="sig-name descname">BatchNormToAffine</code><a class="headerlink" href="#finn.transformation.batchnorm_to_affine.BatchNormToAffine" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Replaces any test-time BatchNorm layers with Mul-Add layers.</p> -<dl class="method"> -<dt id="finn.transformation.batchnorm_to_affine.BatchNormToAffine.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.batchnorm_to_affine.BatchNormToAffine.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.bipolar_to_xnor.html" class="btn btn-neutral float-right" title="finn.transformation.bipolar_to_xnor module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.streamline.sign_to_thres.html" class="btn btn-neutral float-left" title="finn.transformation.streamline.sign_to_thres module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.bipolar_to_xnor.html b/docs/finn/_build/html/source_code/finn.transformation.bipolar_to_xnor.html deleted file mode 100644 index 60ba89ae7dd7c482409140873b1a76b2635e497f..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.bipolar_to_xnor.html +++ /dev/null @@ -1,223 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.bipolar_to_xnor module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.fold_constants module" href="finn.transformation.fold_constants.html" /> - <link rel="prev" title="finn.transformation.batchnorm_to_affine module" href="finn.transformation.batchnorm_to_affine.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li>finn.transformation.bipolar_to_xnor module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.bipolar_to_xnor.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.bipolar_to_xnor"> -<span id="finn-transformation-bipolar-to-xnor-module"></span><h1>finn.transformation.bipolar_to_xnor module<a class="headerlink" href="#module-finn.transformation.bipolar_to_xnor" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.bipolar_to_xnor.</code><code class="sig-name descname">ConvertBipolarMatMulToXnorPopcount</code><a class="headerlink" href="#finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Convert MatMul nodes with all-bipolar inputs to XnorPopcountMatMul -and associated result correction.</p> -<dl class="method"> -<dt id="finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.fold_constants.html" class="btn btn-neutral float-right" title="finn.transformation.fold_constants module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.batchnorm_to_affine.html" class="btn btn-neutral float-left" title="finn.transformation.batchnorm_to_affine module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.fold_constants.html b/docs/finn/_build/html/source_code/finn.transformation.fold_constants.html deleted file mode 100644 index d02be36478b150f89b43e0df4116a0dbed79e3fd..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.fold_constants.html +++ /dev/null @@ -1,223 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.fold_constants module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.general module" href="finn.transformation.general.html" /> - <link rel="prev" title="finn.transformation.bipolar_to_xnor module" href="finn.transformation.bipolar_to_xnor.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li>finn.transformation.fold_constants module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.fold_constants.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.fold_constants"> -<span id="finn-transformation-fold-constants-module"></span><h1>finn.transformation.fold_constants module<a class="headerlink" href="#module-finn.transformation.fold_constants" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.fold_constants.FoldConstants"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fold_constants.</code><code class="sig-name descname">FoldConstants</code><a class="headerlink" href="#finn.transformation.fold_constants.FoldConstants" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Replace the output of a node with const-only inputs with a precomputed -result.</p> -<dl class="method"> -<dt id="finn.transformation.fold_constants.FoldConstants.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fold_constants.FoldConstants.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.general.html" class="btn btn-neutral float-right" title="finn.transformation.general module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.bipolar_to_xnor.html" class="btn btn-neutral float-left" title="finn.transformation.bipolar_to_xnor module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.cleanup.html b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.cleanup.html deleted file mode 100644 index ce38981d4321aeb7f5c4a3dbc3fb9b6706d9ed48..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.cleanup.html +++ /dev/null @@ -1,224 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.fpgadataflow.cleanup module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.fpgadataflow.codegen_ipgen module" href="finn.transformation.fpgadataflow.codegen_ipgen.html" /> - <link rel="prev" title="finn.transformation.fpgadataflow package" href="finn.transformation.fpgadataflow.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a> »</li> - - <li>finn.transformation.fpgadataflow.cleanup module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.fpgadataflow.cleanup.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.fpgadataflow.cleanup"> -<span id="finn-transformation-fpgadataflow-cleanup-module"></span><h1>finn.transformation.fpgadataflow.cleanup module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.cleanup" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.cleanup.CleanUp"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.cleanup.</code><code class="sig-name descname">CleanUp</code><a class="headerlink" href="#finn.transformation.fpgadataflow.cleanup.CleanUp" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Remove any generated files for fpgadataflow nodes.</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.cleanup.CleanUp.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.cleanup.CleanUp.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.fpgadataflow.codegen_ipgen.html" class="btn btn-neutral float-right" title="finn.transformation.fpgadataflow.codegen_ipgen module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.fpgadataflow.html" class="btn btn-neutral float-left" title="finn.transformation.fpgadataflow package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.codegen_ipgen.html b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.codegen_ipgen.html deleted file mode 100644 index 15ee3487e3b1f72659537154e75ef3f1bcf8a667..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.codegen_ipgen.html +++ /dev/null @@ -1,224 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.fpgadataflow.codegen_ipgen module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.fpgadataflow.codegen_ipstitch module" href="finn.transformation.fpgadataflow.codegen_ipstitch.html" /> - <link rel="prev" title="finn.transformation.fpgadataflow.cleanup module" href="finn.transformation.fpgadataflow.cleanup.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a> »</li> - - <li>finn.transformation.fpgadataflow.codegen_ipgen module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.fpgadataflow.codegen_ipgen.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.fpgadataflow.codegen_ipgen"> -<span id="finn-transformation-fpgadataflow-codegen-ipgen-module"></span><h1>finn.transformation.fpgadataflow.codegen_ipgen module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.codegen_ipgen" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.codegen_ipgen.</code><code class="sig-name descname">CodeGen_ipgen</code><span class="sig-paren">(</span><em class="sig-param">fpgapart</em>, <em class="sig-param">clk</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Code generation for all nodes in model</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.fpgadataflow.codegen_ipstitch.html" class="btn btn-neutral float-right" title="finn.transformation.fpgadataflow.codegen_ipstitch module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.fpgadataflow.cleanup.html" class="btn btn-neutral float-left" title="finn.transformation.fpgadataflow.cleanup module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.codegen_ipstitch.html b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.codegen_ipstitch.html deleted file mode 100644 index 53fcfe1174605a92f1ac60e690ccf97970d54920..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.codegen_ipstitch.html +++ /dev/null @@ -1,232 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.fpgadataflow.codegen_ipstitch module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.fpgadataflow.codegen_npysim module" href="finn.transformation.fpgadataflow.codegen_npysim.html" /> - <link rel="prev" title="finn.transformation.fpgadataflow.codegen_ipgen module" href="finn.transformation.fpgadataflow.codegen_ipgen.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a> »</li> - - <li>finn.transformation.fpgadataflow.codegen_ipstitch module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.fpgadataflow.codegen_ipstitch.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.fpgadataflow.codegen_ipstitch"> -<span id="finn-transformation-fpgadataflow-codegen-ipstitch-module"></span><h1>finn.transformation.fpgadataflow.codegen_ipstitch module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.codegen_ipstitch" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.codegen_ipstitch.</code><code class="sig-name descname">CodeGen_ipstitch</code><span class="sig-paren">(</span><em class="sig-param">fpgapart</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Create a Vivado IP Block Design project from all the generated IPs of a -graph. All nodes in the graph must have the fpgadataflow backend attribute, -and the CodeGen_ipgen transformation must have been previously run on -the graph. The resulting block design is also packaged as IP.</p> -<p>Outcome if successful: sets the vivado_stitch_proj attribute in the ONNX -ModelProto’s metadata_props field, with the created project dir as the -value. A make_project.tcl script is also placed under the same folder, -which is called to instantiate the per-layer IPs and stitch them together. -The packaged block design IP can be found under the ip subdirectory.</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.fpgadataflow.codegen_npysim.html" class="btn btn-neutral float-right" title="finn.transformation.fpgadataflow.codegen_npysim module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.fpgadataflow.codegen_ipgen.html" class="btn btn-neutral float-left" title="finn.transformation.fpgadataflow.codegen_ipgen module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.codegen_npysim.html b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.codegen_npysim.html deleted file mode 100644 index 36e1774c56dcef424bcd6bf227c7a8ac4ed84e31..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.codegen_npysim.html +++ /dev/null @@ -1,224 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.fpgadataflow.codegen_npysim module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.fpgadataflow.compile module" href="finn.transformation.fpgadataflow.compile.html" /> - <link rel="prev" title="finn.transformation.fpgadataflow.codegen_ipstitch module" href="finn.transformation.fpgadataflow.codegen_ipstitch.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a> »</li> - - <li>finn.transformation.fpgadataflow.codegen_npysim module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.fpgadataflow.codegen_npysim.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.fpgadataflow.codegen_npysim"> -<span id="finn-transformation-fpgadataflow-codegen-npysim-module"></span><h1>finn.transformation.fpgadataflow.codegen_npysim module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.codegen_npysim" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.codegen_npysim.</code><code class="sig-name descname">CodeGen_npysim</code><a class="headerlink" href="#finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Code generation for all nodes in model</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.fpgadataflow.compile.html" class="btn btn-neutral float-right" title="finn.transformation.fpgadataflow.compile module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.fpgadataflow.codegen_ipstitch.html" class="btn btn-neutral float-left" title="finn.transformation.fpgadataflow.codegen_ipstitch module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.compile.html b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.compile.html deleted file mode 100644 index 3ee88f9b1ea74f2422cd73c6db9e579528ca4ea2..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.compile.html +++ /dev/null @@ -1,224 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.fpgadataflow.compile module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.fpgadataflow.convert_to_hls_layers module" href="finn.transformation.fpgadataflow.convert_to_hls_layers.html" /> - <link rel="prev" title="finn.transformation.fpgadataflow.codegen_npysim module" href="finn.transformation.fpgadataflow.codegen_npysim.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a> »</li> - - <li>finn.transformation.fpgadataflow.compile module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.fpgadataflow.compile.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.fpgadataflow.compile"> -<span id="finn-transformation-fpgadataflow-compile-module"></span><h1>finn.transformation.fpgadataflow.compile module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.compile" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.compile.Compile"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.compile.</code><code class="sig-name descname">Compile</code><a class="headerlink" href="#finn.transformation.fpgadataflow.compile.Compile" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Compile for all nodes in model</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.compile.Compile.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.compile.Compile.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.fpgadataflow.convert_to_hls_layers.html" class="btn btn-neutral float-right" title="finn.transformation.fpgadataflow.convert_to_hls_layers module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.fpgadataflow.codegen_npysim.html" class="btn btn-neutral float-left" title="finn.transformation.fpgadataflow.codegen_npysim module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.html b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.html deleted file mode 100644 index 31b287d2b1fa982a93bac7935264290872c2c3d8..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.html +++ /dev/null @@ -1,226 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.fpgadataflow.convert_to_hls_layers module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.fpgadataflow.create_dataflow_partition module" href="finn.transformation.fpgadataflow.create_dataflow_partition.html" /> - <link rel="prev" title="finn.transformation.fpgadataflow.compile module" href="finn.transformation.fpgadataflow.compile.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a> »</li> - - <li>finn.transformation.fpgadataflow.convert_to_hls_layers module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.fpgadataflow.convert_to_hls_layers"> -<span id="finn-transformation-fpgadataflow-convert-to-hls-layers-module"></span><h1>finn.transformation.fpgadataflow.convert_to_hls_layers module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.convert_to_hls_layers" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.convert_to_hls_layers.</code><code class="sig-name descname">InferBinaryStreamingFCLayer</code><a class="headerlink" href="#finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Convert pairs of binary XnorPopcountMatMul layers to -StreamingFCLayer_Batch layers. Any immediately following MultiThreshold -layers will also be absorbed into the MVTU.</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.fpgadataflow.create_dataflow_partition.html" class="btn btn-neutral float-right" title="finn.transformation.fpgadataflow.create_dataflow_partition module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.fpgadataflow.compile.html" class="btn btn-neutral float-left" title="finn.transformation.fpgadataflow.compile module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.create_dataflow_partition.html b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.create_dataflow_partition.html deleted file mode 100644 index e47ba3493e8538776cb3582a9f08a44102aeff7d..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.create_dataflow_partition.html +++ /dev/null @@ -1,228 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.fpgadataflow.create_dataflow_partition module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.fpgadataflow.hlssynth_ipgen module" href="finn.transformation.fpgadataflow.hlssynth_ipgen.html" /> - <link rel="prev" title="finn.transformation.fpgadataflow.convert_to_hls_layers module" href="finn.transformation.fpgadataflow.convert_to_hls_layers.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a> »</li> - - <li>finn.transformation.fpgadataflow.create_dataflow_partition module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.fpgadataflow.create_dataflow_partition.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.fpgadataflow.create_dataflow_partition"> -<span id="finn-transformation-fpgadataflow-create-dataflow-partition-module"></span><h1>finn.transformation.fpgadataflow.create_dataflow_partition module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.create_dataflow_partition" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.create_dataflow_partition.</code><code class="sig-name descname">CreateDataflowPartition</code><a class="headerlink" href="#finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Split a graph into two graphs; one which contains non-FINN-dataflow nodes -and a StreamingDataflowPartition node, and another which only contains -FINN dataflow nodes. The StreamingDataflowPartition has a model attribute -that indicates the filename for the second graph that only contains -dataflow nodes. No action is taken if there are no dataflow nodes.</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.fpgadataflow.hlssynth_ipgen.html" class="btn btn-neutral float-right" title="finn.transformation.fpgadataflow.hlssynth_ipgen module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.fpgadataflow.convert_to_hls_layers.html" class="btn btn-neutral float-left" title="finn.transformation.fpgadataflow.convert_to_hls_layers module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.html b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.html deleted file mode 100644 index 1d2a3d9ec69dd56fb81bb76075fad1237d1fc472..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.html +++ /dev/null @@ -1,224 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.fpgadataflow.hlssynth_ipgen module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.fpgadataflow.insert_tlastmarker module" href="finn.transformation.fpgadataflow.insert_tlastmarker.html" /> - <link rel="prev" title="finn.transformation.fpgadataflow.create_dataflow_partition module" href="finn.transformation.fpgadataflow.create_dataflow_partition.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a> »</li> - - <li>finn.transformation.fpgadataflow.hlssynth_ipgen module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.fpgadataflow.hlssynth_ipgen"> -<span id="finn-transformation-fpgadataflow-hlssynth-ipgen-module"></span><h1>finn.transformation.fpgadataflow.hlssynth_ipgen module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.hlssynth_ipgen" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.hlssynth_ipgen.</code><code class="sig-name descname">HLSSynth_IPGen</code><a class="headerlink" href="#finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Compile for all nodes in model</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.fpgadataflow.insert_tlastmarker.html" class="btn btn-neutral float-right" title="finn.transformation.fpgadataflow.insert_tlastmarker module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.fpgadataflow.create_dataflow_partition.html" class="btn btn-neutral float-left" title="finn.transformation.fpgadataflow.create_dataflow_partition module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file 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 d1f6bd04b14d39d0aa25def0e877943b01e1eb44..194aa7cc1a7c82471f11fe1eb6e1806f20736e54 100644 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.html +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.html @@ -34,7 +34,9 @@ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <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="search" title="Search" href="../search.html" /> + <link rel="next" title="finn.transformation.streamline package" href="finn.transformation.streamline.html" /> + <link rel="prev" title="finn.transformation package" href="finn.transformation.html" /> </head> <body class="wy-body-for-nav"> @@ -127,6 +129,12 @@ <li><a href="../index.html">Docs</a> »</li> + <li><a href="../source_code.html">Source Code</a> »</li> + + <li><a href="finn.html">finn package</a> »</li> + + <li><a href="finn.transformation.html">finn.transformation package</a> »</li> + <li>finn.transformation.fpgadataflow package</li> @@ -407,6 +415,15 @@ transformation must be applied prior to this transformation.</p> </div> <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="finn.transformation.streamline.html" class="btn btn-neutral float-right" title="finn.transformation.streamline package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="finn.transformation.html" class="btn btn-neutral float-left" title="finn.transformation package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + <hr/> diff --git a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.insert_tlastmarker.html b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.insert_tlastmarker.html deleted file mode 100644 index 1b972534f4b2feec670783778c2d606911a86500..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.insert_tlastmarker.html +++ /dev/null @@ -1,225 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.fpgadataflow.insert_tlastmarker module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.fpgadataflow.make_deployment module" href="finn.transformation.fpgadataflow.make_deployment.html" /> - <link rel="prev" title="finn.transformation.fpgadataflow.hlssynth_ipgen module" href="finn.transformation.fpgadataflow.hlssynth_ipgen.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a> »</li> - - <li>finn.transformation.fpgadataflow.insert_tlastmarker module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.fpgadataflow.insert_tlastmarker.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.fpgadataflow.insert_tlastmarker"> -<span id="finn-transformation-fpgadataflow-insert-tlastmarker-module"></span><h1>finn.transformation.fpgadataflow.insert_tlastmarker module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.insert_tlastmarker" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.insert_tlastmarker.</code><code class="sig-name descname">InsertTLastMarker</code><a class="headerlink" href="#finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Ensure that the graph is terminated with a TLastMarker node, inserting -one if necessary.</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.fpgadataflow.make_deployment.html" class="btn btn-neutral float-right" title="finn.transformation.fpgadataflow.make_deployment module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.fpgadataflow.hlssynth_ipgen.html" class="btn btn-neutral float-left" title="finn.transformation.fpgadataflow.hlssynth_ipgen module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.make_deployment.html b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.make_deployment.html deleted file mode 100644 index 8a3bb6955891a5b5eb0b39d0fe8565f990447ceb..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.make_deployment.html +++ /dev/null @@ -1,228 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.fpgadataflow.make_deployment module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.fpgadataflow.make_pynq_driver module" href="finn.transformation.fpgadataflow.make_pynq_driver.html" /> - <link rel="prev" title="finn.transformation.fpgadataflow.insert_tlastmarker module" href="finn.transformation.fpgadataflow.insert_tlastmarker.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a> »</li> - - <li>finn.transformation.fpgadataflow.make_deployment module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.fpgadataflow.make_deployment.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.fpgadataflow.make_deployment"> -<span id="finn-transformation-fpgadataflow-make-deployment-module"></span><h1>finn.transformation.fpgadataflow.make_deployment module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.make_deployment" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.make_deployment.</code><code class="sig-name descname">DeployToPYNQ</code><span class="sig-paren">(</span><em class="sig-param">ip</em>, <em class="sig-param">username</em>, <em class="sig-param">password</em>, <em class="sig-param">target_dir</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Collects all necessary files for deployment and copies them to the PYNQ board. -Expects information about PYNQ board to make scp possible: -* ip address of board -* username and password for board -* target directory where the files are stored on the board</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.fpgadataflow.make_pynq_driver.html" class="btn btn-neutral float-right" title="finn.transformation.fpgadataflow.make_pynq_driver module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.fpgadataflow.insert_tlastmarker.html" class="btn btn-neutral float-left" title="finn.transformation.fpgadataflow.insert_tlastmarker module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.make_pynq_driver.html b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.make_pynq_driver.html deleted file mode 100644 index 1e21d93b911b55d976650f5aad323f0e30767690..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.make_pynq_driver.html +++ /dev/null @@ -1,229 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.fpgadataflow.make_pynq_driver module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.fpgadataflow.make_pynq_proj module" href="finn.transformation.fpgadataflow.make_pynq_proj.html" /> - <link rel="prev" title="finn.transformation.fpgadataflow.make_deployment module" href="finn.transformation.fpgadataflow.make_deployment.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a> »</li> - - <li>finn.transformation.fpgadataflow.make_pynq_driver module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.fpgadataflow.make_pynq_driver.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.fpgadataflow.make_pynq_driver"> -<span id="finn-transformation-fpgadataflow-make-pynq-driver-module"></span><h1>finn.transformation.fpgadataflow.make_pynq_driver module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.make_pynq_driver" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.make_pynq_driver.</code><code class="sig-name descname">MakePYNQDriver</code><a class="headerlink" href="#finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Create PYNQ Python code to correctly interface the generated -accelerator, including data packing/unpacking. The MakePYNQProject -transformation must have been already applied.</p> -<p>Outcome if successful: sets the pynq_driver_dir attribute in the ONNX -ModelProto’s metadata_props field, with the created driver dir as the -value.</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.fpgadataflow.make_pynq_proj.html" class="btn btn-neutral float-right" title="finn.transformation.fpgadataflow.make_pynq_proj module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.fpgadataflow.make_deployment.html" class="btn btn-neutral float-left" title="finn.transformation.fpgadataflow.make_deployment module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.make_pynq_proj.html b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.make_pynq_proj.html deleted file mode 100644 index c95642fa51356af6907ddebae041e37100cc60ef..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.make_pynq_proj.html +++ /dev/null @@ -1,231 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.fpgadataflow.make_pynq_proj module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.fpgadataflow.set_exec_mode module" href="finn.transformation.fpgadataflow.set_exec_mode.html" /> - <link rel="prev" title="finn.transformation.fpgadataflow.make_pynq_driver module" href="finn.transformation.fpgadataflow.make_pynq_driver.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a> »</li> - - <li>finn.transformation.fpgadataflow.make_pynq_proj module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.fpgadataflow.make_pynq_proj.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.fpgadataflow.make_pynq_proj"> -<span id="finn-transformation-fpgadataflow-make-pynq-proj-module"></span><h1>finn.transformation.fpgadataflow.make_pynq_proj module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.make_pynq_proj" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.make_pynq_proj.</code><code class="sig-name descname">MakePYNQProject</code><span class="sig-paren">(</span><em class="sig-param">platform</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Create a Vivado PYNQ overlay project (including the shell infrastructure) -from the already-stitched IP block for this graph. -All nodes in the graph must have the fpgadataflow backend attribute, -and the CodeGen_ipstitch transformation must have been previously run on -the graph.</p> -<p>Outcome if successful: sets the vivado_pynq_proj attribute in the ONNX -ModelProto’s metadata_props field, with the created project dir as the -value.</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.fpgadataflow.set_exec_mode.html" class="btn btn-neutral float-right" title="finn.transformation.fpgadataflow.set_exec_mode module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.fpgadataflow.make_pynq_driver.html" class="btn btn-neutral float-left" title="finn.transformation.fpgadataflow.make_pynq_driver module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.set_exec_mode.html b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.set_exec_mode.html deleted file mode 100644 index f7263416c286d8761f4877bcb1c0372e28f7717a..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.set_exec_mode.html +++ /dev/null @@ -1,224 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.fpgadataflow.set_exec_mode module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.fpgadataflow.synth_pynq_proj module" href="finn.transformation.fpgadataflow.synth_pynq_proj.html" /> - <link rel="prev" title="finn.transformation.fpgadataflow.make_pynq_proj module" href="finn.transformation.fpgadataflow.make_pynq_proj.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a> »</li> - - <li>finn.transformation.fpgadataflow.set_exec_mode module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.fpgadataflow.set_exec_mode.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.fpgadataflow.set_exec_mode"> -<span id="finn-transformation-fpgadataflow-set-exec-mode-module"></span><h1>finn.transformation.fpgadataflow.set_exec_mode module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.set_exec_mode" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.set_exec_mode.SetExecMode"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.set_exec_mode.</code><code class="sig-name descname">SetExecMode</code><span class="sig-paren">(</span><em class="sig-param">mode</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.set_exec_mode.SetExecMode" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Set attribute sim_mode in all fpgadataflow nodes</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.set_exec_mode.SetExecMode.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.set_exec_mode.SetExecMode.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.fpgadataflow.synth_pynq_proj.html" class="btn btn-neutral float-right" title="finn.transformation.fpgadataflow.synth_pynq_proj module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.fpgadataflow.make_pynq_proj.html" class="btn btn-neutral float-left" title="finn.transformation.fpgadataflow.make_pynq_proj module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.synth_pynq_proj.html b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.synth_pynq_proj.html deleted file mode 100644 index 4f24fdad42643766518d36826dcfccb788d24683..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.synth_pynq_proj.html +++ /dev/null @@ -1,225 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.fpgadataflow.synth_pynq_proj module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.fpgadataflow.templates module" href="finn.transformation.fpgadataflow.templates.html" /> - <link rel="prev" title="finn.transformation.fpgadataflow.set_exec_mode module" href="finn.transformation.fpgadataflow.set_exec_mode.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a> »</li> - - <li>finn.transformation.fpgadataflow.synth_pynq_proj module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.fpgadataflow.synth_pynq_proj.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.fpgadataflow.synth_pynq_proj"> -<span id="finn-transformation-fpgadataflow-synth-pynq-proj-module"></span><h1>finn.transformation.fpgadataflow.synth_pynq_proj module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.synth_pynq_proj" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.fpgadataflow.synth_pynq_proj.</code><code class="sig-name descname">SynthPYNQProject</code><a class="headerlink" href="#finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Run synthesis for the PYNQ project for this graph. The MakePYNQProject -transformation must be applied prior to this transformation.</p> -<dl class="method"> -<dt id="finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.fpgadataflow.templates.html" class="btn btn-neutral float-right" title="finn.transformation.fpgadataflow.templates module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.fpgadataflow.set_exec_mode.html" class="btn btn-neutral float-left" title="finn.transformation.fpgadataflow.set_exec_mode module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.templates.html b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.templates.html deleted file mode 100644 index 9777fad44965c77edfdf37a1436df85e7e4997cb..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.templates.html +++ /dev/null @@ -1,212 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.fpgadataflow.templates module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.streamline package" href="finn.transformation.streamline.html" /> - <link rel="prev" title="finn.transformation.fpgadataflow.synth_pynq_proj module" href="finn.transformation.fpgadataflow.synth_pynq_proj.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a> »</li> - - <li>finn.transformation.fpgadataflow.templates module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.fpgadataflow.templates.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.fpgadataflow.templates"> -<span id="finn-transformation-fpgadataflow-templates-module"></span><h1>finn.transformation.fpgadataflow.templates module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.templates" title="Permalink to this headline">¶</a></h1> -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.streamline.html" class="btn btn-neutral float-right" title="finn.transformation.streamline package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.fpgadataflow.synth_pynq_proj.html" class="btn btn-neutral float-left" title="finn.transformation.fpgadataflow.synth_pynq_proj module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.general.html b/docs/finn/_build/html/source_code/finn.transformation.general.html deleted file mode 100644 index 0c1dc50f0c7089bc81e8f174510bf8aebe8af884..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.general.html +++ /dev/null @@ -1,259 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.general module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.infer_datatypes module" href="finn.transformation.infer_datatypes.html" /> - <link rel="prev" title="finn.transformation.fold_constants module" href="finn.transformation.fold_constants.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li>finn.transformation.general module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.general.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.general"> -<span id="finn-transformation-general-module"></span><h1>finn.transformation.general module<a class="headerlink" href="#module-finn.transformation.general" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.general.ConvertSubToAdd"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.general.</code><code class="sig-name descname">ConvertSubToAdd</code><a class="headerlink" href="#finn.transformation.general.ConvertSubToAdd" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Convert sub nodes to add nodes of appropriate sign.</p> -<dl class="method"> -<dt id="finn.transformation.general.ConvertSubToAdd.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.general.ConvertSubToAdd.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.general.GiveRandomTensorNames"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.general.</code><code class="sig-name descname">GiveRandomTensorNames</code><a class="headerlink" href="#finn.transformation.general.GiveRandomTensorNames" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Give random tensor names to all tensors.</p> -<dl class="method"> -<dt id="finn.transformation.general.GiveRandomTensorNames.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.general.GiveRandomTensorNames.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.general.GiveReadableTensorNames"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.general.</code><code class="sig-name descname">GiveReadableTensorNames</code><a class="headerlink" href="#finn.transformation.general.GiveReadableTensorNames" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Give more human-readable names to all internal tensors. It’s recommended -to apply give_unique_node_names prior to this transform.</p> -<dl class="method"> -<dt id="finn.transformation.general.GiveReadableTensorNames.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.general.GiveReadableTensorNames.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.general.GiveUniqueNodeNames"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.general.</code><code class="sig-name descname">GiveUniqueNodeNames</code><a class="headerlink" href="#finn.transformation.general.GiveUniqueNodeNames" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Give unique names to each node in the graph using enumeration.</p> -<dl class="method"> -<dt id="finn.transformation.general.GiveUniqueNodeNames.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.general.GiveUniqueNodeNames.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.infer_datatypes.html" class="btn btn-neutral float-right" title="finn.transformation.infer_datatypes module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.fold_constants.html" class="btn btn-neutral float-left" title="finn.transformation.fold_constants module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.html b/docs/finn/_build/html/source_code/finn.transformation.html index b789fd54b839837860fdfefcfdf39dc5db756d39..939edb332ced4c0f024eaa6232ad2a5bb95ff11c 100644 --- a/docs/finn/_build/html/source_code/finn.transformation.html +++ b/docs/finn/_build/html/source_code/finn.transformation.html @@ -34,7 +34,9 @@ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <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="search" title="Search" href="../search.html" /> + <link rel="next" title="finn.transformation.fpgadataflow package" href="finn.transformation.fpgadataflow.html" /> + <link rel="prev" title="finn.custom_op.fpgadataflow package" href="finn.custom_op.fpgadataflow.html" /> </head> <body class="wy-body-for-nav"> @@ -127,6 +129,10 @@ <li><a href="../index.html">Docs</a> »</li> + <li><a href="../source_code.html">Source Code</a> »</li> + + <li><a href="finn.html">finn package</a> »</li> + <li>finn.transformation package</li> @@ -360,6 +366,15 @@ manually re-apply the transform.</p></li> </div> <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="finn.transformation.fpgadataflow.html" class="btn btn-neutral float-right" title="finn.transformation.fpgadataflow package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="finn.custom_op.fpgadataflow.html" class="btn btn-neutral float-left" title="finn.custom_op.fpgadataflow package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + <hr/> diff --git a/docs/finn/_build/html/source_code/finn.transformation.infer_datatypes.html b/docs/finn/_build/html/source_code/finn.transformation.infer_datatypes.html deleted file mode 100644 index 5987f219e8c8579a2044f7c15a2a77f336deb632..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.infer_datatypes.html +++ /dev/null @@ -1,223 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.infer_datatypes module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.infer_shapes module" href="finn.transformation.infer_shapes.html" /> - <link rel="prev" title="finn.transformation.general module" href="finn.transformation.general.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li>finn.transformation.infer_datatypes module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.infer_datatypes.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.infer_datatypes"> -<span id="finn-transformation-infer-datatypes-module"></span><h1>finn.transformation.infer_datatypes module<a class="headerlink" href="#module-finn.transformation.infer_datatypes" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.infer_datatypes.InferDataTypes"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.infer_datatypes.</code><code class="sig-name descname">InferDataTypes</code><a class="headerlink" href="#finn.transformation.infer_datatypes.InferDataTypes" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Infer FINN DataType info for all intermediate/output tensors based on -inputs and node type.</p> -<dl class="method"> -<dt id="finn.transformation.infer_datatypes.InferDataTypes.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.infer_datatypes.InferDataTypes.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.infer_shapes.html" class="btn btn-neutral float-right" title="finn.transformation.infer_shapes module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.general.html" class="btn btn-neutral float-left" title="finn.transformation.general module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.infer_shapes.html b/docs/finn/_build/html/source_code/finn.transformation.infer_shapes.html deleted file mode 100644 index f2b1f440de4ed3d7b49acf206a43a44620e18318..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.infer_shapes.html +++ /dev/null @@ -1,222 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.infer_shapes module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.util package" href="finn.util.html" /> - <link rel="prev" title="finn.transformation.infer_datatypes module" href="finn.transformation.infer_datatypes.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li>finn.transformation.infer_shapes module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.infer_shapes.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.infer_shapes"> -<span id="finn-transformation-infer-shapes-module"></span><h1>finn.transformation.infer_shapes module<a class="headerlink" href="#module-finn.transformation.infer_shapes" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.infer_shapes.InferShapes"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.infer_shapes.</code><code class="sig-name descname">InferShapes</code><a class="headerlink" href="#finn.transformation.infer_shapes.InferShapes" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Ensure every tensor in the model has a specified shape (ValueInfo).</p> -<dl class="method"> -<dt id="finn.transformation.infer_shapes.InferShapes.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.infer_shapes.InferShapes.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.util.html" class="btn btn-neutral float-right" title="finn.util package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.infer_datatypes.html" class="btn btn-neutral float-left" title="finn.transformation.infer_datatypes module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.streamline.absorb.html b/docs/finn/_build/html/source_code/finn.transformation.streamline.absorb.html deleted file mode 100644 index 72ae8104a1ba7830a9257608234bab9ada541b23..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.streamline.absorb.html +++ /dev/null @@ -1,265 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.streamline.absorb module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.streamline.collapse_repeated module" href="finn.transformation.streamline.collapse_repeated.html" /> - <link rel="prev" title="finn.transformation.streamline package" href="finn.transformation.streamline.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.streamline.html">finn.transformation.streamline package</a> »</li> - - <li>finn.transformation.streamline.absorb module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.streamline.absorb.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.streamline.absorb"> -<span id="finn-transformation-streamline-absorb-module"></span><h1>finn.transformation.streamline.absorb module<a class="headerlink" href="#module-finn.transformation.streamline.absorb" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.absorb.</code><code class="sig-name descname">Absorb1BitMulIntoMatMul</code><a class="headerlink" href="#finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Absorb bipolar or binary multiplications into the preciding matrix -multiply.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.absorb.</code><code class="sig-name descname">AbsorbAddIntoMultiThreshold</code><a class="headerlink" href="#finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Absorb preceding Add ops into MultiThreshold by updating the threshold -values. Only scalar/1D add vectors can be absorbed.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.absorb.</code><code class="sig-name descname">AbsorbMulIntoMultiThreshold</code><a class="headerlink" href="#finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Absorb preceding Mul ops into MultiThreshold by updating the threshold -values. Only <em>positive</em> scalar/1D mul vectors can be absorbed.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.streamline.absorb.FactorOutMulSignMagnitude"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.absorb.</code><code class="sig-name descname">FactorOutMulSignMagnitude</code><a class="headerlink" href="#finn.transformation.streamline.absorb.FactorOutMulSignMagnitude" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Split multiply-by-constant nodes into two multiply-by-constant nodes, -where the first node is a bipolar vector (of signs) and the second is a -vector of magnitudes.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.absorb.FactorOutMulSignMagnitude.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.absorb.FactorOutMulSignMagnitude.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.streamline.collapse_repeated.html" class="btn btn-neutral float-right" title="finn.transformation.streamline.collapse_repeated module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.streamline.html" class="btn btn-neutral float-left" title="finn.transformation.streamline package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.streamline.collapse_repeated.html b/docs/finn/_build/html/source_code/finn.transformation.streamline.collapse_repeated.html deleted file mode 100644 index bae88456af7be40a65e156003c573cde2082a2fc..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.streamline.collapse_repeated.html +++ /dev/null @@ -1,238 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.streamline.collapse_repeated module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.streamline.reorder module" href="finn.transformation.streamline.reorder.html" /> - <link rel="prev" title="finn.transformation.streamline.absorb module" href="finn.transformation.streamline.absorb.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.streamline.html">finn.transformation.streamline package</a> »</li> - - <li>finn.transformation.streamline.collapse_repeated module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.streamline.collapse_repeated.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.streamline.collapse_repeated"> -<span id="finn-transformation-streamline-collapse-repeated-module"></span><h1>finn.transformation.streamline.collapse_repeated module<a class="headerlink" href="#module-finn.transformation.streamline.collapse_repeated" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.streamline.collapse_repeated.CollapseRepeatedAdd"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.collapse_repeated.</code><code class="sig-name descname">CollapseRepeatedAdd</code><a class="headerlink" href="#finn.transformation.streamline.collapse_repeated.CollapseRepeatedAdd" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp" title="finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp</span></code></a></p> -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.streamline.collapse_repeated.CollapseRepeatedMul"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.collapse_repeated.</code><code class="sig-name descname">CollapseRepeatedMul</code><a class="headerlink" href="#finn.transformation.streamline.collapse_repeated.CollapseRepeatedMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp" title="finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp</span></code></a></p> -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.collapse_repeated.</code><code class="sig-name descname">CollapseRepeatedOp</code><span class="sig-paren">(</span><em class="sig-param">op_name</em>, <em class="sig-param">make_collapsed_param_fxn</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Collapse repeated consecutive operations with constant parameters into -a single operation. make_collapsed_param_fxn must take two tensors and -return a tensor which gives the equivalent result using a single op.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.streamline.reorder.html" class="btn btn-neutral float-right" title="finn.transformation.streamline.reorder module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.streamline.absorb.html" class="btn btn-neutral float-left" title="finn.transformation.streamline.absorb module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file 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 29f9bdec0439672ae1b1a607618d8977daec8193..c3faa75ab9c203bb6214ef6a9f68a4f7dd665362 100644 --- a/docs/finn/_build/html/source_code/finn.transformation.streamline.html +++ b/docs/finn/_build/html/source_code/finn.transformation.streamline.html @@ -34,7 +34,9 @@ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <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="search" title="Search" href="../search.html" /> + <link rel="next" title="finn.util package" href="finn.util.html" /> + <link rel="prev" title="finn.transformation.fpgadataflow package" href="finn.transformation.fpgadataflow.html" /> </head> <body class="wy-body-for-nav"> @@ -127,6 +129,12 @@ <li><a href="../index.html">Docs</a> »</li> + <li><a href="../source_code.html">Source Code</a> »</li> + + <li><a href="finn.html">finn package</a> »</li> + + <li><a href="finn.transformation.html">finn.transformation package</a> »</li> + <li>finn.transformation.streamline package</li> @@ -333,6 +341,15 @@ is unsigned, sets negative thresholds to zero.</p> </div> <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="finn.util.html" class="btn btn-neutral float-right" title="finn.util package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="finn.transformation.fpgadataflow.html" class="btn btn-neutral float-left" title="finn.transformation.fpgadataflow package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + <hr/> diff --git a/docs/finn/_build/html/source_code/finn.transformation.streamline.reorder.html b/docs/finn/_build/html/source_code/finn.transformation.streamline.reorder.html deleted file mode 100644 index 042fffbdad5dd93e67fdbe53f1375f05247f2bcd..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.streamline.reorder.html +++ /dev/null @@ -1,251 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.streamline.reorder module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.streamline.round_thresholds module" href="finn.transformation.streamline.round_thresholds.html" /> - <link rel="prev" title="finn.transformation.streamline.collapse_repeated module" href="finn.transformation.streamline.collapse_repeated.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.streamline.html">finn.transformation.streamline package</a> »</li> - - <li>finn.transformation.streamline.reorder module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.streamline.reorder.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.streamline.reorder"> -<span id="finn-transformation-streamline-reorder-module"></span><h1>finn.transformation.streamline.reorder module<a class="headerlink" href="#module-finn.transformation.streamline.reorder" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.streamline.reorder.MoveAddPastMul"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.reorder.</code><code class="sig-name descname">MoveAddPastMul</code><a class="headerlink" href="#finn.transformation.streamline.reorder.MoveAddPastMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Move add operations past multiply operations. The aim is to have them -next to each other such that they can be collapsed into a single add.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.reorder.MoveAddPastMul.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.reorder.MoveAddPastMul.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.streamline.reorder.MoveScalarAddPastMatMul"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.reorder.</code><code class="sig-name descname">MoveScalarAddPastMatMul</code><a class="headerlink" href="#finn.transformation.streamline.reorder.MoveScalarAddPastMatMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Move scalar add operations past matmul operations. We want to have adds -next to each other such that they can be collapsed into a single add.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.reorder.MoveScalarAddPastMatMul.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.reorder.MoveScalarAddPastMatMul.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="finn.transformation.streamline.reorder.MoveScalarMulPastMatMul"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.reorder.</code><code class="sig-name descname">MoveScalarMulPastMatMul</code><a class="headerlink" href="#finn.transformation.streamline.reorder.MoveScalarMulPastMatMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Move scalar mul operations past matmul operations. We want to have muls -next to each other such that they can be collapsed into a single mul.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.reorder.MoveScalarMulPastMatMul.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.reorder.MoveScalarMulPastMatMul.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.streamline.round_thresholds.html" class="btn btn-neutral float-right" title="finn.transformation.streamline.round_thresholds module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.streamline.collapse_repeated.html" class="btn btn-neutral float-left" title="finn.transformation.streamline.collapse_repeated module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.streamline.round_thresholds.html b/docs/finn/_build/html/source_code/finn.transformation.streamline.round_thresholds.html deleted file mode 100644 index 78981939ab8b41f740c812d001151b6250be4117..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.streamline.round_thresholds.html +++ /dev/null @@ -1,226 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.streamline.round_thresholds module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.streamline.sign_to_thres module" href="finn.transformation.streamline.sign_to_thres.html" /> - <link rel="prev" title="finn.transformation.streamline.reorder module" href="finn.transformation.streamline.reorder.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.streamline.html">finn.transformation.streamline package</a> »</li> - - <li>finn.transformation.streamline.round_thresholds module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.streamline.round_thresholds.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.streamline.round_thresholds"> -<span id="finn-transformation-streamline-round-thresholds-module"></span><h1>finn.transformation.streamline.round_thresholds module<a class="headerlink" href="#module-finn.transformation.streamline.round_thresholds" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.streamline.round_thresholds.RoundAndClipThresholds"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.round_thresholds.</code><code class="sig-name descname">RoundAndClipThresholds</code><a class="headerlink" href="#finn.transformation.streamline.round_thresholds.RoundAndClipThresholds" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>For MultiThreshold nodes operating on integer inputs, round up -thresholds values to the nearest integer. Additionally, if the input -is unsigned, sets negative thresholds to zero.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.round_thresholds.RoundAndClipThresholds.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.round_thresholds.RoundAndClipThresholds.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.streamline.sign_to_thres.html" class="btn btn-neutral float-right" title="finn.transformation.streamline.sign_to_thres module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.streamline.reorder.html" class="btn btn-neutral float-left" title="finn.transformation.streamline.reorder module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.transformation.streamline.sign_to_thres.html b/docs/finn/_build/html/source_code/finn.transformation.streamline.sign_to_thres.html deleted file mode 100644 index a4a663b6212c678b919495839d3a8ed297f67b9e..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.transformation.streamline.sign_to_thres.html +++ /dev/null @@ -1,224 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.transformation.streamline.sign_to_thres module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.transformation.batchnorm_to_affine module" href="finn.transformation.batchnorm_to_affine.html" /> - <link rel="prev" title="finn.transformation.streamline.round_thresholds module" href="finn.transformation.streamline.round_thresholds.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.transformation.html">finn.transformation package</a> »</li> - - <li><a href="finn.transformation.streamline.html">finn.transformation.streamline package</a> »</li> - - <li>finn.transformation.streamline.sign_to_thres module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.transformation.streamline.sign_to_thres.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.transformation.streamline.sign_to_thres"> -<span id="finn-transformation-streamline-sign-to-thres-module"></span><h1>finn.transformation.streamline.sign_to_thres module<a class="headerlink" href="#module-finn.transformation.streamline.sign_to_thres" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.transformation.streamline.sign_to_thres.ConvertSignToThres"> -<em class="property">class </em><code class="sig-prename descclassname">finn.transformation.streamline.sign_to_thres.</code><code class="sig-name descname">ConvertSignToThres</code><a class="headerlink" href="#finn.transformation.streamline.sign_to_thres.ConvertSignToThres" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="finn.transformation.html#finn.transformation.Transformation" title="finn.transformation.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></a></p> -<p>Convert Sign node instances to MultiThreshold with threshold at 0.</p> -<dl class="method"> -<dt id="finn.transformation.streamline.sign_to_thres.ConvertSignToThres.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.transformation.streamline.sign_to_thres.ConvertSignToThres.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.transformation.batchnorm_to_affine.html" class="btn btn-neutral float-right" title="finn.transformation.batchnorm_to_affine module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.transformation.streamline.round_thresholds.html" class="btn btn-neutral float-left" title="finn.transformation.streamline.round_thresholds module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.util.basic.html b/docs/finn/_build/html/source_code/finn.util.basic.html deleted file mode 100644 index 8b2eefee430f06a86e11c6efb2fced6a9db5adc5..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.util.basic.html +++ /dev/null @@ -1,305 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.util.basic module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.util.data_packing module" href="finn.util.data_packing.html" /> - <link rel="prev" title="finn.util package" href="finn.util.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.util.html">finn.util package</a> »</li> - - <li>finn.util.basic module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.util.basic.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.util.basic"> -<span id="finn-util-basic-module"></span><h1>finn.util.basic module<a class="headerlink" href="#module-finn.util.basic" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.util.basic.CppBuilder"> -<em class="property">class </em><code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">CppBuilder</code><a class="headerlink" href="#finn.util.basic.CppBuilder" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> -<dl class="method"> -<dt id="finn.util.basic.CppBuilder.append_includes"> -<code class="sig-name descname">append_includes</code><span class="sig-paren">(</span><em class="sig-param">library_path</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.CppBuilder.append_includes" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.util.basic.CppBuilder.append_sources"> -<code class="sig-name descname">append_sources</code><span class="sig-paren">(</span><em class="sig-param">cpp_file</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.CppBuilder.append_sources" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.util.basic.CppBuilder.build"> -<code class="sig-name descname">build</code><span class="sig-paren">(</span><em class="sig-param">code_gen_dir</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.CppBuilder.build" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.util.basic.CppBuilder.set_executable_path"> -<code class="sig-name descname">set_executable_path</code><span class="sig-paren">(</span><em class="sig-param">path</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.CppBuilder.set_executable_path" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.calculate_signed_dot_prod_range"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">calculate_signed_dot_prod_range</code><span class="sig-paren">(</span><em class="sig-param">dt_a</em>, <em class="sig-param">dt_b</em>, <em class="sig-param">len</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.calculate_signed_dot_prod_range" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the (min,max) values a dot product between two signed vectors of -types dt_a and dt_b of len elements can take.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.gen_finn_dt_tensor"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">gen_finn_dt_tensor</code><span class="sig-paren">(</span><em class="sig-param">finn_dt</em>, <em class="sig-param">tensor_shape</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.gen_finn_dt_tensor" title="Permalink to this definition">¶</a></dt> -<dd><p>Generates random tensor in given shape and with given FINN DataType</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.get_by_name"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">get_by_name</code><span class="sig-paren">(</span><em class="sig-param">container</em>, <em class="sig-param">name</em>, <em class="sig-param">name_field='name'</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.get_by_name" title="Permalink to this definition">¶</a></dt> -<dd><p>Return item from container by .name field if it exists, None otherwise</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.get_finn_root"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">get_finn_root</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.get_finn_root" title="Permalink to this definition">¶</a></dt> -<dd><p>Return the root directory that FINN is cloned into.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.interleave_matrix_outer_dim_from_partitions"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">interleave_matrix_outer_dim_from_partitions</code><span class="sig-paren">(</span><em class="sig-param">matrix</em>, <em class="sig-param">n_partitions</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.interleave_matrix_outer_dim_from_partitions" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.make_build_dir"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">make_build_dir</code><span class="sig-paren">(</span><em class="sig-param">prefix=''</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.make_build_dir" title="Permalink to this definition">¶</a></dt> -<dd><p>Creates a temporary folder with given prefix to be used as a build dir. -Use this function instead of tempfile.mkdtemp to ensure any generated files -will survive on the host after the FINN Docker container exits.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.pad_tensor_to_multiple_of"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">pad_tensor_to_multiple_of</code><span class="sig-paren">(</span><em class="sig-param">ndarray</em>, <em class="sig-param">pad_to_dims</em>, <em class="sig-param">val=0</em>, <em class="sig-param">distr_pad=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.pad_tensor_to_multiple_of" title="Permalink to this definition">¶</a></dt> -<dd><p>Pad each dimension of given NumPy ndarray using val, so that each -dimension is a multiple of the respective value in pad_to_dims. -1 means -do not pad that particular dimension. If distr_pad is False, all padding -will be inserted after the existing values; otherwise it will be split -evenly between before and after the existing values, with one extra value -inserted after if the padding amount is not divisible by two.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.random_string"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">random_string</code><span class="sig-paren">(</span><em class="sig-param">stringLength=6</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.random_string" title="Permalink to this definition">¶</a></dt> -<dd><p>Randomly generate a string of letters and digits.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.remove_by_name"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">remove_by_name</code><span class="sig-paren">(</span><em class="sig-param">container</em>, <em class="sig-param">name</em>, <em class="sig-param">name_field='name'</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.remove_by_name" title="Permalink to this definition">¶</a></dt> -<dd><p>Remove item from container by .name field if it exists</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.basic.roundup_to_integer_multiple"> -<code class="sig-prename descclassname">finn.util.basic.</code><code class="sig-name descname">roundup_to_integer_multiple</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">factor</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.basic.roundup_to_integer_multiple" title="Permalink to this definition">¶</a></dt> -<dd><p>Round up integer x to the nearest integer multiple of integer factor. -Returns x if factor is set to -1. Both x and factor must otherwise be -positive.</p> -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.util.data_packing.html" class="btn btn-neutral float-right" title="finn.util.data_packing module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.util.html" class="btn btn-neutral float-left" title="finn.util package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.util.data_packing.html b/docs/finn/_build/html/source_code/finn.util.data_packing.html deleted file mode 100644 index de8e3cc3cd30caeacf71e5efaca2885068333fa3..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.util.data_packing.html +++ /dev/null @@ -1,313 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.util.data_packing module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.util.fpgadataflow module" href="finn.util.fpgadataflow.html" /> - <link rel="prev" title="finn.util.basic module" href="finn.util.basic.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.util.html">finn.util package</a> »</li> - - <li>finn.util.data_packing module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.util.data_packing.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.util.data_packing"> -<span id="finn-util-data-packing-module"></span><h1>finn.util.data_packing module<a class="headerlink" href="#module-finn.util.data_packing" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="finn.util.data_packing.array2hexstring"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">array2hexstring</code><span class="sig-paren">(</span><em class="sig-param">array</em>, <em class="sig-param">dtype</em>, <em class="sig-param">pad_to_nbits</em>, <em class="sig-param">prefix='0x'</em>, <em class="sig-param">reverse=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.array2hexstring" title="Permalink to this definition">¶</a></dt> -<dd><p>Pack given one-dimensional NumPy array with FINN DataType dtype into a hex -string. -Any BIPOLAR values will be converted to a single bit with a 0 representing --1. -pad_to_nbits is used to prepend leading zeros to ensure packed strings of -fixed width. The minimum value for pad_to_nbits is 4, since a single hex -digit is four bits. reverse can be used to reverse the array prior to -packing.</p> -<p>Examples: -array2hexstring([1, 1, 1, 0], DataType.BINARY, 4) = “0xe†-array2hexstring([1, 1, 1, 0], DataType.BINARY, 8) = “0x0e†-array2hexstring([1, 1, 0, 1], DataType.BINARY, 4, reverse=True) = “0xb†-array2hexstring([1, 1, 1, 0], DataType.BINARY, 8, reverse=True) = “0x07â€</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.finnpy_to_packed_bytearray"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">finnpy_to_packed_bytearray</code><span class="sig-paren">(</span><em class="sig-param">ndarray</em>, <em class="sig-param">dtype</em>, <em class="sig-param">reverse_inner=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.finnpy_to_packed_bytearray" title="Permalink to this definition">¶</a></dt> -<dd><p>Given a numpy ndarray with FINN DataType dtype, pack the innermost -dimension and return the packed representation as an ndarray of uint8. -The packed innermost dimension will be padded to the nearest multiple -of 8 bits. The returned ndarray has the same number of dimensions as the -input.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.hexstring2npbytearray"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">hexstring2npbytearray</code><span class="sig-paren">(</span><em class="sig-param">hexstring</em>, <em class="sig-param">remove_prefix='0x'</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.hexstring2npbytearray" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert a hex string into a NumPy array of dtype uint8. Examples:</p> -<p>hexstring2npbytearray(“0f01â€) = array([15, 1], dtype=uint8)</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.npbytearray2hexstring"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">npbytearray2hexstring</code><span class="sig-paren">(</span><em class="sig-param">npbytearray</em>, <em class="sig-param">prefix='0x'</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.npbytearray2hexstring" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert a NumPy array of uint8 dtype into a hex string. Examples:</p> -<p>npbytearray2hexstring(array([15, 1], dtype=uint8)) = “0x0f01â€</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.npy_to_rtlsim_input"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">npy_to_rtlsim_input</code><span class="sig-paren">(</span><em class="sig-param">input_file</em>, <em class="sig-param">input_dtype</em>, <em class="sig-param">pad_to_nbits</em>, <em class="sig-param">reverse_inner=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.npy_to_rtlsim_input" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert the multidimensional NumPy array of integers (stored as floats) -from input_file into a flattened sequence of Python arbitrary-precision -integers, packing the innermost dimension. See -finn.util.basic.pack_innermost_dim_as_hex_string() for more info on how the -packing works. If reverse_inner is set, the innermost dimension will be -reversed prior to packing.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.numpy_to_hls_code"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">numpy_to_hls_code</code><span class="sig-paren">(</span><em class="sig-param">ndarray</em>, <em class="sig-param">dtype</em>, <em class="sig-param">hls_var_name</em>, <em class="sig-param">pack_innermost_dim=True</em>, <em class="sig-param">no_decl=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.numpy_to_hls_code" title="Permalink to this definition">¶</a></dt> -<dd><p>Return C++ code representation of a numpy ndarray with FINN DataType -dtype, using hls_var_name as the resulting C++ variable name. If -pack_innermost_dim is specified, the innermost dimension of the ndarray -will be packed into a hex string using array2hexstring. If no_decl is -set to True, no variable name and type will be generated as part of the -emitted string.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.pack_innermost_dim_as_hex_string"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">pack_innermost_dim_as_hex_string</code><span class="sig-paren">(</span><em class="sig-param">ndarray</em>, <em class="sig-param">dtype</em>, <em class="sig-param">pad_to_nbits</em>, <em class="sig-param">reverse_inner=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.pack_innermost_dim_as_hex_string" title="Permalink to this definition">¶</a></dt> -<dd><p>Pack the innermost dimension of the given numpy ndarray into hex -strings using array2hexstring. Examples:</p> -<p>A = [[1, 1, 1, 0], [0, 1, 1, 0]] -eA = [“0eâ€, “06â€] -pack_innermost_dim_as_hex_string(A, DataType.BINARY, 8) == eA -B = [[[3, 3], [3, 3]], [[1, 3], [3, 1]]] -eB = [[ “0fâ€, “0fâ€], [“07â€, “0dâ€]] -pack_innermost_dim_as_hex_string(B, DataType.UINT2, 8) == eB</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.packed_bytearray_to_finnpy"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">packed_bytearray_to_finnpy</code><span class="sig-paren">(</span><em class="sig-param">packed_bytearray</em>, <em class="sig-param">dtype</em>, <em class="sig-param">output_shape=None</em>, <em class="sig-param">reverse_inner=False</em>, <em class="sig-param">reverse_endian=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.packed_bytearray_to_finnpy" title="Permalink to this definition">¶</a></dt> -<dd><p>Given a packed numpy uint8 ndarray, unpack it into a FINN array of -given DataType. output_shape can be specified to remove padding from the -packed dimension, or set to None to be inferred from the input.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.rtlsim_output_to_npy"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">rtlsim_output_to_npy</code><span class="sig-paren">(</span><em class="sig-param">output</em>, <em class="sig-param">path</em>, <em class="sig-param">dtype</em>, <em class="sig-param">shape</em>, <em class="sig-param">packedBits</em>, <em class="sig-param">targetBits</em>, <em class="sig-param">reverse_inner=True</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.rtlsim_output_to_npy" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert a flattened sequence of Python arbitrary-precision integers -output into a NumPy array, saved as npy file at path. Each arbitrary-precision -integer is assumed to be a packed array of targetBits-bit elements, which -will be unpacked as the innermost dimension of the NumPy array.</p> -</dd></dl> - -<dl class="function"> -<dt id="finn.util.data_packing.unpack_innermost_dim_from_hex_string"> -<code class="sig-prename descclassname">finn.util.data_packing.</code><code class="sig-name descname">unpack_innermost_dim_from_hex_string</code><span class="sig-paren">(</span><em class="sig-param">ndarray</em>, <em class="sig-param">dtype</em>, <em class="sig-param">out_shape</em>, <em class="sig-param">reverse_inner=False</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.data_packing.unpack_innermost_dim_from_hex_string" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert a NumPy array of hex strings into a FINN NumPy array by unpacking -the hex strings into the specified data type. out_shape can be specified -such that any padding in the packing dimension is removed. If reverse_inner -is set, the innermost unpacked dimension will be reversed.</p> -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.util.fpgadataflow.html" class="btn btn-neutral float-right" title="finn.util.fpgadataflow module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.util.basic.html" class="btn btn-neutral float-left" title="finn.util.basic module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.util.fpgadataflow.html b/docs/finn/_build/html/source_code/finn.util.fpgadataflow.html deleted file mode 100644 index e78854a1b2cf5a039af601bd759b5a288affc303..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.util.fpgadataflow.html +++ /dev/null @@ -1,237 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.util.fpgadataflow module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.util.onnx module" href="finn.util.onnx.html" /> - <link rel="prev" title="finn.util.data_packing module" href="finn.util.data_packing.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.util.html">finn.util package</a> »</li> - - <li>finn.util.fpgadataflow module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.util.fpgadataflow.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.util.fpgadataflow"> -<span id="finn-util-fpgadataflow-module"></span><h1>finn.util.fpgadataflow module<a class="headerlink" href="#module-finn.util.fpgadataflow" title="Permalink to this headline">¶</a></h1> -<dl class="class"> -<dt id="finn.util.fpgadataflow.IPGenBuilder"> -<em class="property">class </em><code class="sig-prename descclassname">finn.util.fpgadataflow.</code><code class="sig-name descname">IPGenBuilder</code><a class="headerlink" href="#finn.util.fpgadataflow.IPGenBuilder" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> -<dl class="method"> -<dt id="finn.util.fpgadataflow.IPGenBuilder.append_tcl"> -<code class="sig-name descname">append_tcl</code><span class="sig-paren">(</span><em class="sig-param">tcl_script</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.fpgadataflow.IPGenBuilder.append_tcl" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.util.fpgadataflow.IPGenBuilder.build"> -<code class="sig-name descname">build</code><span class="sig-paren">(</span><em class="sig-param">code_gen_dir</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.fpgadataflow.IPGenBuilder.build" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="finn.util.fpgadataflow.IPGenBuilder.set_ipgen_path"> -<code class="sig-name descname">set_ipgen_path</code><span class="sig-paren">(</span><em class="sig-param">path</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.fpgadataflow.IPGenBuilder.set_ipgen_path" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="function"> -<dt id="finn.util.fpgadataflow.pyverilate_stitched_ip"> -<code class="sig-prename descclassname">finn.util.fpgadataflow.</code><code class="sig-name descname">pyverilate_stitched_ip</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.fpgadataflow.pyverilate_stitched_ip" title="Permalink to this definition">¶</a></dt> -<dd><p>Given a model with stitched IP, return a PyVerilator sim object.</p> -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.util.onnx.html" class="btn btn-neutral float-right" title="finn.util.onnx module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.util.data_packing.html" class="btn btn-neutral float-left" title="finn.util.data_packing module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.util.html b/docs/finn/_build/html/source_code/finn.util.html index 70b982d18c9393ab16a9486690e88e5d8c52075c..eff5daeba706c16a69b15d1c41dc15cdf4f09cd6 100644 --- a/docs/finn/_build/html/source_code/finn.util.html +++ b/docs/finn/_build/html/source_code/finn.util.html @@ -34,7 +34,8 @@ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <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="search" title="Search" href="../search.html" /> + <link rel="prev" title="finn.transformation.streamline package" href="finn.transformation.streamline.html" /> </head> <body class="wy-body-for-nav"> @@ -127,6 +128,10 @@ <li><a href="../index.html">Docs</a> »</li> + <li><a href="../source_code.html">Source Code</a> »</li> + + <li><a href="finn.html">finn package</a> »</li> + <li>finn.util package</li> @@ -428,6 +433,13 @@ is set, the innermost unpacked dimension will be reversed.</p> </div> <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + + <a href="finn.transformation.streamline.html" class="btn btn-neutral float-left" title="finn.transformation.streamline package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + <hr/> diff --git a/docs/finn/_build/html/source_code/finn.util.onnx.html b/docs/finn/_build/html/source_code/finn.util.onnx.html deleted file mode 100644 index ef69d1d79e63715b7c361ddd0d9aa796a4999fd9..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.util.onnx.html +++ /dev/null @@ -1,216 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.util.onnx module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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.util.test module" href="finn.util.test.html" /> - <link rel="prev" title="finn.util.fpgadataflow module" href="finn.util.fpgadataflow.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.util.html">finn.util package</a> »</li> - - <li>finn.util.onnx module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.util.onnx.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.util.onnx"> -<span id="finn-util-onnx-module"></span><h1>finn.util.onnx module<a class="headerlink" href="#module-finn.util.onnx" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="finn.util.onnx.valueinfo_to_tensor"> -<code class="sig-prename descclassname">finn.util.onnx.</code><code class="sig-name descname">valueinfo_to_tensor</code><span class="sig-paren">(</span><em class="sig-param">vi</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.onnx.valueinfo_to_tensor" title="Permalink to this definition">¶</a></dt> -<dd><p>Creates an all-zeroes numpy tensor from a ValueInfoProto.</p> -</dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="finn.util.test.html" class="btn btn-neutral float-right" title="finn.util.test module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="finn.util.fpgadataflow.html" class="btn btn-neutral float-left" title="finn.util.fpgadataflow module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/source_code/finn.util.test.html b/docs/finn/_build/html/source_code/finn.util.test.html deleted file mode 100644 index 6c9a032f1d7377a0583d32c76cf332de39ecf2e4..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/source_code/finn.util.test.html +++ /dev/null @@ -1,227 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>finn.util.test module — FINN documentation</title> - - - - - - - - - <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> - - - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> - - <script type="text/javascript" src="../_static/js/theme.js"></script> - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - <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="prev" title="finn.util.onnx module" href="finn.util.onnx.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="../index.html" class="icon icon-home"> FINN - - - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <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="../source_code.html">Source Code</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">FINN</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li><a href="../source_code.html">Source Code</a> »</li> - - <li><a href="finn.html">finn package</a> »</li> - - <li><a href="finn.util.html">finn.util package</a> »</li> - - <li>finn.util.test module</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/source_code/finn.util.test.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="module-finn.util.test"> -<span id="finn-util-test-module"></span><h1>finn.util.test module<a class="headerlink" href="#module-finn.util.test" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="finn.util.test.get_test_model_def_fxn"> -<code class="sig-prename descclassname">finn.util.test.</code><code class="sig-name descname">get_test_model_def_fxn</code><span class="sig-paren">(</span><em class="sig-param">netname</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.test.get_test_model_def_fxn" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="function"> -<dt id="finn.util.test.get_test_model_trained"> -<code class="sig-prename descclassname">finn.util.test.</code><code class="sig-name descname">get_test_model_trained</code><span class="sig-paren">(</span><em class="sig-param">netname</em>, <em class="sig-param">wbits</em>, <em class="sig-param">abits</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.test.get_test_model_trained" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="function"> -<dt id="finn.util.test.get_test_model_untrained"> -<code class="sig-prename descclassname">finn.util.test.</code><code class="sig-name descname">get_test_model_untrained</code><span class="sig-paren">(</span><em class="sig-param">netname</em>, <em class="sig-param">wbits</em>, <em class="sig-param">abits</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.test.get_test_model_untrained" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="function"> -<dt id="finn.util.test.get_trained_checkpoint"> -<code class="sig-prename descclassname">finn.util.test.</code><code class="sig-name descname">get_trained_checkpoint</code><span class="sig-paren">(</span><em class="sig-param">netname</em>, <em class="sig-param">wbits</em>, <em class="sig-param">abits</em><span class="sig-paren">)</span><a class="headerlink" href="#finn.util.test.get_trained_checkpoint" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</div> - - - </div> - - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - - <a href="finn.util.onnx.html" class="btn btn-neutral float-left" title="finn.util.onnx module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2020, Y. Umuroglu, J. Petri-Koenig - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/src.finn.analysis.fpgadataflow.html b/docs/finn/_build/html/src.finn.analysis.fpgadataflow.html deleted file mode 100644 index d5f674b8c764c84299d7ff9dcbe66d6730d0a265..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/src.finn.analysis.fpgadataflow.html +++ /dev/null @@ -1,126 +0,0 @@ - -<!DOCTYPE html> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta charset="utf-8" /> - <title>src.finn.analysis.fpgadataflow package — FINN documentation</title> - <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - <link rel="index" title="Index" href="genindex.html" /> - <link rel="search" title="Search" href="search.html" /> - - <link rel="stylesheet" href="_static/custom.css" type="text/css" /> - - - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> - - </head><body> - - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - - - <div class="body" role="main"> - - <div class="section" id="src-finn-analysis-fpgadataflow-package"> -<h1>src.finn.analysis.fpgadataflow package<a class="headerlink" href="#src-finn-analysis-fpgadataflow-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-src.finn.analysis.fpgadataflow.hls_synth_res_estimation"> -<span id="src-finn-analysis-fpgadataflow-hls-synth-res-estimation-module"></span><h2>src.finn.analysis.fpgadataflow.hls_synth_res_estimation module<a class="headerlink" href="#module-src.finn.analysis.fpgadataflow.hls_synth_res_estimation" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<dt id="src.finn.analysis.fpgadataflow.hls_synth_res_estimation.hls_synth_res_estimation"> -<code class="sig-prename descclassname">src.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="#src.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> -</dd></dl> - -</div> -<div class="section" id="module-src.finn.analysis.fpgadataflow.res_estimation"> -<span id="src-finn-analysis-fpgadataflow-res-estimation-module"></span><h2>src.finn.analysis.fpgadataflow.res_estimation module<a class="headerlink" href="#module-src.finn.analysis.fpgadataflow.res_estimation" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<dt id="src.finn.analysis.fpgadataflow.res_estimation.res_estimation"> -<code class="sig-prename descclassname">src.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="#src.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> -</dd></dl> - -</div> -<div class="section" id="module-src.finn.analysis.fpgadataflow"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-src.finn.analysis.fpgadataflow" title="Permalink to this headline">¶</a></h2> -</div> -</div> - - - </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index.html">FINN</a></h1> - - - - - - - - -<h3>Navigation</h3> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index.html">Documentation overview</a><ul> - </ul></li> -</ul> -</div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> - </div> -</div> -<script type="text/javascript">$('#searchbox').show(0);</script> - - - - - - - - - </div> - </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2020, Y. Umuroglu, J. Petri-Koenig. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> - - | - <a href="_sources/src.finn.analysis.fpgadataflow.rst.txt" - rel="nofollow">Page source</a> - </div> - - - - - </body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/src.finn.analysis.html b/docs/finn/_build/html/src.finn.analysis.html deleted file mode 100644 index e9492e7bd689832d196139f58bf450679cb04af6..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/src.finn.analysis.html +++ /dev/null @@ -1,170 +0,0 @@ - -<!DOCTYPE html> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta charset="utf-8" /> - <title>src.finn.analysis package — FINN documentation</title> - <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - <link rel="index" title="Index" href="genindex.html" /> - <link rel="search" title="Search" href="search.html" /> - - <link rel="stylesheet" href="_static/custom.css" type="text/css" /> - - - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> - - </head><body> - - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - - - <div class="body" role="main"> - - <div class="section" id="src-finn-analysis-package"> -<h1>src.finn.analysis package<a class="headerlink" href="#src-finn-analysis-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="subpackages"> -<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="src.finn.analysis.fpgadataflow.html">src.finn.analysis.fpgadataflow package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="src.finn.analysis.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.analysis.fpgadataflow.html#module-src.finn.analysis.fpgadataflow.hls_synth_res_estimation">src.finn.analysis.fpgadataflow.hls_synth_res_estimation module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.analysis.fpgadataflow.html#module-src.finn.analysis.fpgadataflow.res_estimation">src.finn.analysis.fpgadataflow.res_estimation module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.analysis.fpgadataflow.html#module-src.finn.analysis.fpgadataflow">Module contents</a></li> -</ul> -</li> -</ul> -</div> -</div> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-src.finn.analysis.topology"> -<span id="src-finn-analysis-topology-module"></span><h2>src.finn.analysis.topology module<a class="headerlink" href="#module-src.finn.analysis.topology" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<dt id="src.finn.analysis.topology.all_tensors_f32"> -<code class="sig-prename descclassname">src.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="#src.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> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.analysis.topology.get_per_tensor_fanouts"> -<code class="sig-prename descclassname">src.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="#src.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></dl> - -<dl class="function"> -<dt id="src.finn.analysis.topology.is_linear"> -<code class="sig-prename descclassname">src.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="#src.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> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.analysis.topology.node_inputs_in_expected_order"> -<code class="sig-prename descclassname">src.finn.analysis.topology.</code><code class="sig-name descname">node_inputs_in_expected_order</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.analysis.topology.node_inputs_in_expected_order" title="Permalink to this definition">¶</a></dt> -<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> -</dd></dl> - -</div> -<div class="section" id="module-src.finn.analysis.verify_custom_nodes"> -<span id="src-finn-analysis-verify-custom-nodes-module"></span><h2>src.finn.analysis.verify_custom_nodes module<a class="headerlink" href="#module-src.finn.analysis.verify_custom_nodes" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<dt id="src.finn.analysis.verify_custom_nodes.verify_nodes"> -<code class="sig-prename descclassname">src.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="#src.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> -</dd></dl> - -</div> -<div class="section" id="module-src.finn.analysis"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-src.finn.analysis" title="Permalink to this headline">¶</a></h2> -<div class="section" id="how-to-write-an-analysis-pass-for-finn"> -<h3>How to write an analysis pass for FINN<a class="headerlink" href="#how-to-write-an-analysis-pass-for-finn" title="Permalink to this headline">¶</a></h3> -<p>An analysis pass traverses the graph structure and produces information about -certain properties. The convention is to take in a ModelWrapper, and return -a dictionary of named properties that the analysis extracts.</p> -</div> -</div> -</div> - - - </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index.html">FINN</a></h1> - - - - - - - - -<h3>Navigation</h3> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index.html">Documentation overview</a><ul> - </ul></li> -</ul> -</div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> - </div> -</div> -<script type="text/javascript">$('#searchbox').show(0);</script> - - - - - - - - - </div> - </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2020, Y. Umuroglu, J. Petri-Koenig. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> - - | - <a href="_sources/src.finn.analysis.rst.txt" - rel="nofollow">Page source</a> - </div> - - - - - </body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/src.finn.core.html b/docs/finn/_build/html/src.finn.core.html deleted file mode 100644 index dbddb71c34f12f4329a487ba108ce7e55fef49db..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/src.finn.core.html +++ /dev/null @@ -1,466 +0,0 @@ - -<!DOCTYPE html> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta charset="utf-8" /> - <title>src.finn.core package — FINN documentation</title> - <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - <link rel="index" title="Index" href="genindex.html" /> - <link rel="search" title="Search" href="search.html" /> - - <link rel="stylesheet" href="_static/custom.css" type="text/css" /> - - - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> - - </head><body> - - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - - - <div class="body" role="main"> - - <div class="section" id="src-finn-core-package"> -<h1>src.finn.core package<a class="headerlink" href="#src-finn-core-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-src.finn.core.datatype"> -<span id="src-finn-core-datatype-module"></span><h2>src.finn.core.datatype module<a class="headerlink" href="#module-src.finn.core.datatype" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.core.datatype.DataType"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.core.datatype.</code><code class="sig-name descname">DataType</code><a class="headerlink" href="#src.finn.core.datatype.DataType" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p> -<p>An enumeration.</p> -<dl class="attribute"> -<dt id="src.finn.core.datatype.DataType.BINARY"> -<code class="sig-name descname">BINARY</code><em class="property"> = 1</em><a class="headerlink" href="#src.finn.core.datatype.DataType.BINARY" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="src.finn.core.datatype.DataType.BIPOLAR"> -<code class="sig-name descname">BIPOLAR</code><em class="property"> = 8</em><a class="headerlink" href="#src.finn.core.datatype.DataType.BIPOLAR" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="src.finn.core.datatype.DataType.FLOAT32"> -<code class="sig-name descname">FLOAT32</code><em class="property"> = 16</em><a class="headerlink" href="#src.finn.core.datatype.DataType.FLOAT32" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="src.finn.core.datatype.DataType.INT16"> -<code class="sig-name descname">INT16</code><em class="property"> = 14</em><a class="headerlink" href="#src.finn.core.datatype.DataType.INT16" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="src.finn.core.datatype.DataType.INT2"> -<code class="sig-name descname">INT2</code><em class="property"> = 10</em><a class="headerlink" href="#src.finn.core.datatype.DataType.INT2" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="src.finn.core.datatype.DataType.INT3"> -<code class="sig-name descname">INT3</code><em class="property"> = 11</em><a class="headerlink" href="#src.finn.core.datatype.DataType.INT3" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="src.finn.core.datatype.DataType.INT32"> -<code class="sig-name descname">INT32</code><em class="property"> = 15</em><a class="headerlink" href="#src.finn.core.datatype.DataType.INT32" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="src.finn.core.datatype.DataType.INT4"> -<code class="sig-name descname">INT4</code><em class="property"> = 12</em><a class="headerlink" href="#src.finn.core.datatype.DataType.INT4" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="src.finn.core.datatype.DataType.INT8"> -<code class="sig-name descname">INT8</code><em class="property"> = 13</em><a class="headerlink" href="#src.finn.core.datatype.DataType.INT8" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="src.finn.core.datatype.DataType.TERNARY"> -<code class="sig-name descname">TERNARY</code><em class="property"> = 9</em><a class="headerlink" href="#src.finn.core.datatype.DataType.TERNARY" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="src.finn.core.datatype.DataType.UINT16"> -<code class="sig-name descname">UINT16</code><em class="property"> = 6</em><a class="headerlink" href="#src.finn.core.datatype.DataType.UINT16" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="src.finn.core.datatype.DataType.UINT2"> -<code class="sig-name descname">UINT2</code><em class="property"> = 2</em><a class="headerlink" href="#src.finn.core.datatype.DataType.UINT2" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="src.finn.core.datatype.DataType.UINT3"> -<code class="sig-name descname">UINT3</code><em class="property"> = 3</em><a class="headerlink" href="#src.finn.core.datatype.DataType.UINT3" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="src.finn.core.datatype.DataType.UINT32"> -<code class="sig-name descname">UINT32</code><em class="property"> = 7</em><a class="headerlink" href="#src.finn.core.datatype.DataType.UINT32" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="src.finn.core.datatype.DataType.UINT4"> -<code class="sig-name descname">UINT4</code><em class="property"> = 4</em><a class="headerlink" href="#src.finn.core.datatype.DataType.UINT4" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="attribute"> -<dt id="src.finn.core.datatype.DataType.UINT8"> -<code class="sig-name descname">UINT8</code><em class="property"> = 5</em><a class="headerlink" href="#src.finn.core.datatype.DataType.UINT8" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.core.datatype.DataType.allowed"> -<code class="sig-name descname">allowed</code><span class="sig-paren">(</span><em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.datatype.DataType.allowed" title="Permalink to this definition">¶</a></dt> -<dd><p>Check whether given value is allowed for this DataType.</p> -<p>value (float32): value to be checked</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.datatype.DataType.bitwidth"> -<code class="sig-name descname">bitwidth</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.datatype.DataType.bitwidth" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the number of bits required for this DataType.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.datatype.DataType.get_hls_datatype_str"> -<code class="sig-name descname">get_hls_datatype_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.datatype.DataType.get_hls_datatype_str" title="Permalink to this definition">¶</a></dt> -<dd><p>Return the corresponding Vivado HLS datatype name.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.datatype.DataType.get_num_possible_values"> -<code class="sig-name descname">get_num_possible_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.datatype.DataType.get_num_possible_values" title="Permalink to this definition">¶</a></dt> -<dd><p>Return the number of possible values this DataType can take. Only -implemented for integer types for now.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.datatype.DataType.get_smallest_possible"> -<code class="sig-name descname">get_smallest_possible</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.datatype.DataType.get_smallest_possible" title="Permalink to this definition">¶</a></dt> -<dd><p>Return smallest (fewest bits) possible DataType that can represent -value. Prefers unsigned integers where possible.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.datatype.DataType.is_integer"> -<code class="sig-name descname">is_integer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.datatype.DataType.is_integer" title="Permalink to this definition">¶</a></dt> -<dd><p>Return whether this DataType represents integer values only.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.datatype.DataType.max"> -<code class="sig-name descname">max</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.datatype.DataType.max" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the largest possible value allowed by this DataType.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.datatype.DataType.min"> -<code class="sig-name descname">min</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.datatype.DataType.min" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the smallest possible value allowed by this DataType.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.datatype.DataType.signed"> -<code class="sig-name descname">signed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.datatype.DataType.signed" title="Permalink to this definition">¶</a></dt> -<dd><p>Return whether this DataType can represent negative numbers.</p> -</dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.core.execute_custom_node"> -<span id="src-finn-core-execute-custom-node-module"></span><h2>src.finn.core.execute_custom_node module<a class="headerlink" href="#module-src.finn.core.execute_custom_node" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<dt id="src.finn.core.execute_custom_node.execute_custom_node"> -<code class="sig-prename descclassname">src.finn.core.execute_custom_node.</code><code class="sig-name descname">execute_custom_node</code><span class="sig-paren">(</span><em class="sig-param">node</em>, <em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.execute_custom_node.execute_custom_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Call custom implementation to execute a single custom node. -Input/output provided via context.</p> -</dd></dl> - -</div> -<div class="section" id="module-src.finn.core.modelwrapper"> -<span id="src-finn-core-modelwrapper-module"></span><h2>src.finn.core.modelwrapper module<a class="headerlink" href="#module-src.finn.core.modelwrapper" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.core.modelwrapper.ModelWrapper"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.core.modelwrapper.</code><code class="sig-name descname">ModelWrapper</code><span class="sig-paren">(</span><em class="sig-param">onnx_model_proto</em>, <em class="sig-param">make_deepcopy=False</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> -<p>A wrapper around ONNX ModelProto that exposes some useful utility -functions for graph manipulation and exploration.</p> -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.analysis"> -<code class="sig-name descname">analysis</code><span class="sig-paren">(</span><em class="sig-param">analysis_fxn</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.analysis" title="Permalink to this definition">¶</a></dt> -<dd><p>Run given anaylsis_fxn on this model and return resulting dict.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.check_all_tensor_shapes_specified"> -<code class="sig-name descname">check_all_tensor_shapes_specified</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.check_all_tensor_shapes_specified" title="Permalink to this definition">¶</a></dt> -<dd><p>Checks whether all tensors have a specified shape (ValueInfo). -The ONNX standard allows for intermediate activations to have no -associated ValueInfo, but FINN expects this.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.check_compatibility"> -<code class="sig-name descname">check_compatibility</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.check_compatibility" title="Permalink to this definition">¶</a></dt> -<dd><p>Checks this model for FINN compatibility: -* no embedded subgraphs -* all tensor shapes are specified, including activations -* all constants are initializers</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.find_consumer"> -<code class="sig-name descname">find_consumer</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.find_consumer" title="Permalink to this definition">¶</a></dt> -<dd><p>Find and return the node that consumes the tensor with given name. -Currently only works for linear graphs.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.find_producer"> -<code class="sig-name descname">find_producer</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.find_producer" title="Permalink to this definition">¶</a></dt> -<dd><p>Find and return the node that produces the tensor with given name. -Currently only works for linear graphs.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.get_all_tensor_names"> -<code class="sig-name descname">get_all_tensor_names</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.get_all_tensor_names" title="Permalink to this definition">¶</a></dt> -<dd><p>Return a list of all (input, output and value_info) tensor names -in the graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.get_initializer"> -<code class="sig-name descname">get_initializer</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.get_initializer" title="Permalink to this definition">¶</a></dt> -<dd><p>Get the initializer value for tensor with given name, if any.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.get_metadata_prop"> -<code class="sig-name descname">get_metadata_prop</code><span class="sig-paren">(</span><em class="sig-param">key</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.get_metadata_prop" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the value associated with metadata_prop with given key, -or None otherwise.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.get_tensor_datatype"> -<code class="sig-name descname">get_tensor_datatype</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.get_tensor_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the FINN DataType of tensor with given name.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.get_tensor_fanout"> -<code class="sig-name descname">get_tensor_fanout</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.get_tensor_fanout" title="Permalink to this definition">¶</a></dt> -<dd><p>Return the number of nodes for which the tensor with given name is -as input.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.get_tensor_shape"> -<code class="sig-name descname">get_tensor_shape</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.get_tensor_shape" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the shape of tensor with given name, if it has ValueInfoProto.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.get_tensor_valueinfo"> -<code class="sig-name descname">get_tensor_valueinfo</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.get_tensor_valueinfo" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns ValueInfoProto of tensor with given name, if it has one.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.graph"> -<em class="property">property </em><code class="sig-name descname">graph</code><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.graph" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.make_empty_exec_context"> -<code class="sig-name descname">make_empty_exec_context</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.make_empty_exec_context" title="Permalink to this definition">¶</a></dt> -<dd><p>Creates an empty execution context for this model. -The execution context is a dictionary of all tensors used for the -inference computation. Any initializer values will be taken into -account, all other tensors will be zero.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.make_new_valueinfo_name"> -<code class="sig-name descname">make_new_valueinfo_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.make_new_valueinfo_name" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a name that can be used for a new value_info.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.model"> -<em class="property">property </em><code class="sig-name descname">model</code><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.model" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.rename_tensor"> -<code class="sig-name descname">rename_tensor</code><span class="sig-paren">(</span><em class="sig-param">old_name</em>, <em class="sig-param">new_name</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.rename_tensor" title="Permalink to this definition">¶</a></dt> -<dd><p>Rename a tensor from old_name to new_name.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.save"> -<code class="sig-name descname">save</code><span class="sig-paren">(</span><em class="sig-param">filename</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.save" title="Permalink to this definition">¶</a></dt> -<dd><p>Save the wrapper ONNX ModelProto into a file with given name.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.set_attribute"> -<code class="sig-name descname">set_attribute</code><span class="sig-paren">(</span><em class="sig-param">node</em>, <em class="sig-param">attribute_name</em>, <em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.set_attribute" title="Permalink to this definition">¶</a></dt> -<dd><p>Sets a custom node attribute of given name with given value</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.set_initializer"> -<code class="sig-name descname">set_initializer</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em>, <em class="sig-param">tensor_value</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.set_initializer" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the initializer value for tensor with given name.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.set_metadata_prop"> -<code class="sig-name descname">set_metadata_prop</code><span class="sig-paren">(</span><em class="sig-param">key</em>, <em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.set_metadata_prop" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.set_tensor_datatype"> -<code class="sig-name descname">set_tensor_datatype</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em>, <em class="sig-param">datatype</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.set_tensor_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Sets the FINN DataType of tensor with given name.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.set_tensor_shape"> -<code class="sig-name descname">set_tensor_shape</code><span class="sig-paren">(</span><em class="sig-param">tensor_name</em>, <em class="sig-param">tensor_shape</em>, <em class="sig-param">dtype=1</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.set_tensor_shape" title="Permalink to this definition">¶</a></dt> -<dd><p>Assign shape in ValueInfoProto for tensor with given name.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.core.modelwrapper.ModelWrapper.transform"> -<code class="sig-name descname">transform</code><span class="sig-paren">(</span><em class="sig-param">transformation</em>, <em class="sig-param">make_deepcopy=True</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.modelwrapper.ModelWrapper.transform" title="Permalink to this definition">¶</a></dt> -<dd><p>Applies given Transformation repeatedly until no more changes can be made -and returns a transformed ModelWrapper instance. -If make_deepcopy is specified, operates on a new (deep)copy of model.</p> -</dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.core.onnx_exec"> -<span id="src-finn-core-onnx-exec-module"></span><h2>src.finn.core.onnx_exec module<a class="headerlink" href="#module-src.finn.core.onnx_exec" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<dt id="src.finn.core.onnx_exec.compare_execution"> -<code class="sig-prename descclassname">src.finn.core.onnx_exec.</code><code class="sig-name descname">compare_execution</code><span class="sig-paren">(</span><em class="sig-param">model_a</em>, <em class="sig-param">model_b</em>, <em class="sig-param">input_dict</em>, <em class="sig-param">compare_fxn=<function <lambda>></em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.onnx_exec.compare_execution" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute two ONNX models and compare their outputs using given function. -compare_fxn should take in two tensors and return a Boolean</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.core.onnx_exec.execute_node"> -<code class="sig-prename descclassname">src.finn.core.onnx_exec.</code><code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">node</em>, <em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.onnx_exec.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Call onnxruntime to execute a single node. Input/output provided via context.</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.core.onnx_exec.execute_onnx"> -<code class="sig-prename descclassname">src.finn.core.onnx_exec.</code><code class="sig-name descname">execute_onnx</code><span class="sig-paren">(</span><em class="sig-param">model</em>, <em class="sig-param">input_dict</em>, <em class="sig-param">return_full_exec_context=False</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.onnx_exec.execute_onnx" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute given ONNX ModelWrapper with given named inputs. -If return_full_exec_context is False, a dict of named outputs is returned -as indicated by the model.graph.output. -If return return_full_exec_context is True, the full set of tensors used by -the execution (including inputs, weights, activations and final outputs) -will be returned as a dict.</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.core.onnx_exec.execute_onnx_and_make_model"> -<code class="sig-prename descclassname">src.finn.core.onnx_exec.</code><code class="sig-name descname">execute_onnx_and_make_model</code><span class="sig-paren">(</span><em class="sig-param">model</em>, <em class="sig-param">input_dict</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.core.onnx_exec.execute_onnx_and_make_model" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute given ONNX ModelWrapper with given named inputs and return a new -ModelWrapper where an initializer is provided for each tensor as taken from -the execution. This new model is useful for debugging, since it contains -all the intermediate activation values.</p> -</dd></dl> - -</div> -<div class="section" id="module-src.finn.core"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-src.finn.core" title="Permalink to this headline">¶</a></h2> -</div> -</div> - - - </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index.html">FINN</a></h1> - - - - - - - - -<h3>Navigation</h3> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index.html">Documentation overview</a><ul> - </ul></li> -</ul> -</div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> - </div> -</div> -<script type="text/javascript">$('#searchbox').show(0);</script> - - - - - - - - - </div> - </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2020, Y. Umuroglu, J. Petri-Koenig. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> - - | - <a href="_sources/src.finn.core.rst.txt" - rel="nofollow">Page source</a> - </div> - - - - - </body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/src.finn.custom_op.fpgadataflow.html b/docs/finn/_build/html/src.finn.custom_op.fpgadataflow.html deleted file mode 100644 index 8cc164d7b72dd39649e77b858663f326384f08ec..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/src.finn.custom_op.fpgadataflow.html +++ /dev/null @@ -1,821 +0,0 @@ - -<!DOCTYPE html> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta charset="utf-8" /> - <title>src.finn.custom_op.fpgadataflow package — FINN documentation</title> - <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - <link rel="index" title="Index" href="genindex.html" /> - <link rel="search" title="Search" href="search.html" /> - - <link rel="stylesheet" href="_static/custom.css" type="text/css" /> - - - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> - - </head><body> - - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - - - <div class="body" role="main"> - - <div class="section" id="src-finn-custom-op-fpgadataflow-package"> -<h1>src.finn.custom_op.fpgadataflow package<a class="headerlink" href="#src-finn-custom-op-fpgadataflow-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-src.finn.custom_op.fpgadataflow.convolutioninputgenerator"> -<span id="src-finn-custom-op-fpgadataflow-convolutioninputgenerator-module"></span><h2>src.finn.custom_op.fpgadataflow.convolutioninputgenerator module<a class="headerlink" href="#module-src.finn.custom_op.fpgadataflow.convolutioninputgenerator" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.custom_op.fpgadataflow.convolutioninputgenerator.</code><code class="sig-name descname">ConvolutionInputGenerator</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.fpgadataflow.HLSCustomOp</span></code></p> -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.blackboxfunction"> -<code class="sig-name descname">blackboxfunction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.blackboxfunction" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.bram_estimation"> -<code class="sig-name descname">bram_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.bram_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.dataoutstrm"> -<code class="sig-name descname">dataoutstrm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.dataoutstrm" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.defines"> -<code class="sig-name descname">defines</code><span class="sig-paren">(</span><em class="sig-param">var</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.defines" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.docompute"> -<code class="sig-name descname">docompute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.docompute" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_input_datatype"> -<code class="sig-name descname">get_input_datatype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_input_datatype" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_number_output_values"> -<code class="sig-name descname">get_number_output_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_number_output_values" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_output_datatype"> -<code class="sig-name descname">get_output_datatype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_output_datatype" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_stream_width"> -<code class="sig-name descname">get_stream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_stream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.global_includes"> -<code class="sig-name descname">global_includes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.global_includes" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.lut_estimation"> -<code class="sig-name descname">lut_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.lut_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.pragmas"> -<code class="sig-name descname">pragmas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.pragmas" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.read_npy_data"> -<code class="sig-name descname">read_npy_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.read_npy_data" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.save_as_npy"> -<code class="sig-name descname">save_as_npy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.save_as_npy" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.strm_decl"> -<code class="sig-name descname">strm_decl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.strm_decl" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.custom_op.fpgadataflow.streamingfclayer_batch"> -<span id="src-finn-custom-op-fpgadataflow-streamingfclayer-batch-module"></span><h2>src.finn.custom_op.fpgadataflow.streamingfclayer_batch module<a class="headerlink" href="#module-src.finn.custom_op.fpgadataflow.streamingfclayer_batch" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.custom_op.fpgadataflow.streamingfclayer_batch.</code><code class="sig-name descname">StreamingFCLayer_Batch</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.fpgadataflow.HLSCustomOp</span></code></p> -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.blackboxfunction"> -<code class="sig-name descname">blackboxfunction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.blackboxfunction" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.bram_estimation"> -<code class="sig-name descname">bram_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.bram_estimation" title="Permalink to this definition">¶</a></dt> -<dd><p>the calculations are based on: -- FINN-R: An End-to-End Deep-Learning Framework for Fast -Exploration of Quantized Neural Networks -- M. Blott, T. B. Preusser, N. J. Fraser, G. Gambardella, K. O’Brien, -Y. Umuroglu, M. Leeser and K. Vissers -- 12. Sep 2018</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.calc_tmem"> -<code class="sig-name descname">calc_tmem</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.calc_tmem" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.calc_wmem"> -<code class="sig-name descname">calc_wmem</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.calc_wmem" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.dataoutstrm"> -<code class="sig-name descname">dataoutstrm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.dataoutstrm" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.defines"> -<code class="sig-name descname">defines</code><span class="sig-paren">(</span><em class="sig-param">var</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.defines" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.docompute"> -<code class="sig-name descname">docompute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.docompute" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.generate_params"> -<code class="sig-name descname">generate_params</code><span class="sig-paren">(</span><em class="sig-param">model</em>, <em class="sig-param">path</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.generate_params" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_folded_input_shape"> -<code class="sig-name descname">get_folded_input_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_folded_input_shape" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_folded_output_shape"> -<code class="sig-name descname">get_folded_output_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_folded_output_shape" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_hls_compatible_threshold_tensor"> -<code class="sig-name descname">get_hls_compatible_threshold_tensor</code><span class="sig-paren">(</span><em class="sig-param">orig_thres_matrix</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_hls_compatible_threshold_tensor" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert the original numpy weight matrix orig_weight_matrix into -a form suitable for passing to the hlslib call: -* ensure MH % PE == 0 -* for bipolar weights&inputs, ensure thresholds are positive -* interleave rows between PEs -* reshape into (PE, TMEM, n_thres_steps) and return</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_hls_compatible_weight_tensor"> -<code class="sig-name descname">get_hls_compatible_weight_tensor</code><span class="sig-paren">(</span><em class="sig-param">orig_weight_matrix</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_hls_compatible_weight_tensor" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert the original numpy weight matrix orig_weight_matrix into -a form suitable for passing to the hlslib call: -* ensure MH % PE == 0 and MW % SIMD == 0 -* for bipolar {-1,+1} weights, convert to binary {0, 1} -* interleave rows between PEs -* reshape into (1, PE, WMEM, SIMD) and return</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_input_datatype"> -<code class="sig-name descname">get_input_datatype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_input_datatype" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_instream_width"> -<code class="sig-name descname">get_instream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_instream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_number_output_values"> -<code class="sig-name descname">get_number_output_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_number_output_values" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_output_datatype"> -<code class="sig-name descname">get_output_datatype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_output_datatype" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_outstream_width"> -<code class="sig-name descname">get_outstream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_outstream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_template_param_values"> -<code class="sig-name descname">get_template_param_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_template_param_values" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_weight_datatype"> -<code class="sig-name descname">get_weight_datatype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_weight_datatype" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.global_includes"> -<code class="sig-name descname">global_includes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.global_includes" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.lut_estimation"> -<code class="sig-name descname">lut_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.lut_estimation" title="Permalink to this definition">¶</a></dt> -<dd><p>the calculations are based on: -- FINN-R: An End-to-End Deep-Learning Framework for Fast -Exploration of Quantized Neural Networks -- M. Blott, T. B. Preusser, N. J. Fraser, G. Gambardella, K. O’Brien, -Y. Umuroglu, M. Leeser and K. Vissers -- 12. Sep 2018</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.pragmas"> -<code class="sig-name descname">pragmas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.pragmas" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.read_npy_data"> -<code class="sig-name descname">read_npy_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.read_npy_data" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.save_as_npy"> -<code class="sig-name descname">save_as_npy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.save_as_npy" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.strm_decl"> -<code class="sig-name descname">strm_decl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.strm_decl" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.custom_op.fpgadataflow.streamingmaxpool_batch"> -<span id="src-finn-custom-op-fpgadataflow-streamingmaxpool-batch-module"></span><h2>src.finn.custom_op.fpgadataflow.streamingmaxpool_batch module<a class="headerlink" href="#module-src.finn.custom_op.fpgadataflow.streamingmaxpool_batch" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.</code><code class="sig-name descname">StreamingMaxPool_Batch</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.fpgadataflow.HLSCustomOp</span></code></p> -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.blackboxfunction"> -<code class="sig-name descname">blackboxfunction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.blackboxfunction" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.bram_estimation"> -<code class="sig-name descname">bram_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.bram_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.dataoutstrm"> -<code class="sig-name descname">dataoutstrm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.dataoutstrm" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.defines"> -<code class="sig-name descname">defines</code><span class="sig-paren">(</span><em class="sig-param">var</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.defines" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.docompute"> -<code class="sig-name descname">docompute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.docompute" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.get_number_output_values"> -<code class="sig-name descname">get_number_output_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.get_number_output_values" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.global_includes"> -<code class="sig-name descname">global_includes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.global_includes" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.lut_estimation"> -<code class="sig-name descname">lut_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.lut_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.pragmas"> -<code class="sig-name descname">pragmas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.pragmas" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.read_npy_data"> -<code class="sig-name descname">read_npy_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.read_npy_data" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.save_as_npy"> -<code class="sig-name descname">save_as_npy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.save_as_npy" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.strm_decl"> -<code class="sig-name descname">strm_decl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.strm_decl" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.custom_op.fpgadataflow.templates"> -<span id="src-finn-custom-op-fpgadataflow-templates-module"></span><h2>src.finn.custom_op.fpgadataflow.templates module<a class="headerlink" href="#module-src.finn.custom_op.fpgadataflow.templates" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-src.finn.custom_op.fpgadataflow.tlastmarker"> -<span id="src-finn-custom-op-fpgadataflow-tlastmarker-module"></span><h2>src.finn.custom_op.fpgadataflow.tlastmarker module<a class="headerlink" href="#module-src.finn.custom_op.fpgadataflow.tlastmarker" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.custom_op.fpgadataflow.tlastmarker.</code><code class="sig-name descname">TLastMarker</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.fpgadataflow.HLSCustomOp</span></code></p> -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.blackboxfunction"> -<code class="sig-name descname">blackboxfunction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.blackboxfunction" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.dataoutstrm"> -<code class="sig-name descname">dataoutstrm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.dataoutstrm" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.defines"> -<code class="sig-name descname">defines</code><span class="sig-paren">(</span><em class="sig-param">var</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.defines" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.docompute"> -<code class="sig-name descname">docompute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.docompute" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_folded_input_shape"> -<code class="sig-name descname">get_folded_input_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_folded_input_shape" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_folded_output_shape"> -<code class="sig-name descname">get_folded_output_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_folded_output_shape" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_instream_width"> -<code class="sig-name descname">get_instream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_instream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_number_output_values"> -<code class="sig-name descname">get_number_output_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_number_output_values" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_outstream_width"> -<code class="sig-name descname">get_outstream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_outstream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.global_includes"> -<code class="sig-name descname">global_includes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.global_includes" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.pragmas"> -<code class="sig-name descname">pragmas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.pragmas" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.read_npy_data"> -<code class="sig-name descname">read_npy_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.read_npy_data" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.save_as_npy"> -<code class="sig-name descname">save_as_npy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.save_as_npy" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.strm_decl"> -<code class="sig-name descname">strm_decl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.strm_decl" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.custom_op.fpgadataflow"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-src.finn.custom_op.fpgadataflow" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.custom_op.fpgadataflow.</code><code class="sig-name descname">HLSCustomOp</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.CustomOp</span></code></p> -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.blackboxfunction"> -<em class="property">abstract </em><code class="sig-name descname">blackboxfunction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.blackboxfunction" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.bram_estimation"> -<code class="sig-name descname">bram_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.bram_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.code_generation_ipgen"> -<code class="sig-name descname">code_generation_ipgen</code><span class="sig-paren">(</span><em class="sig-param">model</em>, <em class="sig-param">fpgapart</em>, <em class="sig-param">clk</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.code_generation_ipgen" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.code_generation_npysim"> -<code class="sig-name descname">code_generation_npysim</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.code_generation_npysim" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.compile_singlenode_code"> -<code class="sig-name descname">compile_singlenode_code</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.compile_singlenode_code" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.dataoutstrm"> -<em class="property">abstract </em><code class="sig-name descname">dataoutstrm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.dataoutstrm" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.defines"> -<em class="property">abstract </em><code class="sig-name descname">defines</code><span class="sig-paren">(</span><em class="sig-param">var</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.defines" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.docompute"> -<em class="property">abstract </em><code class="sig-name descname">docompute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.docompute" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.dynamic_input_to_npy"> -<code class="sig-name descname">dynamic_input_to_npy</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">count</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.dynamic_input_to_npy" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.exec_precompiled_singlenode_model"> -<code class="sig-name descname">exec_precompiled_singlenode_model</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.exec_precompiled_singlenode_model" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.generate_params"> -<code class="sig-name descname">generate_params</code><span class="sig-paren">(</span><em class="sig-param">model</em>, <em class="sig-param">path</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.generate_params" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.get_folded_input_shape"> -<code class="sig-name descname">get_folded_input_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.get_folded_input_shape" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.get_folded_output_shape"> -<code class="sig-name descname">get_folded_output_shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.get_folded_output_shape" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.get_instream_width"> -<code class="sig-name descname">get_instream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.get_instream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.get_number_output_values"> -<em class="property">abstract </em><code class="sig-name descname">get_number_output_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.get_number_output_values" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.get_outstream_width"> -<code class="sig-name descname">get_outstream_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.get_outstream_width" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.global_includes"> -<em class="property">abstract </em><code class="sig-name descname">global_includes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.global_includes" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.ipgen_singlenode_code"> -<code class="sig-name descname">ipgen_singlenode_code</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.ipgen_singlenode_code" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.lut_estimation"> -<code class="sig-name descname">lut_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.lut_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.node_res_estimation"> -<code class="sig-name descname">node_res_estimation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.node_res_estimation" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.npy_to_dynamic_output"> -<code class="sig-name descname">npy_to_dynamic_output</code><span class="sig-paren">(</span><em class="sig-param">context</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.npy_to_dynamic_output" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.pragmas"> -<em class="property">abstract </em><code class="sig-name descname">pragmas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.pragmas" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.read_npy_data"> -<em class="property">abstract </em><code class="sig-name descname">read_npy_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.read_npy_data" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.reset_rtlsim"> -<code class="sig-name descname">reset_rtlsim</code><span class="sig-paren">(</span><em class="sig-param">sim</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.reset_rtlsim" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.rtlsim"> -<code class="sig-name descname">rtlsim</code><span class="sig-paren">(</span><em class="sig-param">sim</em>, <em class="sig-param">inp</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.rtlsim" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.save_as_npy"> -<em class="property">abstract </em><code class="sig-name descname">save_as_npy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.save_as_npy" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.strm_decl"> -<em class="property">abstract </em><code class="sig-name descname">strm_decl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.strm_decl" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.fpgadataflow.HLSCustomOp.toggle_clk"> -<code class="sig-name descname">toggle_clk</code><span class="sig-paren">(</span><em class="sig-param">sim</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.fpgadataflow.HLSCustomOp.toggle_clk" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -</div> - - - </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index.html">FINN</a></h1> - - - - - - - - -<h3>Navigation</h3> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index.html">Documentation overview</a><ul> - </ul></li> -</ul> -</div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> - </div> -</div> -<script type="text/javascript">$('#searchbox').show(0);</script> - - - - - - - - - </div> - </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2020, Y. Umuroglu, J. Petri-Koenig. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> - - | - <a href="_sources/src.finn.custom_op.fpgadataflow.rst.txt" - rel="nofollow">Page source</a> - </div> - - - - - </body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/src.finn.custom_op.html b/docs/finn/_build/html/src.finn.custom_op.html deleted file mode 100644 index e25274619b30e56cdef10b6d0e6da382be9ef653..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/src.finn.custom_op.html +++ /dev/null @@ -1,359 +0,0 @@ - -<!DOCTYPE html> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta charset="utf-8" /> - <title>src.finn.custom_op package — FINN documentation</title> - <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - <link rel="index" title="Index" href="genindex.html" /> - <link rel="search" title="Search" href="search.html" /> - - <link rel="stylesheet" href="_static/custom.css" type="text/css" /> - - - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> - - </head><body> - - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - - - <div class="body" role="main"> - - <div class="section" id="src-finn-custom-op-package"> -<h1>src.finn.custom_op package<a class="headerlink" href="#src-finn-custom-op-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="subpackages"> -<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html">src.finn.custom_op.fpgadataflow package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow.convolutioninputgenerator">src.finn.custom_op.fpgadataflow.convolutioninputgenerator module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow.streamingfclayer_batch">src.finn.custom_op.fpgadataflow.streamingfclayer_batch module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow.streamingmaxpool_batch">src.finn.custom_op.fpgadataflow.streamingmaxpool_batch module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow.templates">src.finn.custom_op.fpgadataflow.templates module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow.tlastmarker">src.finn.custom_op.fpgadataflow.tlastmarker module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow">Module contents</a></li> -</ul> -</li> -</ul> -</div> -</div> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-src.finn.custom_op.multithreshold"> -<span id="src-finn-custom-op-multithreshold-module"></span><h2>src.finn.custom_op.multithreshold module<a class="headerlink" href="#module-src.finn.custom_op.multithreshold" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.custom_op.multithreshold.MultiThreshold"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.custom_op.multithreshold.</code><code class="sig-name descname">MultiThreshold</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.multithreshold.MultiThreshold" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.CustomOp</span></code></p> -<dl class="method"> -<dt id="src.finn.custom_op.multithreshold.MultiThreshold.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.multithreshold.MultiThreshold.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.multithreshold.MultiThreshold.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.multithreshold.MultiThreshold.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.multithreshold.MultiThreshold.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.multithreshold.MultiThreshold.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.multithreshold.MultiThreshold.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.multithreshold.MultiThreshold.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.multithreshold.MultiThreshold.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.multithreshold.MultiThreshold.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -<dl class="function"> -<dt id="src.finn.custom_op.multithreshold.compare"> -<code class="sig-prename descclassname">src.finn.custom_op.multithreshold.</code><code class="sig-name descname">compare</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">y</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.multithreshold.compare" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="function"> -<dt id="src.finn.custom_op.multithreshold.multithreshold"> -<code class="sig-prename descclassname">src.finn.custom_op.multithreshold.</code><code class="sig-name descname">multithreshold</code><span class="sig-paren">(</span><em class="sig-param">v</em>, <em class="sig-param">thresholds</em>, <em class="sig-param">out_scale=None</em>, <em class="sig-param">out_bias=None</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.multithreshold.multithreshold" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</div> -<div class="section" id="module-src.finn.custom_op.registry"> -<span id="src-finn-custom-op-registry-module"></span><h2>src.finn.custom_op.registry module<a class="headerlink" href="#module-src.finn.custom_op.registry" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<dt id="src.finn.custom_op.registry.getCustomOp"> -<code class="sig-prename descclassname">src.finn.custom_op.registry.</code><code class="sig-name descname">getCustomOp</code><span class="sig-paren">(</span><em class="sig-param">node</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.registry.getCustomOp" title="Permalink to this definition">¶</a></dt> -<dd><p>Return a FINN CustomOp instance for the given ONNX node, if it exists.</p> -</dd></dl> - -</div> -<div class="section" id="module-src.finn.custom_op.streamingdataflowpartition"> -<span id="src-finn-custom-op-streamingdataflowpartition-module"></span><h2>src.finn.custom_op.streamingdataflowpartition module<a class="headerlink" href="#module-src.finn.custom_op.streamingdataflowpartition" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.custom_op.streamingdataflowpartition.</code><code class="sig-name descname">StreamingDataflowPartition</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.CustomOp</span></code></p> -<dl class="method"> -<dt id="src.finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.custom_op.xnorpopcount"> -<span id="src-finn-custom-op-xnorpopcount-module"></span><h2>src.finn.custom_op.xnorpopcount module<a class="headerlink" href="#module-src.finn.custom_op.xnorpopcount" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.custom_op.xnorpopcount.XnorPopcountMatMul"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.custom_op.xnorpopcount.</code><code class="sig-name descname">XnorPopcountMatMul</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.xnorpopcount.XnorPopcountMatMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.custom_op.CustomOp</span></code></p> -<dl class="method"> -<dt id="src.finn.custom_op.xnorpopcount.XnorPopcountMatMul.execute_node"> -<code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.xnorpopcount.XnorPopcountMatMul.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.xnorpopcount.XnorPopcountMatMul.get_nodeattr_types"> -<code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.xnorpopcount.XnorPopcountMatMul.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.xnorpopcount.XnorPopcountMatMul.infer_node_datatype"> -<code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.xnorpopcount.XnorPopcountMatMul.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.xnorpopcount.XnorPopcountMatMul.make_shape_compatible_op"> -<code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.xnorpopcount.XnorPopcountMatMul.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.xnorpopcount.XnorPopcountMatMul.verify_node"> -<code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.xnorpopcount.XnorPopcountMatMul.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -<dl class="function"> -<dt id="src.finn.custom_op.xnorpopcount.xnorpopcountmatmul"> -<code class="sig-prename descclassname">src.finn.custom_op.xnorpopcount.</code><code class="sig-name descname">xnorpopcountmatmul</code><span class="sig-paren">(</span><em class="sig-param">inp0</em>, <em class="sig-param">inp1</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.xnorpopcount.xnorpopcountmatmul" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</div> -<div class="section" id="module-src.finn.custom_op"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-src.finn.custom_op" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.custom_op.CustomOp"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.custom_op.</code><code class="sig-name descname">CustomOp</code><span class="sig-paren">(</span><em class="sig-param">onnx_node</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.CustomOp" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p> -<dl class="method"> -<dt id="src.finn.custom_op.CustomOp.execute_node"> -<em class="property">abstract </em><code class="sig-name descname">execute_node</code><span class="sig-paren">(</span><em class="sig-param">context</em>, <em class="sig-param">graph</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.CustomOp.execute_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Execute this CustomOp instance, given the execution context and -ONNX graph.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.CustomOp.get_nodeattr"> -<code class="sig-name descname">get_nodeattr</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.CustomOp.get_nodeattr" title="Permalink to this definition">¶</a></dt> -<dd><p>Get a node attribute by name. Data is stored inside the ONNX node’s -AttributeProto container. Attribute must be part of get_nodeattr_types. -Default value is returned if attribute is not set.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.CustomOp.get_nodeattr_types"> -<em class="property">abstract </em><code class="sig-name descname">get_nodeattr_types</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.CustomOp.get_nodeattr_types" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a dict of permitted attributes for node, where: -returned_dict[attribute_name] = (dtype, require, default_value) -- dtype indicates which member of the ONNX AttributeProto -will be utilized -- require indicates whether this attribute is required -- default_val indicates the default value that will be used if the -attribute is not set</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.CustomOp.infer_node_datatype"> -<em class="property">abstract </em><code class="sig-name descname">infer_node_datatype</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.CustomOp.infer_node_datatype" title="Permalink to this definition">¶</a></dt> -<dd><p>Set the DataType annotations corresponding to the outputs of this -node.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.CustomOp.make_shape_compatible_op"> -<em class="property">abstract </em><code class="sig-name descname">make_shape_compatible_op</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.CustomOp.make_shape_compatible_op" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns a standard ONNX op which is compatible with this CustomOp -for performing shape inference.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.CustomOp.set_nodeattr"> -<code class="sig-name descname">set_nodeattr</code><span class="sig-paren">(</span><em class="sig-param">name</em>, <em class="sig-param">value</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.CustomOp.set_nodeattr" title="Permalink to this definition">¶</a></dt> -<dd><p>Set a node attribute by name. Data is stored inside the ONNX node’s -AttributeProto container. Attribute must be part of get_nodeattr_types.</p> -</dd></dl> - -<dl class="method"> -<dt id="src.finn.custom_op.CustomOp.verify_node"> -<em class="property">abstract </em><code class="sig-name descname">verify_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.custom_op.CustomOp.verify_node" title="Permalink to this definition">¶</a></dt> -<dd><p>Verifies that all attributes the node needs are there and -that particular attributes are set correctly. Also checks if -the number of inputs is equal to the expected number</p> -</dd></dl> - -</dd></dl> - -</div> -</div> - - - </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index.html">FINN</a></h1> - - - - - - - - -<h3>Navigation</h3> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index.html">Documentation overview</a><ul> - </ul></li> -</ul> -</div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> - </div> -</div> -<script type="text/javascript">$('#searchbox').show(0);</script> - - - - - - - - - </div> - </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2020, Y. Umuroglu, J. Petri-Koenig. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> - - | - <a href="_sources/src.finn.custom_op.rst.txt" - rel="nofollow">Page source</a> - </div> - - - - - </body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/src.finn.html b/docs/finn/_build/html/src.finn.html deleted file mode 100644 index b9f583576959b4b9d40a63c4496ec3ee843e54fe..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/src.finn.html +++ /dev/null @@ -1,218 +0,0 @@ - -<!DOCTYPE html> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta charset="utf-8" /> - <title>src.finn package — FINN documentation</title> - <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - <link rel="index" title="Index" href="genindex.html" /> - <link rel="search" title="Search" href="search.html" /> - - <link rel="stylesheet" href="_static/custom.css" type="text/css" /> - - - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> - - </head><body> - - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - - - <div class="body" role="main"> - - <div class="section" id="src-finn-package"> -<h1>src.finn package<a class="headerlink" href="#src-finn-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="subpackages"> -<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="src.finn.analysis.html">src.finn.analysis package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="src.finn.analysis.html#subpackages">Subpackages</a><ul> -<li class="toctree-l3"><a class="reference internal" href="src.finn.analysis.fpgadataflow.html">src.finn.analysis.fpgadataflow package</a><ul> -<li class="toctree-l4"><a class="reference internal" href="src.finn.analysis.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.analysis.fpgadataflow.html#module-src.finn.analysis.fpgadataflow.hls_synth_res_estimation">src.finn.analysis.fpgadataflow.hls_synth_res_estimation module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.analysis.fpgadataflow.html#module-src.finn.analysis.fpgadataflow.res_estimation">src.finn.analysis.fpgadataflow.res_estimation module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.analysis.fpgadataflow.html#module-src.finn.analysis.fpgadataflow">Module contents</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.analysis.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.analysis.html#module-src.finn.analysis.topology">src.finn.analysis.topology module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.analysis.html#module-src.finn.analysis.verify_custom_nodes">src.finn.analysis.verify_custom_nodes module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.analysis.html#module-src.finn.analysis">Module contents</a><ul> -<li class="toctree-l3"><a class="reference internal" href="src.finn.analysis.html#how-to-write-an-analysis-pass-for-finn">How to write an analysis pass for FINN</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="src.finn.core.html">src.finn.core package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="src.finn.core.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.core.html#module-src.finn.core.datatype">src.finn.core.datatype module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.core.html#module-src.finn.core.execute_custom_node">src.finn.core.execute_custom_node module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.core.html#module-src.finn.core.modelwrapper">src.finn.core.modelwrapper module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.core.html#module-src.finn.core.onnx_exec">src.finn.core.onnx_exec module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.core.html#module-src.finn.core">Module contents</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="src.finn.custom_op.html">src.finn.custom_op package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="src.finn.custom_op.html#subpackages">Subpackages</a><ul> -<li class="toctree-l3"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html">src.finn.custom_op.fpgadataflow package</a><ul> -<li class="toctree-l4"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow.convolutioninputgenerator">src.finn.custom_op.fpgadataflow.convolutioninputgenerator module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow.streamingfclayer_batch">src.finn.custom_op.fpgadataflow.streamingfclayer_batch module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow.streamingmaxpool_batch">src.finn.custom_op.fpgadataflow.streamingmaxpool_batch module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow.templates">src.finn.custom_op.fpgadataflow.templates module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow.tlastmarker">src.finn.custom_op.fpgadataflow.tlastmarker module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow">Module contents</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.custom_op.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.custom_op.html#module-src.finn.custom_op.multithreshold">src.finn.custom_op.multithreshold module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.custom_op.html#module-src.finn.custom_op.registry">src.finn.custom_op.registry module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.custom_op.html#module-src.finn.custom_op.streamingdataflowpartition">src.finn.custom_op.streamingdataflowpartition module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.custom_op.html#module-src.finn.custom_op.xnorpopcount">src.finn.custom_op.xnorpopcount module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.custom_op.html#module-src.finn.custom_op">Module contents</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="src.finn.transformation.html">src.finn.transformation package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.html#subpackages">Subpackages</a><ul> -<li class="toctree-l3"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html">src.finn.transformation.fpgadataflow package</a><ul> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.cleanup">src.finn.transformation.fpgadataflow.cleanup module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.codegen_ipgen">src.finn.transformation.fpgadataflow.codegen_ipgen module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.codegen_ipstitch">src.finn.transformation.fpgadataflow.codegen_ipstitch module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.codegen_npysim">src.finn.transformation.fpgadataflow.codegen_npysim module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.compile">src.finn.transformation.fpgadataflow.compile module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.convert_to_hls_layers">src.finn.transformation.fpgadataflow.convert_to_hls_layers module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.create_dataflow_partition">src.finn.transformation.fpgadataflow.create_dataflow_partition module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.hlssynth_ipgen">src.finn.transformation.fpgadataflow.hlssynth_ipgen module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.insert_tlastmarker">src.finn.transformation.fpgadataflow.insert_tlastmarker module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.make_deployment">src.finn.transformation.fpgadataflow.make_deployment module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.make_pynq_driver">src.finn.transformation.fpgadataflow.make_pynq_driver module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.make_pynq_proj">src.finn.transformation.fpgadataflow.make_pynq_proj module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.set_sim_mode">src.finn.transformation.fpgadataflow.set_sim_mode module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.synth_pynq_proj">src.finn.transformation.fpgadataflow.synth_pynq_proj module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.templates">src.finn.transformation.fpgadataflow.templates module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow">Module contents</a></li> -</ul> -</li> -<li class="toctree-l3"><a class="reference internal" href="src.finn.transformation.streamline.html">src.finn.transformation.streamline package</a><ul> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.streamline.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline.absorb">src.finn.transformation.streamline.absorb module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline.collapse_repeated">src.finn.transformation.streamline.collapse_repeated module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline.reorder">src.finn.transformation.streamline.reorder module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline.round_thresholds">src.finn.transformation.streamline.round_thresholds module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline.sign_to_thres">src.finn.transformation.streamline.sign_to_thres module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline">Module contents</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.html#module-src.finn.transformation.batchnorm_to_affine">src.finn.transformation.batchnorm_to_affine module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.html#module-src.finn.transformation.bipolar_to_xnor">src.finn.transformation.bipolar_to_xnor module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.html#module-src.finn.transformation.fold_constants">src.finn.transformation.fold_constants module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.html#module-src.finn.transformation.general">src.finn.transformation.general module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.html#module-src.finn.transformation.infer_datatypes">src.finn.transformation.infer_datatypes module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.html#module-src.finn.transformation.infer_shapes">src.finn.transformation.infer_shapes module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.html#module-src.finn.transformation">Module contents</a><ul> -<li class="toctree-l3"><a class="reference internal" href="src.finn.transformation.html#guide-to-writing-finn-transformations">Guide to writing FINN transformations</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="src.finn.util.html">src.finn.util package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="src.finn.util.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.util.html#module-src.finn.util.basic">src.finn.util.basic module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.util.html#module-src.finn.util.data_packing">src.finn.util.data_packing module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.util.html#module-src.finn.util.fpgadataflow">src.finn.util.fpgadataflow module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.util.html#module-src.finn.util.onnx">src.finn.util.onnx module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.util.html#module-src.finn.util.test">src.finn.util.test module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.util.html#module-src.finn.util">Module contents</a></li> -</ul> -</li> -</ul> -</div> -</div> -<div class="section" id="module-src.finn"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-src.finn" title="Permalink to this headline">¶</a></h2> -</div> -</div> - - - </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index.html">FINN</a></h1> - - - - - - - - -<h3>Navigation</h3> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index.html">Documentation overview</a><ul> - </ul></li> -</ul> -</div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> - </div> -</div> -<script type="text/javascript">$('#searchbox').show(0);</script> - - - - - - - - - </div> - </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2020, Y. Umuroglu, J. Petri-Koenig. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> - - | - <a href="_sources/src.finn.rst.txt" - rel="nofollow">Page source</a> - </div> - - - - - </body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/src.finn.transformation.fpgadataflow.html b/docs/finn/_build/html/src.finn.transformation.fpgadataflow.html deleted file mode 100644 index ddc7ad2bb596a915ee91e665f111bde7ddce97bf..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/src.finn.transformation.fpgadataflow.html +++ /dev/null @@ -1,351 +0,0 @@ - -<!DOCTYPE html> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta charset="utf-8" /> - <title>src.finn.transformation.fpgadataflow package — FINN documentation</title> - <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - <link rel="index" title="Index" href="genindex.html" /> - <link rel="search" title="Search" href="search.html" /> - - <link rel="stylesheet" href="_static/custom.css" type="text/css" /> - - - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> - - </head><body> - - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - - - <div class="body" role="main"> - - <div class="section" id="src-finn-transformation-fpgadataflow-package"> -<h1>src.finn.transformation.fpgadataflow package<a class="headerlink" href="#src-finn-transformation-fpgadataflow-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-src.finn.transformation.fpgadataflow.cleanup"> -<span id="src-finn-transformation-fpgadataflow-cleanup-module"></span><h2>src.finn.transformation.fpgadataflow.cleanup module<a class="headerlink" href="#module-src.finn.transformation.fpgadataflow.cleanup" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.fpgadataflow.cleanup.CleanUp"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.fpgadataflow.cleanup.</code><code class="sig-name descname">CleanUp</code><a class="headerlink" href="#src.finn.transformation.fpgadataflow.cleanup.CleanUp" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Remove any generated files for fpgadataflow nodes.</p> -<dl class="method"> -<dt id="src.finn.transformation.fpgadataflow.cleanup.CleanUp.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.cleanup.CleanUp.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.fpgadataflow.codegen_ipgen"> -<span id="src-finn-transformation-fpgadataflow-codegen-ipgen-module"></span><h2>src.finn.transformation.fpgadataflow.codegen_ipgen module<a class="headerlink" href="#module-src.finn.transformation.fpgadataflow.codegen_ipgen" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.fpgadataflow.codegen_ipgen.</code><code class="sig-name descname">CodeGen_ipgen</code><span class="sig-paren">(</span><em class="sig-param">fpgapart</em>, <em class="sig-param">clk</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Code generation for all nodes in model</p> -<dl class="method"> -<dt id="src.finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.fpgadataflow.codegen_ipstitch"> -<span id="src-finn-transformation-fpgadataflow-codegen-ipstitch-module"></span><h2>src.finn.transformation.fpgadataflow.codegen_ipstitch module<a class="headerlink" href="#module-src.finn.transformation.fpgadataflow.codegen_ipstitch" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.fpgadataflow.codegen_ipstitch.</code><code class="sig-name descname">CodeGen_ipstitch</code><span class="sig-paren">(</span><em class="sig-param">fpgapart</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Create a Vivado IP Block Design project from all the generated IPs of a -graph. All nodes in the graph must have the fpgadataflow backend attribute, -and the CodeGen_ipgen transformation must have been previously run on -the graph. The resulting block design is also packaged as IP.</p> -<p>Outcome if successful: sets the vivado_stitch_proj attribute in the ONNX -ModelProto’s metadata_props field, with the created project dir as the -value. A make_project.tcl script is also placed under the same folder, -which is called to instantiate the per-layer IPs and stitch them together. -The packaged block design IP can be found under the ip subdirectory.</p> -<dl class="method"> -<dt id="src.finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.fpgadataflow.codegen_npysim"> -<span id="src-finn-transformation-fpgadataflow-codegen-npysim-module"></span><h2>src.finn.transformation.fpgadataflow.codegen_npysim module<a class="headerlink" href="#module-src.finn.transformation.fpgadataflow.codegen_npysim" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.fpgadataflow.codegen_npysim.</code><code class="sig-name descname">CodeGen_npysim</code><a class="headerlink" href="#src.finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Code generation for all nodes in model</p> -<dl class="method"> -<dt id="src.finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.fpgadataflow.compile"> -<span id="src-finn-transformation-fpgadataflow-compile-module"></span><h2>src.finn.transformation.fpgadataflow.compile module<a class="headerlink" href="#module-src.finn.transformation.fpgadataflow.compile" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.fpgadataflow.compile.Compile"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.fpgadataflow.compile.</code><code class="sig-name descname">Compile</code><a class="headerlink" href="#src.finn.transformation.fpgadataflow.compile.Compile" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Compile for all nodes in model</p> -<dl class="method"> -<dt id="src.finn.transformation.fpgadataflow.compile.Compile.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.compile.Compile.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.fpgadataflow.convert_to_hls_layers"> -<span id="src-finn-transformation-fpgadataflow-convert-to-hls-layers-module"></span><h2>src.finn.transformation.fpgadataflow.convert_to_hls_layers module<a class="headerlink" href="#module-src.finn.transformation.fpgadataflow.convert_to_hls_layers" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.fpgadataflow.convert_to_hls_layers.</code><code class="sig-name descname">InferBinaryStreamingFCLayer</code><a class="headerlink" href="#src.finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Convert pairs of binary XnorPopcountMatMul layers to -StreamingFCLayer_Batch layers. Any immediately following MultiThreshold -layers will also be absorbed into the MVTU.</p> -<dl class="method"> -<dt id="src.finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.fpgadataflow.create_dataflow_partition"> -<span id="src-finn-transformation-fpgadataflow-create-dataflow-partition-module"></span><h2>src.finn.transformation.fpgadataflow.create_dataflow_partition module<a class="headerlink" href="#module-src.finn.transformation.fpgadataflow.create_dataflow_partition" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.fpgadataflow.create_dataflow_partition.</code><code class="sig-name descname">CreateDataflowPartition</code><a class="headerlink" href="#src.finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Split a graph into two graphs; one which contains non-FINN-dataflow nodes -and a StreamingDataflowPartition node, and another which only contains -FINN dataflow nodes. The StreamingDataflowPartition has a model attribute -that indicates the filename for the second graph that only contains -dataflow nodes. No action is taken if there are no dataflow nodes.</p> -<dl class="method"> -<dt id="src.finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.fpgadataflow.hlssynth_ipgen"> -<span id="src-finn-transformation-fpgadataflow-hlssynth-ipgen-module"></span><h2>src.finn.transformation.fpgadataflow.hlssynth_ipgen module<a class="headerlink" href="#module-src.finn.transformation.fpgadataflow.hlssynth_ipgen" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.fpgadataflow.hlssynth_ipgen.</code><code class="sig-name descname">HLSSynth_IPGen</code><a class="headerlink" href="#src.finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Compile for all nodes in model</p> -<dl class="method"> -<dt id="src.finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.fpgadataflow.insert_tlastmarker"> -<span id="src-finn-transformation-fpgadataflow-insert-tlastmarker-module"></span><h2>src.finn.transformation.fpgadataflow.insert_tlastmarker module<a class="headerlink" href="#module-src.finn.transformation.fpgadataflow.insert_tlastmarker" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.fpgadataflow.insert_tlastmarker.</code><code class="sig-name descname">InsertTLastMarker</code><a class="headerlink" href="#src.finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Ensure that the graph is terminated with a TLastMarker node, inserting -one if necessary.</p> -<dl class="method"> -<dt id="src.finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.fpgadataflow.make_deployment"> -<span id="src-finn-transformation-fpgadataflow-make-deployment-module"></span><h2>src.finn.transformation.fpgadataflow.make_deployment module<a class="headerlink" href="#module-src.finn.transformation.fpgadataflow.make_deployment" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.fpgadataflow.make_deployment.</code><code class="sig-name descname">DeployToPYNQ</code><span class="sig-paren">(</span><em class="sig-param">ip</em>, <em class="sig-param">username</em>, <em class="sig-param">password</em>, <em class="sig-param">target_dir</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Collects all necessary files for deployment and copies them to the PYNQ board. -Expects information about PYNQ board to make scp possible: -* ip address of board -* username and password for board -* target directory where the files are stored on the board</p> -<dl class="method"> -<dt id="src.finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.fpgadataflow.make_pynq_driver"> -<span id="src-finn-transformation-fpgadataflow-make-pynq-driver-module"></span><h2>src.finn.transformation.fpgadataflow.make_pynq_driver module<a class="headerlink" href="#module-src.finn.transformation.fpgadataflow.make_pynq_driver" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.fpgadataflow.make_pynq_driver.</code><code class="sig-name descname">MakePYNQDriver</code><a class="headerlink" href="#src.finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Create PYNQ Python code to correctly interface the generated -accelerator, including data packing/unpacking. The MakePYNQProject -transformation must have been already applied.</p> -<p>Outcome if successful: sets the pynq_driver_dir attribute in the ONNX -ModelProto’s metadata_props field, with the created driver dir as the -value.</p> -<dl class="method"> -<dt id="src.finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.fpgadataflow.make_pynq_proj"> -<span id="src-finn-transformation-fpgadataflow-make-pynq-proj-module"></span><h2>src.finn.transformation.fpgadataflow.make_pynq_proj module<a class="headerlink" href="#module-src.finn.transformation.fpgadataflow.make_pynq_proj" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.fpgadataflow.make_pynq_proj.</code><code class="sig-name descname">MakePYNQProject</code><span class="sig-paren">(</span><em class="sig-param">platform</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Create a Vivado PYNQ overlay project (including the shell infrastructure) -from the already-stitched IP block for this graph. -All nodes in the graph must have the fpgadataflow backend attribute, -and the CodeGen_ipstitch transformation must have been previously run on -the graph.</p> -<p>Outcome if successful: sets the vivado_pynq_proj attribute in the ONNX -ModelProto’s metadata_props field, with the created project dir as the -value.</p> -<dl class="method"> -<dt id="src.finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.fpgadataflow.set_sim_mode"> -<span id="src-finn-transformation-fpgadataflow-set-sim-mode-module"></span><h2>src.finn.transformation.fpgadataflow.set_sim_mode module<a class="headerlink" href="#module-src.finn.transformation.fpgadataflow.set_sim_mode" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.fpgadataflow.set_sim_mode.SetSimMode"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.fpgadataflow.set_sim_mode.</code><code class="sig-name descname">SetSimMode</code><span class="sig-paren">(</span><em class="sig-param">mode</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.set_sim_mode.SetSimMode" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Set attribute sim_mode in all fpgadataflow nodes</p> -<dl class="method"> -<dt id="src.finn.transformation.fpgadataflow.set_sim_mode.SetSimMode.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.set_sim_mode.SetSimMode.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.fpgadataflow.synth_pynq_proj"> -<span id="src-finn-transformation-fpgadataflow-synth-pynq-proj-module"></span><h2>src.finn.transformation.fpgadataflow.synth_pynq_proj module<a class="headerlink" href="#module-src.finn.transformation.fpgadataflow.synth_pynq_proj" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.fpgadataflow.synth_pynq_proj.</code><code class="sig-name descname">SynthPYNQProject</code><a class="headerlink" href="#src.finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Run synthesis for the PYNQ project for this graph. The MakePYNQProject -transformation must be applied prior to this transformation.</p> -<dl class="method"> -<dt id="src.finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.fpgadataflow.templates"> -<span id="src-finn-transformation-fpgadataflow-templates-module"></span><h2>src.finn.transformation.fpgadataflow.templates module<a class="headerlink" href="#module-src.finn.transformation.fpgadataflow.templates" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-src.finn.transformation.fpgadataflow"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-src.finn.transformation.fpgadataflow" title="Permalink to this headline">¶</a></h2> -</div> -</div> - - - </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index.html">FINN</a></h1> - - - - - - - - -<h3>Navigation</h3> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index.html">Documentation overview</a><ul> - </ul></li> -</ul> -</div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> - </div> -</div> -<script type="text/javascript">$('#searchbox').show(0);</script> - - - - - - - - - </div> - </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2020, Y. Umuroglu, J. Petri-Koenig. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> - - | - <a href="_sources/src.finn.transformation.fpgadataflow.rst.txt" - rel="nofollow">Page source</a> - </div> - - - - - </body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/src.finn.transformation.html b/docs/finn/_build/html/src.finn.transformation.html deleted file mode 100644 index c59cf567071a1025e60a72b2c23beeea1c3c4373..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/src.finn.transformation.html +++ /dev/null @@ -1,304 +0,0 @@ - -<!DOCTYPE html> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta charset="utf-8" /> - <title>src.finn.transformation package — FINN documentation</title> - <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - <link rel="index" title="Index" href="genindex.html" /> - <link rel="search" title="Search" href="search.html" /> - - <link rel="stylesheet" href="_static/custom.css" type="text/css" /> - - - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> - - </head><body> - - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - - - <div class="body" role="main"> - - <div class="section" id="src-finn-transformation-package"> -<h1>src.finn.transformation package<a class="headerlink" href="#src-finn-transformation-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="subpackages"> -<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html">src.finn.transformation.fpgadataflow package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.cleanup">src.finn.transformation.fpgadataflow.cleanup module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.codegen_ipgen">src.finn.transformation.fpgadataflow.codegen_ipgen module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.codegen_ipstitch">src.finn.transformation.fpgadataflow.codegen_ipstitch module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.codegen_npysim">src.finn.transformation.fpgadataflow.codegen_npysim module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.compile">src.finn.transformation.fpgadataflow.compile module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.convert_to_hls_layers">src.finn.transformation.fpgadataflow.convert_to_hls_layers module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.create_dataflow_partition">src.finn.transformation.fpgadataflow.create_dataflow_partition module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.hlssynth_ipgen">src.finn.transformation.fpgadataflow.hlssynth_ipgen module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.insert_tlastmarker">src.finn.transformation.fpgadataflow.insert_tlastmarker module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.make_deployment">src.finn.transformation.fpgadataflow.make_deployment module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.make_pynq_driver">src.finn.transformation.fpgadataflow.make_pynq_driver module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.make_pynq_proj">src.finn.transformation.fpgadataflow.make_pynq_proj module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.set_sim_mode">src.finn.transformation.fpgadataflow.set_sim_mode module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.synth_pynq_proj">src.finn.transformation.fpgadataflow.synth_pynq_proj module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.templates">src.finn.transformation.fpgadataflow.templates module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow">Module contents</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="src.finn.transformation.streamline.html">src.finn.transformation.streamline package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.streamline.html#submodules">Submodules</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline.absorb">src.finn.transformation.streamline.absorb module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline.collapse_repeated">src.finn.transformation.streamline.collapse_repeated module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline.reorder">src.finn.transformation.streamline.reorder module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline.round_thresholds">src.finn.transformation.streamline.round_thresholds module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline.sign_to_thres">src.finn.transformation.streamline.sign_to_thres module</a></li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline">Module contents</a></li> -</ul> -</li> -</ul> -</div> -</div> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-src.finn.transformation.batchnorm_to_affine"> -<span id="src-finn-transformation-batchnorm-to-affine-module"></span><h2>src.finn.transformation.batchnorm_to_affine module<a class="headerlink" href="#module-src.finn.transformation.batchnorm_to_affine" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.batchnorm_to_affine.BatchNormToAffine"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.batchnorm_to_affine.</code><code class="sig-name descname">BatchNormToAffine</code><a class="headerlink" href="#src.finn.transformation.batchnorm_to_affine.BatchNormToAffine" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Replaces any test-time BatchNorm layers with Mul-Add layers.</p> -<dl class="method"> -<dt id="src.finn.transformation.batchnorm_to_affine.BatchNormToAffine.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.batchnorm_to_affine.BatchNormToAffine.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.bipolar_to_xnor"> -<span id="src-finn-transformation-bipolar-to-xnor-module"></span><h2>src.finn.transformation.bipolar_to_xnor module<a class="headerlink" href="#module-src.finn.transformation.bipolar_to_xnor" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.bipolar_to_xnor.</code><code class="sig-name descname">ConvertBipolarMatMulToXnorPopcount</code><a class="headerlink" href="#src.finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Convert MatMul nodes with all-bipolar inputs to XnorPopcountMatMul -and associated result correction.</p> -<dl class="method"> -<dt id="src.finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.fold_constants"> -<span id="src-finn-transformation-fold-constants-module"></span><h2>src.finn.transformation.fold_constants module<a class="headerlink" href="#module-src.finn.transformation.fold_constants" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.fold_constants.FoldConstants"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.fold_constants.</code><code class="sig-name descname">FoldConstants</code><a class="headerlink" href="#src.finn.transformation.fold_constants.FoldConstants" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Replace the output of a node with const-only inputs with a precomputed -result.</p> -<dl class="method"> -<dt id="src.finn.transformation.fold_constants.FoldConstants.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.fold_constants.FoldConstants.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.general"> -<span id="src-finn-transformation-general-module"></span><h2>src.finn.transformation.general module<a class="headerlink" href="#module-src.finn.transformation.general" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.general.ConvertSubToAdd"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.general.</code><code class="sig-name descname">ConvertSubToAdd</code><a class="headerlink" href="#src.finn.transformation.general.ConvertSubToAdd" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Convert sub nodes to add nodes of appropriate sign.</p> -<dl class="method"> -<dt id="src.finn.transformation.general.ConvertSubToAdd.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.general.ConvertSubToAdd.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="src.finn.transformation.general.GiveRandomTensorNames"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.general.</code><code class="sig-name descname">GiveRandomTensorNames</code><a class="headerlink" href="#src.finn.transformation.general.GiveRandomTensorNames" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Give random tensor names to all tensors.</p> -<dl class="method"> -<dt id="src.finn.transformation.general.GiveRandomTensorNames.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.general.GiveRandomTensorNames.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="src.finn.transformation.general.GiveReadableTensorNames"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.general.</code><code class="sig-name descname">GiveReadableTensorNames</code><a class="headerlink" href="#src.finn.transformation.general.GiveReadableTensorNames" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Give more human-readable names to all internal tensors. It’s recommended -to apply give_unique_node_names prior to this transform.</p> -<dl class="method"> -<dt id="src.finn.transformation.general.GiveReadableTensorNames.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.general.GiveReadableTensorNames.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="src.finn.transformation.general.GiveUniqueNodeNames"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.general.</code><code class="sig-name descname">GiveUniqueNodeNames</code><a class="headerlink" href="#src.finn.transformation.general.GiveUniqueNodeNames" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Give unique names to each node in the graph using enumeration.</p> -<dl class="method"> -<dt id="src.finn.transformation.general.GiveUniqueNodeNames.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.general.GiveUniqueNodeNames.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.infer_datatypes"> -<span id="src-finn-transformation-infer-datatypes-module"></span><h2>src.finn.transformation.infer_datatypes module<a class="headerlink" href="#module-src.finn.transformation.infer_datatypes" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.infer_datatypes.InferDataTypes"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.infer_datatypes.</code><code class="sig-name descname">InferDataTypes</code><a class="headerlink" href="#src.finn.transformation.infer_datatypes.InferDataTypes" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Infer FINN DataType info for all intermediate/output tensors based on -inputs and node type.</p> -<dl class="method"> -<dt id="src.finn.transformation.infer_datatypes.InferDataTypes.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.infer_datatypes.InferDataTypes.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.infer_shapes"> -<span id="src-finn-transformation-infer-shapes-module"></span><h2>src.finn.transformation.infer_shapes module<a class="headerlink" href="#module-src.finn.transformation.infer_shapes" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.infer_shapes.InferShapes"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.infer_shapes.</code><code class="sig-name descname">InferShapes</code><a class="headerlink" href="#src.finn.transformation.infer_shapes.InferShapes" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Ensure every tensor in the model has a specified shape (ValueInfo).</p> -<dl class="method"> -<dt id="src.finn.transformation.infer_shapes.InferShapes.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.infer_shapes.InferShapes.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-src.finn.transformation" title="Permalink to this headline">¶</a></h2> -<div class="section" id="guide-to-writing-finn-transformations"> -<h3>Guide to writing FINN transformations<a class="headerlink" href="#guide-to-writing-finn-transformations" title="Permalink to this headline">¶</a></h3> -<ul class="simple"> -<li><p>Your transformation must inherit the Transformation abstract base class.</p></li> -<li><p>Your transformation’s apply function should take in a ModelWrapper, and return -a tuple with (transformed_model: ModelWrapper, model_was_changed: Bool)</p></li> -<li><p>The transformations are meant to be applied using the .transform function -in ModelWrapper. This makes a deep copy of the input model by default, so -you don’t have to.</p></li> -<li><p>model_was_changed indicates whether your transformation made any changes to -the model. If you know your transformation needs to be called only once and -repeated calls have no further effect, you can return False even if the model -was changed.</p></li> -<li><p>You MUST return model_was_changed=False at some point when your transformation -is called multiple times, otherwise apply_repeated() will loop infinitely.</p></li> -<li><p>If you cannot guarantee that the transformation will reach a fixed point, -you must declare this, return model_was_changed = False and let the user -manually re-apply the transform.</p></li> -</ul> -<dl class="class"> -<dt id="src.finn.transformation.Transformation"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.</code><code class="sig-name descname">Transformation</code><a class="headerlink" href="#src.finn.transformation.Transformation" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p> -<dl class="method"> -<dt id="src.finn.transformation.Transformation.apply"> -<em class="property">abstract </em><code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.Transformation.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -</div> -</div> - - - </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index.html">FINN</a></h1> - - - - - - - - -<h3>Navigation</h3> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index.html">Documentation overview</a><ul> - </ul></li> -</ul> -</div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> - </div> -</div> -<script type="text/javascript">$('#searchbox').show(0);</script> - - - - - - - - - </div> - </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2020, Y. Umuroglu, J. Petri-Koenig. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> - - | - <a href="_sources/src.finn.transformation.rst.txt" - rel="nofollow">Page source</a> - </div> - - - - - </body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/src.finn.transformation.streamline.html b/docs/finn/_build/html/src.finn.transformation.streamline.html deleted file mode 100644 index c10e10cf9058bd09f390d2a8aae0b5af5d802f0e..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/src.finn.transformation.streamline.html +++ /dev/null @@ -1,277 +0,0 @@ - -<!DOCTYPE html> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta charset="utf-8" /> - <title>src.finn.transformation.streamline package — FINN documentation</title> - <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - <link rel="index" title="Index" href="genindex.html" /> - <link rel="search" title="Search" href="search.html" /> - - <link rel="stylesheet" href="_static/custom.css" type="text/css" /> - - - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> - - </head><body> - - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - - - <div class="body" role="main"> - - <div class="section" id="src-finn-transformation-streamline-package"> -<h1>src.finn.transformation.streamline package<a class="headerlink" href="#src-finn-transformation-streamline-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-src.finn.transformation.streamline.absorb"> -<span id="src-finn-transformation-streamline-absorb-module"></span><h2>src.finn.transformation.streamline.absorb module<a class="headerlink" href="#module-src.finn.transformation.streamline.absorb" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.streamline.absorb.</code><code class="sig-name descname">Absorb1BitMulIntoMatMul</code><a class="headerlink" href="#src.finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Absorb bipolar or binary multiplications into the preciding matrix -multiply.</p> -<dl class="method"> -<dt id="src.finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="src.finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.streamline.absorb.</code><code class="sig-name descname">AbsorbAddIntoMultiThreshold</code><a class="headerlink" href="#src.finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Absorb preceding Add ops into MultiThreshold by updating the threshold -values. Only scalar/1D add vectors can be absorbed.</p> -<dl class="method"> -<dt id="src.finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="src.finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.streamline.absorb.</code><code class="sig-name descname">AbsorbMulIntoMultiThreshold</code><a class="headerlink" href="#src.finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Absorb preceding Mul ops into MultiThreshold by updating the threshold -values. Only <em>positive</em> scalar/1D mul vectors can be absorbed.</p> -<dl class="method"> -<dt id="src.finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="src.finn.transformation.streamline.absorb.FactorOutMulSignMagnitude"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.streamline.absorb.</code><code class="sig-name descname">FactorOutMulSignMagnitude</code><a class="headerlink" href="#src.finn.transformation.streamline.absorb.FactorOutMulSignMagnitude" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Split multiply-by-constant nodes into two multiply-by-constant nodes, -where the first node is a bipolar vector (of signs) and the second is a -vector of magnitudes.</p> -<dl class="method"> -<dt id="src.finn.transformation.streamline.absorb.FactorOutMulSignMagnitude.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.streamline.absorb.FactorOutMulSignMagnitude.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.streamline.collapse_repeated"> -<span id="src-finn-transformation-streamline-collapse-repeated-module"></span><h2>src.finn.transformation.streamline.collapse_repeated module<a class="headerlink" href="#module-src.finn.transformation.streamline.collapse_repeated" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.streamline.collapse_repeated.CollapseRepeatedAdd"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.streamline.collapse_repeated.</code><code class="sig-name descname">CollapseRepeatedAdd</code><a class="headerlink" href="#src.finn.transformation.streamline.collapse_repeated.CollapseRepeatedAdd" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#src.finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp" title="src.finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp</span></code></a></p> -</dd></dl> - -<dl class="class"> -<dt id="src.finn.transformation.streamline.collapse_repeated.CollapseRepeatedMul"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.streamline.collapse_repeated.</code><code class="sig-name descname">CollapseRepeatedMul</code><a class="headerlink" href="#src.finn.transformation.streamline.collapse_repeated.CollapseRepeatedMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference internal" href="#src.finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp" title="src.finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp</span></code></a></p> -</dd></dl> - -<dl class="class"> -<dt id="src.finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.streamline.collapse_repeated.</code><code class="sig-name descname">CollapseRepeatedOp</code><span class="sig-paren">(</span><em class="sig-param">op_name</em>, <em class="sig-param">make_collapsed_param_fxn</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Collapse repeated consecutive operations with constant parameters into -a single operation. make_collapsed_param_fxn must take two tensors and -return a tensor which gives the equivalent result using a single op.</p> -<dl class="method"> -<dt id="src.finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.streamline.reorder"> -<span id="src-finn-transformation-streamline-reorder-module"></span><h2>src.finn.transformation.streamline.reorder module<a class="headerlink" href="#module-src.finn.transformation.streamline.reorder" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.streamline.reorder.MoveAddPastMul"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.streamline.reorder.</code><code class="sig-name descname">MoveAddPastMul</code><a class="headerlink" href="#src.finn.transformation.streamline.reorder.MoveAddPastMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Move add operations past multiply operations. The aim is to have them -next to each other such that they can be collapsed into a single add.</p> -<dl class="method"> -<dt id="src.finn.transformation.streamline.reorder.MoveAddPastMul.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.streamline.reorder.MoveAddPastMul.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="src.finn.transformation.streamline.reorder.MoveScalarAddPastMatMul"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.streamline.reorder.</code><code class="sig-name descname">MoveScalarAddPastMatMul</code><a class="headerlink" href="#src.finn.transformation.streamline.reorder.MoveScalarAddPastMatMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Move scalar add operations past matmul operations. We want to have adds -next to each other such that they can be collapsed into a single add.</p> -<dl class="method"> -<dt id="src.finn.transformation.streamline.reorder.MoveScalarAddPastMatMul.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.streamline.reorder.MoveScalarAddPastMatMul.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="class"> -<dt id="src.finn.transformation.streamline.reorder.MoveScalarMulPastMatMul"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.streamline.reorder.</code><code class="sig-name descname">MoveScalarMulPastMatMul</code><a class="headerlink" href="#src.finn.transformation.streamline.reorder.MoveScalarMulPastMatMul" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Move scalar mul operations past matmul operations. We want to have muls -next to each other such that they can be collapsed into a single mul.</p> -<dl class="method"> -<dt id="src.finn.transformation.streamline.reorder.MoveScalarMulPastMatMul.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.streamline.reorder.MoveScalarMulPastMatMul.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.streamline.round_thresholds"> -<span id="src-finn-transformation-streamline-round-thresholds-module"></span><h2>src.finn.transformation.streamline.round_thresholds module<a class="headerlink" href="#module-src.finn.transformation.streamline.round_thresholds" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.streamline.round_thresholds.RoundAndClipThresholds"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.streamline.round_thresholds.</code><code class="sig-name descname">RoundAndClipThresholds</code><a class="headerlink" href="#src.finn.transformation.streamline.round_thresholds.RoundAndClipThresholds" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>For MultiThreshold nodes operating on integer inputs, round up -thresholds values to the nearest integer. Additionally, if the input -is unsigned, sets negative thresholds to zero.</p> -<dl class="method"> -<dt id="src.finn.transformation.streamline.round_thresholds.RoundAndClipThresholds.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.streamline.round_thresholds.RoundAndClipThresholds.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.streamline.sign_to_thres"> -<span id="src-finn-transformation-streamline-sign-to-thres-module"></span><h2>src.finn.transformation.streamline.sign_to_thres module<a class="headerlink" href="#module-src.finn.transformation.streamline.sign_to_thres" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.streamline.sign_to_thres.ConvertSignToThres"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.streamline.sign_to_thres.</code><code class="sig-name descname">ConvertSignToThres</code><a class="headerlink" href="#src.finn.transformation.streamline.sign_to_thres.ConvertSignToThres" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Convert Sign node instances to MultiThreshold with threshold at 0.</p> -<dl class="method"> -<dt id="src.finn.transformation.streamline.sign_to_thres.ConvertSignToThres.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.streamline.sign_to_thres.ConvertSignToThres.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -<div class="section" id="module-src.finn.transformation.streamline"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-src.finn.transformation.streamline" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.transformation.streamline.Streamline"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.transformation.streamline.</code><code class="sig-name descname">Streamline</code><a class="headerlink" href="#src.finn.transformation.streamline.Streamline" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">finn.transformation.Transformation</span></code></p> -<p>Apply the streamlining transform, see arXiv:1709.04060.</p> -<dl class="method"> -<dt id="src.finn.transformation.streamline.Streamline.apply"> -<code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.transformation.streamline.Streamline.apply" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -</div> -</div> - - - </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index.html">FINN</a></h1> - - - - - - - - -<h3>Navigation</h3> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index.html">Documentation overview</a><ul> - </ul></li> -</ul> -</div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> - </div> -</div> -<script type="text/javascript">$('#searchbox').show(0);</script> - - - - - - - - - </div> - </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2020, Y. Umuroglu, J. Petri-Koenig. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> - - | - <a href="_sources/src.finn.transformation.streamline.rst.txt" - rel="nofollow">Page source</a> - </div> - - - - - </body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/src.finn.util.html b/docs/finn/_build/html/src.finn.util.html deleted file mode 100644 index 1bb5f9360753bb5ccf5cfa94614b0f8bf4bce976..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/src.finn.util.html +++ /dev/null @@ -1,368 +0,0 @@ - -<!DOCTYPE html> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta charset="utf-8" /> - <title>src.finn.util package — FINN documentation</title> - <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - <link rel="index" title="Index" href="genindex.html" /> - <link rel="search" title="Search" href="search.html" /> - - <link rel="stylesheet" href="_static/custom.css" type="text/css" /> - - - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> - - </head><body> - - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - - - <div class="body" role="main"> - - <div class="section" id="src-finn-util-package"> -<h1>src.finn.util package<a class="headerlink" href="#src-finn-util-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> -</div> -<div class="section" id="module-src.finn.util.basic"> -<span id="src-finn-util-basic-module"></span><h2>src.finn.util.basic module<a class="headerlink" href="#module-src.finn.util.basic" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.util.basic.CppBuilder"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.util.basic.</code><code class="sig-name descname">CppBuilder</code><a class="headerlink" href="#src.finn.util.basic.CppBuilder" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> -<dl class="method"> -<dt id="src.finn.util.basic.CppBuilder.append_includes"> -<code class="sig-name descname">append_includes</code><span class="sig-paren">(</span><em class="sig-param">library_path</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.basic.CppBuilder.append_includes" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.util.basic.CppBuilder.append_sources"> -<code class="sig-name descname">append_sources</code><span class="sig-paren">(</span><em class="sig-param">cpp_file</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.basic.CppBuilder.append_sources" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.util.basic.CppBuilder.build"> -<code class="sig-name descname">build</code><span class="sig-paren">(</span><em class="sig-param">code_gen_dir</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.basic.CppBuilder.build" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.util.basic.CppBuilder.set_executable_path"> -<code class="sig-name descname">set_executable_path</code><span class="sig-paren">(</span><em class="sig-param">path</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.basic.CppBuilder.set_executable_path" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.basic.calculate_signed_dot_prod_range"> -<code class="sig-prename descclassname">src.finn.util.basic.</code><code class="sig-name descname">calculate_signed_dot_prod_range</code><span class="sig-paren">(</span><em class="sig-param">dt_a</em>, <em class="sig-param">dt_b</em>, <em class="sig-param">len</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.basic.calculate_signed_dot_prod_range" title="Permalink to this definition">¶</a></dt> -<dd><p>Returns the (min,max) values a dot product between two signed vectors of -types dt_a and dt_b of len elements can take.</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.basic.gen_finn_dt_tensor"> -<code class="sig-prename descclassname">src.finn.util.basic.</code><code class="sig-name descname">gen_finn_dt_tensor</code><span class="sig-paren">(</span><em class="sig-param">finn_dt</em>, <em class="sig-param">tensor_shape</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.basic.gen_finn_dt_tensor" title="Permalink to this definition">¶</a></dt> -<dd><p>Generates random tensor in given shape and with given FINN DataType</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.basic.get_by_name"> -<code class="sig-prename descclassname">src.finn.util.basic.</code><code class="sig-name descname">get_by_name</code><span class="sig-paren">(</span><em class="sig-param">container</em>, <em class="sig-param">name</em>, <em class="sig-param">name_field='name'</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.basic.get_by_name" title="Permalink to this definition">¶</a></dt> -<dd><p>Return item from container by .name field if it exists, None otherwise</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.basic.get_finn_root"> -<code class="sig-prename descclassname">src.finn.util.basic.</code><code class="sig-name descname">get_finn_root</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.basic.get_finn_root" title="Permalink to this definition">¶</a></dt> -<dd><p>Return the root directory that FINN is cloned into.</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.basic.interleave_matrix_outer_dim_from_partitions"> -<code class="sig-prename descclassname">src.finn.util.basic.</code><code class="sig-name descname">interleave_matrix_outer_dim_from_partitions</code><span class="sig-paren">(</span><em class="sig-param">matrix</em>, <em class="sig-param">n_partitions</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.basic.interleave_matrix_outer_dim_from_partitions" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="function"> -<dt id="src.finn.util.basic.make_build_dir"> -<code class="sig-prename descclassname">src.finn.util.basic.</code><code class="sig-name descname">make_build_dir</code><span class="sig-paren">(</span><em class="sig-param">prefix=''</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.basic.make_build_dir" title="Permalink to this definition">¶</a></dt> -<dd><p>Creates a temporary folder with given prefix to be used as a build dir. -Use this function instead of tempfile.mkdtemp to ensure any generated files -will survive on the host after the FINN Docker container exits.</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.basic.pad_tensor_to_multiple_of"> -<code class="sig-prename descclassname">src.finn.util.basic.</code><code class="sig-name descname">pad_tensor_to_multiple_of</code><span class="sig-paren">(</span><em class="sig-param">ndarray</em>, <em class="sig-param">pad_to_dims</em>, <em class="sig-param">val=0</em>, <em class="sig-param">distr_pad=False</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.basic.pad_tensor_to_multiple_of" title="Permalink to this definition">¶</a></dt> -<dd><p>Pad each dimension of given NumPy ndarray using val, so that each -dimension is a multiple of the respective value in pad_to_dims. -1 means -do not pad that particular dimension. If distr_pad is False, all padding -will be inserted after the existing values; otherwise it will be split -evenly between before and after the existing values, with one extra value -inserted after if the padding amount is not divisible by two.</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.basic.random_string"> -<code class="sig-prename descclassname">src.finn.util.basic.</code><code class="sig-name descname">random_string</code><span class="sig-paren">(</span><em class="sig-param">stringLength=6</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.basic.random_string" title="Permalink to this definition">¶</a></dt> -<dd><p>Randomly generate a string of letters and digits.</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.basic.remove_by_name"> -<code class="sig-prename descclassname">src.finn.util.basic.</code><code class="sig-name descname">remove_by_name</code><span class="sig-paren">(</span><em class="sig-param">container</em>, <em class="sig-param">name</em>, <em class="sig-param">name_field='name'</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.basic.remove_by_name" title="Permalink to this definition">¶</a></dt> -<dd><p>Remove item from container by .name field if it exists</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.basic.roundup_to_integer_multiple"> -<code class="sig-prename descclassname">src.finn.util.basic.</code><code class="sig-name descname">roundup_to_integer_multiple</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">factor</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.basic.roundup_to_integer_multiple" title="Permalink to this definition">¶</a></dt> -<dd><p>Round up integer x to the nearest integer multiple of integer factor. -Returns x if factor is set to -1. Both x and factor must otherwise be -positive.</p> -</dd></dl> - -</div> -<div class="section" id="module-src.finn.util.data_packing"> -<span id="src-finn-util-data-packing-module"></span><h2>src.finn.util.data_packing module<a class="headerlink" href="#module-src.finn.util.data_packing" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<dt id="src.finn.util.data_packing.array2hexstring"> -<code class="sig-prename descclassname">src.finn.util.data_packing.</code><code class="sig-name descname">array2hexstring</code><span class="sig-paren">(</span><em class="sig-param">array</em>, <em class="sig-param">dtype</em>, <em class="sig-param">pad_to_nbits</em>, <em class="sig-param">prefix='0x'</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.data_packing.array2hexstring" title="Permalink to this definition">¶</a></dt> -<dd><p>Pack given one-dimensional NumPy array with FINN DataType dtype into a hex -string. -Any BIPOLAR values will be converted to a single bit with a 0 representing --1. -pad_to_nbits is used to prepend leading zeros to ensure packed strings of -fixed width. The minimum value for pad_to_nbits is 4, since a single hex -digit is four bits.</p> -<p>Examples: -array2hexstring([1, 1, 1, 0], DataType.BINARY, 4) = “e†-array2hexstring([1, 1, 1, 0], DataType.BINARY, 8) = “0eâ€</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.data_packing.finnpy_to_packed_bytearray"> -<code class="sig-prename descclassname">src.finn.util.data_packing.</code><code class="sig-name descname">finnpy_to_packed_bytearray</code><span class="sig-paren">(</span><em class="sig-param">ndarray</em>, <em class="sig-param">dtype</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.data_packing.finnpy_to_packed_bytearray" title="Permalink to this definition">¶</a></dt> -<dd><p>Given a numpy ndarray with FINN DataType dtype, pack the innermost -dimension and return the packed representation as an ndarray of uint8. -The packed innermost dimension will be padded to the nearest multiple -of 8 bits. The returned ndarray has the same number of dimensions as the -input.</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.data_packing.hexstring2npbytearray"> -<code class="sig-prename descclassname">src.finn.util.data_packing.</code><code class="sig-name descname">hexstring2npbytearray</code><span class="sig-paren">(</span><em class="sig-param">hexstring</em>, <em class="sig-param">remove_prefix='0x'</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.data_packing.hexstring2npbytearray" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert a hex string into a NumPy array of dtype uint8. Examples:</p> -<p>hexstring2npbytearray(“0f01â€) = array([15, 1], dtype=uint8)</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.data_packing.npbytearray2hexstring"> -<code class="sig-prename descclassname">src.finn.util.data_packing.</code><code class="sig-name descname">npbytearray2hexstring</code><span class="sig-paren">(</span><em class="sig-param">npbytearray</em>, <em class="sig-param">prefix='0x'</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.data_packing.npbytearray2hexstring" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert a NumPy array of uint8 dtype into a hex string. Examples:</p> -<p>npbytearray2hexstring(array([15, 1], dtype=uint8)) = “0x0f01â€</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.data_packing.npy_to_rtlsim_input"> -<code class="sig-prename descclassname">src.finn.util.data_packing.</code><code class="sig-name descname">npy_to_rtlsim_input</code><span class="sig-paren">(</span><em class="sig-param">input_file</em>, <em class="sig-param">input_dtype</em>, <em class="sig-param">pad_to_nbits</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.data_packing.npy_to_rtlsim_input" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert the multidimensional NumPy array of integers (stored as floats) -from input_file into a flattened sequence of Python arbitrary-precision -integers, packing the innermost dimension. See -finn.util.basic.pack_innermost_dim_as_hex_string() for more info on how the -packing works.</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.data_packing.numpy_to_hls_code"> -<code class="sig-prename descclassname">src.finn.util.data_packing.</code><code class="sig-name descname">numpy_to_hls_code</code><span class="sig-paren">(</span><em class="sig-param">ndarray</em>, <em class="sig-param">dtype</em>, <em class="sig-param">hls_var_name</em>, <em class="sig-param">pack_innermost_dim=True</em>, <em class="sig-param">no_decl=False</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.data_packing.numpy_to_hls_code" title="Permalink to this definition">¶</a></dt> -<dd><p>Return C++ code representation of a numpy ndarray with FINN DataType -dtype, using hls_var_name as the resulting C++ variable name. If -pack_innermost_dim is specified, the innermost dimension of the ndarray -will be packed into a hex string using array2hexstring. If no_decl is -set to True, no variable name and type will be generated as part of the -emitted string.</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.data_packing.pack_innermost_dim_as_hex_string"> -<code class="sig-prename descclassname">src.finn.util.data_packing.</code><code class="sig-name descname">pack_innermost_dim_as_hex_string</code><span class="sig-paren">(</span><em class="sig-param">ndarray</em>, <em class="sig-param">dtype</em>, <em class="sig-param">pad_to_nbits</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.data_packing.pack_innermost_dim_as_hex_string" title="Permalink to this definition">¶</a></dt> -<dd><p>Pack the innermost dimension of the given numpy ndarray into hex -strings using array2hexstring. Examples:</p> -<p>A = [[1, 1, 1, 0], [0, 1, 1, 0]] -eA = [“0eâ€, “06â€] -pack_innermost_dim_as_hex_string(A, DataType.BINARY, 8) == eA -B = [[[3, 3], [3, 3]], [[1, 3], [3, 1]]] -eB = [[ “0fâ€, “0fâ€], [“07â€, “0dâ€]] -pack_innermost_dim_as_hex_string(B, DataType.UINT2, 8) == eB</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.data_packing.packed_bytearray_to_finnpy"> -<code class="sig-prename descclassname">src.finn.util.data_packing.</code><code class="sig-name descname">packed_bytearray_to_finnpy</code><span class="sig-paren">(</span><em class="sig-param">packed_bytearray</em>, <em class="sig-param">dtype</em>, <em class="sig-param">output_shape=None</em>, <em class="sig-param">reverse_inner=False</em>, <em class="sig-param">reverse_endian=False</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.data_packing.packed_bytearray_to_finnpy" title="Permalink to this definition">¶</a></dt> -<dd><p>Given a packed numpy uint8 ndarray, unpack it into a FINN array of -given DataType. output_shape can be specified to remove padding from the -packed dimension, or set to None to be inferred from the input.</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.data_packing.rtlsim_output_to_npy"> -<code class="sig-prename descclassname">src.finn.util.data_packing.</code><code class="sig-name descname">rtlsim_output_to_npy</code><span class="sig-paren">(</span><em class="sig-param">output</em>, <em class="sig-param">path</em>, <em class="sig-param">dtype</em>, <em class="sig-param">shape</em>, <em class="sig-param">packedBits</em>, <em class="sig-param">targetBits</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.data_packing.rtlsim_output_to_npy" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert a flattened sequence of Python arbitrary-precision integers -output into a NumPy array, saved as npy file at path. Each arbitrary-precision -integer is assumed to be a packed array of targetBits-bit elements, which -will be unpacked as the innermost dimension of the NumPy array.</p> -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.data_packing.unpack_innermost_dim_from_hex_string"> -<code class="sig-prename descclassname">src.finn.util.data_packing.</code><code class="sig-name descname">unpack_innermost_dim_from_hex_string</code><span class="sig-paren">(</span><em class="sig-param">ndarray</em>, <em class="sig-param">dtype</em>, <em class="sig-param">out_shape</em>, <em class="sig-param">reverse_inner=False</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.data_packing.unpack_innermost_dim_from_hex_string" title="Permalink to this definition">¶</a></dt> -<dd><p>Convert a NumPy array of hex strings into a FINN NumPy array by unpacking -the hex strings into the specified data type. out_shape can be specified -such that any padding in the packing dimension is removed. If reverse_inner -is set, the innermost unpacked dimension will be reversed.</p> -</dd></dl> - -</div> -<div class="section" id="module-src.finn.util.fpgadataflow"> -<span id="src-finn-util-fpgadataflow-module"></span><h2>src.finn.util.fpgadataflow module<a class="headerlink" href="#module-src.finn.util.fpgadataflow" title="Permalink to this headline">¶</a></h2> -<dl class="class"> -<dt id="src.finn.util.fpgadataflow.IPGenBuilder"> -<em class="property">class </em><code class="sig-prename descclassname">src.finn.util.fpgadataflow.</code><code class="sig-name descname">IPGenBuilder</code><a class="headerlink" href="#src.finn.util.fpgadataflow.IPGenBuilder" title="Permalink to this definition">¶</a></dt> -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> -<dl class="method"> -<dt id="src.finn.util.fpgadataflow.IPGenBuilder.append_tcl"> -<code class="sig-name descname">append_tcl</code><span class="sig-paren">(</span><em class="sig-param">tcl_script</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.fpgadataflow.IPGenBuilder.append_tcl" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.util.fpgadataflow.IPGenBuilder.build"> -<code class="sig-name descname">build</code><span class="sig-paren">(</span><em class="sig-param">code_gen_dir</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.fpgadataflow.IPGenBuilder.build" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> -<dt id="src.finn.util.fpgadataflow.IPGenBuilder.set_ipgen_path"> -<code class="sig-name descname">set_ipgen_path</code><span class="sig-paren">(</span><em class="sig-param">path</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.fpgadataflow.IPGenBuilder.set_ipgen_path" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</dd></dl> - -<dl class="function"> -<dt id="src.finn.util.fpgadataflow.pyverilate_stitched_ip"> -<code class="sig-prename descclassname">src.finn.util.fpgadataflow.</code><code class="sig-name descname">pyverilate_stitched_ip</code><span class="sig-paren">(</span><em class="sig-param">model</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.fpgadataflow.pyverilate_stitched_ip" title="Permalink to this definition">¶</a></dt> -<dd><p>Given a model with stitched IP, return a PyVerilator sim object.</p> -</dd></dl> - -</div> -<div class="section" id="module-src.finn.util.onnx"> -<span id="src-finn-util-onnx-module"></span><h2>src.finn.util.onnx module<a class="headerlink" href="#module-src.finn.util.onnx" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<dt id="src.finn.util.onnx.valueinfo_to_tensor"> -<code class="sig-prename descclassname">src.finn.util.onnx.</code><code class="sig-name descname">valueinfo_to_tensor</code><span class="sig-paren">(</span><em class="sig-param">vi</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.onnx.valueinfo_to_tensor" title="Permalink to this definition">¶</a></dt> -<dd><p>Creates an all-zeroes numpy tensor from a ValueInfoProto.</p> -</dd></dl> - -</div> -<div class="section" id="module-src.finn.util.test"> -<span id="src-finn-util-test-module"></span><h2>src.finn.util.test module<a class="headerlink" href="#module-src.finn.util.test" title="Permalink to this headline">¶</a></h2> -<dl class="function"> -<dt id="src.finn.util.test.get_test_model_def_fxn"> -<code class="sig-prename descclassname">src.finn.util.test.</code><code class="sig-name descname">get_test_model_def_fxn</code><span class="sig-paren">(</span><em class="sig-param">netname</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.test.get_test_model_def_fxn" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="function"> -<dt id="src.finn.util.test.get_test_model_trained"> -<code class="sig-prename descclassname">src.finn.util.test.</code><code class="sig-name descname">get_test_model_trained</code><span class="sig-paren">(</span><em class="sig-param">netname</em>, <em class="sig-param">wbits</em>, <em class="sig-param">abits</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.test.get_test_model_trained" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="function"> -<dt id="src.finn.util.test.get_test_model_untrained"> -<code class="sig-prename descclassname">src.finn.util.test.</code><code class="sig-name descname">get_test_model_untrained</code><span class="sig-paren">(</span><em class="sig-param">netname</em>, <em class="sig-param">wbits</em>, <em class="sig-param">abits</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.test.get_test_model_untrained" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="function"> -<dt id="src.finn.util.test.get_trained_checkpoint"> -<code class="sig-prename descclassname">src.finn.util.test.</code><code class="sig-name descname">get_trained_checkpoint</code><span class="sig-paren">(</span><em class="sig-param">netname</em>, <em class="sig-param">wbits</em>, <em class="sig-param">abits</em><span class="sig-paren">)</span><a class="headerlink" href="#src.finn.util.test.get_trained_checkpoint" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -</div> -<div class="section" id="module-src.finn.util"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-src.finn.util" title="Permalink to this headline">¶</a></h2> -</div> -</div> - - - </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index.html">FINN</a></h1> - - - - - - - - -<h3>Navigation</h3> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index.html">Documentation overview</a><ul> - </ul></li> -</ul> -</div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> - </div> -</div> -<script type="text/javascript">$('#searchbox').show(0);</script> - - - - - - - - - </div> - </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2020, Y. Umuroglu, J. Petri-Koenig. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> - - | - <a href="_sources/src.finn.util.rst.txt" - rel="nofollow">Page source</a> - </div> - - - - - </body> -</html> \ No newline at end of file diff --git a/docs/finn/_build/html/src.html b/docs/finn/_build/html/src.html deleted file mode 100644 index e27a39891794d8be74209b622c6151f168933f67..0000000000000000000000000000000000000000 --- a/docs/finn/_build/html/src.html +++ /dev/null @@ -1,225 +0,0 @@ - -<!DOCTYPE html> - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta charset="utf-8" /> - <title>src package — FINN documentation</title> - <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - <script type="text/javascript" src="_static/language_data.js"></script> - <link rel="index" title="Index" href="genindex.html" /> - <link rel="search" title="Search" href="search.html" /> - - <link rel="stylesheet" href="_static/custom.css" type="text/css" /> - - - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> - - </head><body> - - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - - - <div class="body" role="main"> - - <div class="section" id="src-package"> -<h1>src package<a class="headerlink" href="#src-package" title="Permalink to this headline">¶</a></h1> -<div class="section" id="subpackages"> -<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="src.finn.html">src.finn package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="src.finn.html#subpackages">Subpackages</a><ul> -<li class="toctree-l3"><a class="reference internal" href="src.finn.analysis.html">src.finn.analysis package</a><ul> -<li class="toctree-l4"><a class="reference internal" href="src.finn.analysis.html#subpackages">Subpackages</a><ul> -<li class="toctree-l5"><a class="reference internal" href="src.finn.analysis.fpgadataflow.html">src.finn.analysis.fpgadataflow package</a><ul> -<li class="toctree-l6"><a class="reference internal" href="src.finn.analysis.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.analysis.fpgadataflow.html#module-src.finn.analysis.fpgadataflow.hls_synth_res_estimation">src.finn.analysis.fpgadataflow.hls_synth_res_estimation module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.analysis.fpgadataflow.html#module-src.finn.analysis.fpgadataflow.res_estimation">src.finn.analysis.fpgadataflow.res_estimation module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.analysis.fpgadataflow.html#module-src.finn.analysis.fpgadataflow">Module contents</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.analysis.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.analysis.html#module-src.finn.analysis.topology">src.finn.analysis.topology module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.analysis.html#module-src.finn.analysis.verify_custom_nodes">src.finn.analysis.verify_custom_nodes module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.analysis.html#module-src.finn.analysis">Module contents</a><ul> -<li class="toctree-l5"><a class="reference internal" href="src.finn.analysis.html#how-to-write-an-analysis-pass-for-finn">How to write an analysis pass for FINN</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l3"><a class="reference internal" href="src.finn.core.html">src.finn.core package</a><ul> -<li class="toctree-l4"><a class="reference internal" href="src.finn.core.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.core.html#module-src.finn.core.datatype">src.finn.core.datatype module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.core.html#module-src.finn.core.execute_custom_node">src.finn.core.execute_custom_node module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.core.html#module-src.finn.core.modelwrapper">src.finn.core.modelwrapper module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.core.html#module-src.finn.core.onnx_exec">src.finn.core.onnx_exec module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.core.html#module-src.finn.core">Module contents</a></li> -</ul> -</li> -<li class="toctree-l3"><a class="reference internal" href="src.finn.custom_op.html">src.finn.custom_op package</a><ul> -<li class="toctree-l4"><a class="reference internal" href="src.finn.custom_op.html#subpackages">Subpackages</a><ul> -<li class="toctree-l5"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html">src.finn.custom_op.fpgadataflow package</a><ul> -<li class="toctree-l6"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow.convolutioninputgenerator">src.finn.custom_op.fpgadataflow.convolutioninputgenerator module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow.streamingfclayer_batch">src.finn.custom_op.fpgadataflow.streamingfclayer_batch module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow.streamingmaxpool_batch">src.finn.custom_op.fpgadataflow.streamingmaxpool_batch module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow.templates">src.finn.custom_op.fpgadataflow.templates module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow.tlastmarker">src.finn.custom_op.fpgadataflow.tlastmarker module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.custom_op.fpgadataflow.html#module-src.finn.custom_op.fpgadataflow">Module contents</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.custom_op.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.custom_op.html#module-src.finn.custom_op.multithreshold">src.finn.custom_op.multithreshold module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.custom_op.html#module-src.finn.custom_op.registry">src.finn.custom_op.registry module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.custom_op.html#module-src.finn.custom_op.streamingdataflowpartition">src.finn.custom_op.streamingdataflowpartition module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.custom_op.html#module-src.finn.custom_op.xnorpopcount">src.finn.custom_op.xnorpopcount module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.custom_op.html#module-src.finn.custom_op">Module contents</a></li> -</ul> -</li> -<li class="toctree-l3"><a class="reference internal" href="src.finn.transformation.html">src.finn.transformation package</a><ul> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.html#subpackages">Subpackages</a><ul> -<li class="toctree-l5"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html">src.finn.transformation.fpgadataflow package</a><ul> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.cleanup">src.finn.transformation.fpgadataflow.cleanup module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.codegen_ipgen">src.finn.transformation.fpgadataflow.codegen_ipgen module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.codegen_ipstitch">src.finn.transformation.fpgadataflow.codegen_ipstitch module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.codegen_npysim">src.finn.transformation.fpgadataflow.codegen_npysim module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.compile">src.finn.transformation.fpgadataflow.compile module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.convert_to_hls_layers">src.finn.transformation.fpgadataflow.convert_to_hls_layers module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.create_dataflow_partition">src.finn.transformation.fpgadataflow.create_dataflow_partition module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.hlssynth_ipgen">src.finn.transformation.fpgadataflow.hlssynth_ipgen module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.insert_tlastmarker">src.finn.transformation.fpgadataflow.insert_tlastmarker module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.make_deployment">src.finn.transformation.fpgadataflow.make_deployment module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.make_pynq_driver">src.finn.transformation.fpgadataflow.make_pynq_driver module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.make_pynq_proj">src.finn.transformation.fpgadataflow.make_pynq_proj module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.set_sim_mode">src.finn.transformation.fpgadataflow.set_sim_mode module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.synth_pynq_proj">src.finn.transformation.fpgadataflow.synth_pynq_proj module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow.templates">src.finn.transformation.fpgadataflow.templates module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.fpgadataflow.html#module-src.finn.transformation.fpgadataflow">Module contents</a></li> -</ul> -</li> -<li class="toctree-l5"><a class="reference internal" href="src.finn.transformation.streamline.html">src.finn.transformation.streamline package</a><ul> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.streamline.html#submodules">Submodules</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline.absorb">src.finn.transformation.streamline.absorb module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline.collapse_repeated">src.finn.transformation.streamline.collapse_repeated module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline.reorder">src.finn.transformation.streamline.reorder module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline.round_thresholds">src.finn.transformation.streamline.round_thresholds module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline.sign_to_thres">src.finn.transformation.streamline.sign_to_thres module</a></li> -<li class="toctree-l6"><a class="reference internal" href="src.finn.transformation.streamline.html#module-src.finn.transformation.streamline">Module contents</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.html#module-src.finn.transformation.batchnorm_to_affine">src.finn.transformation.batchnorm_to_affine module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.html#module-src.finn.transformation.bipolar_to_xnor">src.finn.transformation.bipolar_to_xnor module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.html#module-src.finn.transformation.fold_constants">src.finn.transformation.fold_constants module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.html#module-src.finn.transformation.general">src.finn.transformation.general module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.html#module-src.finn.transformation.infer_datatypes">src.finn.transformation.infer_datatypes module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.html#module-src.finn.transformation.infer_shapes">src.finn.transformation.infer_shapes module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.transformation.html#module-src.finn.transformation">Module contents</a><ul> -<li class="toctree-l5"><a class="reference internal" href="src.finn.transformation.html#guide-to-writing-finn-transformations">Guide to writing FINN transformations</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l3"><a class="reference internal" href="src.finn.util.html">src.finn.util package</a><ul> -<li class="toctree-l4"><a class="reference internal" href="src.finn.util.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.util.html#module-src.finn.util.basic">src.finn.util.basic module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.util.html#module-src.finn.util.data_packing">src.finn.util.data_packing module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.util.html#module-src.finn.util.fpgadataflow">src.finn.util.fpgadataflow module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.util.html#module-src.finn.util.onnx">src.finn.util.onnx module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.util.html#module-src.finn.util.test">src.finn.util.test module</a></li> -<li class="toctree-l4"><a class="reference internal" href="src.finn.util.html#module-src.finn.util">Module contents</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="src.finn.html#module-src.finn">Module contents</a></li> -</ul> -</li> -</ul> -</div> -</div> -<div class="section" id="module-src"> -<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-src" title="Permalink to this headline">¶</a></h2> -</div> -</div> - - - </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index.html">FINN</a></h1> - - - - - - - - -<h3>Navigation</h3> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index.html">Documentation overview</a><ul> - </ul></li> -</ul> -</div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" /> - <input type="submit" value="Go" /> - </form> - </div> -</div> -<script type="text/javascript">$('#searchbox').show(0);</script> - - - - - - - - - </div> - </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2020, Y. Umuroglu, J. Petri-Koenig. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> - - | - <a href="_sources/src.rst.txt" - rel="nofollow">Page source</a> - </div> - - - - - </body> -</html> \ No newline at end of file diff --git a/docs/finn/modules.rst b/docs/finn/modules.rst index e9ff8ac1a89c7bd18e69d633121f5a4022ac6fdf..8355e03eefd869e41e11291dfcafb540e93d1b21 100644 --- a/docs/finn/modules.rst +++ b/docs/finn/modules.rst @@ -1,7 +1,7 @@ -src +finn === .. toctree:: :maxdepth: 4 - src + finn