diff --git a/docs/finn/_build/doctrees/environment.pickle b/docs/finn/_build/doctrees/environment.pickle index 308b1065423e8dad87e585ffc1778c06a0b2718d..3c761e8ff31cba2be3dd8edd2a14773c03beef36 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/source_code/finn.analysis.doctree b/docs/finn/_build/doctrees/source_code/finn.analysis.doctree index 5b78d4a9400210bebe1e8d3ffb1cf0c58cde3ae9..7f88373377a4fbc03f33b3ce9b3c0e2f3c9ec355 100644 Binary files a/docs/finn/_build/doctrees/source_code/finn.analysis.doctree and b/docs/finn/_build/doctrees/source_code/finn.analysis.doctree differ diff --git a/docs/finn/_build/doctrees/source_code/finn.analysis.fpgadataflow.doctree b/docs/finn/_build/doctrees/source_code/finn.analysis.fpgadataflow.doctree index cf4f42a3ff0da4b19a0cd112d9d7051650e47744..7146b0ef06b6bab62c68008c3f08f7bb43f520e4 100644 Binary files a/docs/finn/_build/doctrees/source_code/finn.analysis.fpgadataflow.doctree and b/docs/finn/_build/doctrees/source_code/finn.analysis.fpgadataflow.doctree differ diff --git a/docs/finn/_build/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 new file mode 100644 index 0000000000000000000000000000000000000000..d2a9383f4aadf300d64d26b7d54850798cdf74f6 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..8b1fa4f0540c52d0bbbb4d5e7cb4a5923acf7d64 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.analysis.fpgadataflow.res_estimation.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..451f72dee0acfd8238d8ab0bc0cfe36bdd8f955d Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.analysis.topology.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..b8b840f01e19afe06f90d50f68fb939bdf400311 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.analysis.verify_custom_nodes.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..e2576c7df3a7905e05ad1e9dd13a228f05b6eaff Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.core.datatype.doctree differ diff --git a/docs/finn/_build/doctrees/source_code/finn.core.doctree b/docs/finn/_build/doctrees/source_code/finn.core.doctree index 515b78771ea6d47c72f723398dfa31aaad4f25f4..9fed3972759b5f7fc14e5769d93ac1d88ca55d79 100644 Binary files a/docs/finn/_build/doctrees/source_code/finn.core.doctree and b/docs/finn/_build/doctrees/source_code/finn.core.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..ab4f77e7bdba1d31b3967260f86eeb114389c2cc Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.core.execute_custom_node.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..3384f0c4528f2bc42bcb9c27884ac86ad9753563 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.core.modelwrapper.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..7529c89d10f492df2d88b0823fb81557dcfc3ac1 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.core.onnx_exec.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..8b4675413117862af218c9588e64c4cacc682b0a Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.core.remote_exec.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..44778b6af972760799db23060282fde4f910b0ff Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.core.rtlsim_exec.doctree differ diff --git a/docs/finn/_build/doctrees/source_code/finn.custom_op.doctree b/docs/finn/_build/doctrees/source_code/finn.custom_op.doctree index c28b05b9f09f01e8bc7bb0b0828224caafc9d9b4..18f4422ecf11f4fbb86597f46bd8752726432d0b 100644 Binary files a/docs/finn/_build/doctrees/source_code/finn.custom_op.doctree and b/docs/finn/_build/doctrees/source_code/finn.custom_op.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..44a33132d6edf7bc09b33711106b98799d663884 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.doctree differ diff --git a/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.doctree b/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.doctree index 87980c4e555347115205ca81c434b5863b6ff31e..d39d8db86aa9882418fc1cde01329a8be3e575f2 100644 Binary files a/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.doctree and b/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..f592107cc5cd75a779aea4343ab1b18dea38adef Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..12982cc9549116a8f4d603bfecbfe604ca7f34f9 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..d06fe5a5e4013093e7488b6f0b88bad5964e98d2 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.templates.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..6bb7fdef37d72c0b9e21f1888ea0111464485aa2 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.custom_op.fpgadataflow.tlastmarker.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..40ce00f406b1ace0c7141edf75bef5d70f19a98d Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.custom_op.multithreshold.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..676dad32797a5f4c4e6470db2bedbcc5d1bf17b3 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.custom_op.registry.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..93ddbfe4aa871e46574ad732284f5f85b4807004 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.custom_op.streamingdataflowpartition.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..5c1950c03f6c89f0c0d5dffbfa42e1f47e50b7b6 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.custom_op.xnorpopcount.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..7e7c0e91d44c7655c96717fddf955046b3f2799c Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.batchnorm_to_affine.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..7ab9e0301f6adb07765038346c29882bcb5cd984 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.bipolar_to_xnor.doctree differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.doctree index 8517257fd55c81aa3df449dba743af1678a13412..213c8c2d329eed44a0a4e18a09075e624af1c7d0 100644 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.doctree and b/docs/finn/_build/doctrees/source_code/finn.transformation.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..e663ce9c4f22c0e6f2aebca1088d4103a0c7099d Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.fold_constants.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..a12493641d50d9f0b593ce4914f0cf51721c0741 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.cleanup.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..8fc625699983bdcacf2e12e8bd355053b8403f88 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.codegen_ipgen.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..2d494a41e94b0710566eeb47f1f841443eb5bc97 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.codegen_ipstitch.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..8ed36707c989351fed68500d6d91ee4f8220bbcd Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.codegen_npysim.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..0a36c583dcb1c37f59ea28c0b6441ead5530b772 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.compile.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..a446704bded33ea28f6691f1a5ce8e403588ee07 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..20f73c1d9fa5890a1e2ad6ec86976541fa6b41e9 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.create_dataflow_partition.doctree differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.doctree index 007833da517e60e7ecb71f43079e149b5313b613..3cee997c43a9cbdfc9e2df405a01c486a45bb496 100644 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.doctree and b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..951f6fc94b4d18d3136b01ee1f84d020df532ce6 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..632480f19e3c8921ffb158802af93470ad598bb4 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.insert_tlastmarker.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..a315244a5c8af11290208dec82478dca3c8fe7a3 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.make_deployment.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..b6f2de2cf25f5ddb97534175854c6acf52b6dd41 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.make_pynq_driver.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..3b94d08ece6af841e15988b51c2da034e9d8b6fc Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.make_pynq_proj.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..962143668310625211d3e74e9be3e477931ddd1b Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.set_exec_mode.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..ee626d0580922430bd18d3ef81be3e01b21cdb21 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.synth_pynq_proj.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..3038d1db11c2f71dff096f655ef04f73ed291ca4 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.fpgadataflow.templates.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..4ed74a955612d2ecd9dd00f9ee199ec6f8e1a52c Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.general.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..3984b1d7dee35f0a18c0f11e9f01abd61bd841a5 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.infer_datatypes.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..5b8271a7ccba07b43a16552a53fac02b4bd8fe61 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.infer_shapes.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..488afd58674e2e6f64da237ed04804c455031f61 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.absorb.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..c19ec7207840b8eef6b2f951cb4741bc6856c3c2 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.collapse_repeated.doctree differ diff --git a/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.doctree b/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.doctree index 16323c25503426bed5e883cbdf7cd6cf657775df..60e87ad37806cb3e698eb0d0b865097f8b189d0c 100644 Binary files a/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.doctree and b/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..df8d05d07f42fc84427bd2f4d63990f62a8f54cf Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.reorder.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..1537b4cb415757c59fe4338f65e70047ef8beab6 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.round_thresholds.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..ce0eb33fb3b5c5388f054220d7d603ee61f2ca8f Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.transformation.streamline.sign_to_thres.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..c8ace62eeb3bc4308309de16cc3a2c5464b90c88 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.util.basic.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..c8e2f92b5f73be87502a77d68d501cf92f84d119 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.util.data_packing.doctree differ diff --git a/docs/finn/_build/doctrees/source_code/finn.util.doctree b/docs/finn/_build/doctrees/source_code/finn.util.doctree index c76b2a37e1d3837d081201ec157666d46962daa1..132a89add156203d522ad64e7a3412346728bd79 100644 Binary files a/docs/finn/_build/doctrees/source_code/finn.util.doctree and b/docs/finn/_build/doctrees/source_code/finn.util.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..d73ae460387d36d94911508713eb9c2e2a2b5edc Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.util.fpgadataflow.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..37b1cca4b5168af822e2985137bca78351fa4673 Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.util.onnx.doctree 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 new file mode 100644 index 0000000000000000000000000000000000000000..e60811840536576a89d784df9e24289cb5cba6ac Binary files /dev/null and b/docs/finn/_build/doctrees/source_code/finn.util.test.doctree differ 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 new file mode 100644 index 0000000000000000000000000000000000000000..616064c16dfb61e9d66d7a8f9e76addd48e93ef9 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..eb5b773b123cc686116313d1043b668601fc229f --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.analysis.fpgadataflow.res_estimation.rst.txt @@ -0,0 +1,7 @@ +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.fpgadataflow.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.analysis.fpgadataflow.rst.txt index cd8075d753f617f4e97a851e9b54139c966a18b2..4f5cd7cbbf2ab61770ab519e287e884f839ba2c0 100644 --- a/docs/finn/_build/html/_sources/source_code/finn.analysis.fpgadataflow.rst.txt +++ b/docs/finn/_build/html/_sources/source_code/finn.analysis.fpgadataflow.rst.txt @@ -4,22 +4,10 @@ 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: +.. toctree:: + finn.analysis.fpgadataflow.hls_synth_res_estimation + finn.analysis.fpgadataflow.res_estimation Module contents --------------- diff --git a/docs/finn/_build/html/_sources/source_code/finn.analysis.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.analysis.rst.txt index e4eec7717a1119de8ef5381b67361973a9ac29c5..0799598595ff5f01dc23543bb5de9a14b3d8b863 100644 --- a/docs/finn/_build/html/_sources/source_code/finn.analysis.rst.txt +++ b/docs/finn/_build/html/_sources/source_code/finn.analysis.rst.txt @@ -11,22 +11,10 @@ Subpackages 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: +.. toctree:: + finn.analysis.topology + finn.analysis.verify_custom_nodes Module contents --------------- 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 new file mode 100644 index 0000000000000000000000000000000000000000..896f3fb8d704c23a58f10f9513fd00ca7f7b99b0 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.analysis.topology.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..60e1a33e25e6f8751aadd3e0181225af6e24e779 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.analysis.verify_custom_nodes.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..d55952ecf81556365510a3191f2b2a75a6873f72 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.core.datatype.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..94d8ea143fadf32caf874036d6f652de9561bc1f --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.core.execute_custom_node.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..5bd74864ba63eda5b8a03093d02a6c54dabda973 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.core.modelwrapper.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..87bf9d29dcf450d92529ce7987df8f59832ddd1a --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.core.onnx_exec.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..39c470eb0e4cc32c4d604dc3df7a7c9a51532d27 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.core.remote_exec.rst.txt @@ -0,0 +1,7 @@ +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.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.core.rst.txt index 6563d7a4342048e37e4eac5da6b47cf9798cdd73..acb9de8a753c6269411e35d45621c84f2ff4e0bc 100644 --- a/docs/finn/_build/html/_sources/source_code/finn.core.rst.txt +++ b/docs/finn/_build/html/_sources/source_code/finn.core.rst.txt @@ -4,54 +4,14 @@ 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: - -finn.core.remote\_exec module ------------------------------ - -.. automodule:: finn.core.remote_exec - :members: - :undoc-members: - :show-inheritance: - -finn.core.rtlsim\_exec module ------------------------------ - -.. automodule:: finn.core.rtlsim_exec - :members: - :undoc-members: - :show-inheritance: - +.. toctree:: + + finn.core.datatype + finn.core.execute_custom_node + finn.core.modelwrapper + finn.core.onnx_exec + finn.core.remote_exec + finn.core.rtlsim_exec Module contents --------------- 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 new file mode 100644 index 0000000000000000000000000000000000000000..9d4acef6e8a61b537280ab441d7bb0bbf48158cf --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.core.rtlsim_exec.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..aa36e86ee210e242ae7fd3e8447bb23663a7eb2c --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.rst.txt @@ -0,0 +1,7 @@ +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.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.rst.txt index 632c021beb247e077f87c5af68d62bc51f88ecdc..79a05080b620797c79c6c7624a19010dbe3230d8 100644 --- a/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.rst.txt +++ b/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.rst.txt @@ -4,46 +4,13 @@ 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: +.. toctree:: + finn.custom_op.fpgadataflow.convolutioninputgenerator + finn.custom_op.fpgadataflow.streamingfclayer_batch + finn.custom_op.fpgadataflow.streamingmaxpool_batch + finn.custom_op.fpgadataflow.templates + finn.custom_op.fpgadataflow.tlastmarker Module contents --------------- 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 new file mode 100644 index 0000000000000000000000000000000000000000..45a9a963a5a36e5152ff77dbe6b8ec08b1f60611 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..5bf7f666a42188a8a0e6ae2369d94fe2881694e9 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..a630867a416a59c0d9b789289b48a930c6aca253 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.templates.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..8a087851c655080c70b434028fdae4315bd69f57 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.custom_op.fpgadataflow.tlastmarker.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..3cdf3cee7259a98c3e9bc95d2b1833a03fcfad98 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.custom_op.multithreshold.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..7805e833b8d19b4a99de2466ce164e81911c179c --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.custom_op.registry.rst.txt @@ -0,0 +1,7 @@ +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.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.custom_op.rst.txt index a984822aee2962c945a66deb50a3fd1233d5d2d0..fd2f070f2add73b0e28fc030ec2e2cab14d2c112 100644 --- a/docs/finn/_build/html/_sources/source_code/finn.custom_op.rst.txt +++ b/docs/finn/_build/html/_sources/source_code/finn.custom_op.rst.txt @@ -11,38 +11,12 @@ Subpackages 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: +.. toctree:: + finn.custom_op.multithreshold + finn.custom_op.registry + finn.custom_op.streamingdataflowpartition + finn.custom_op.xnorpopcount Module contents --------------- 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 new file mode 100644 index 0000000000000000000000000000000000000000..1d07f01ce187842777676949195765bd7f841e6e --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.custom_op.streamingdataflowpartition.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..d916082782081f7ef2fb3fe02070abf4baf8e03f --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.custom_op.xnorpopcount.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..8d0ecfb75c7c6af460ff7d96a1dd45d008bc50ef --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.batchnorm_to_affine.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..dc34f4def8d87339c3dc6d6a69ea97238f449ecd --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.bipolar_to_xnor.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..792f8bfe03d04735c9571a8016ecc941a88ffd25 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.fold_constants.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..38cc49897e6d52dfdc8e4c4694458ff3df81e6f1 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.cleanup.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..158ad7602cfa17fe3c6c1e0232b46d6a0c1743ce --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.codegen_ipgen.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..d3f7434e3b02759206119ee08591a7494e7307ad --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.codegen_ipstitch.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..28796da29a9f01ba47d2c5236db01f639f653d3b --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.codegen_npysim.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..3d36a046be002093b813b0b97539b869f115ba77 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.compile.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..0ae11a41bf3e3720fa97dfda2406af9ce67327a8 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..4827fd5b2cc335fba321835f472da6dfd1e821af --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.create_dataflow_partition.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..47af9049f0f77e66343868d877ab43d6a03ef299 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..d4bd00b8c3e3467df421f0efb9fd993851d5e44d --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.insert_tlastmarker.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..130c91989090a9b1d73d12e413227c8008161930 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.make_deployment.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..5238f08460a4ff9580273891461e2a3409605834 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.make_pynq_driver.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..1d040887f9a2ab2d33bf4ff9ea69ac835cbba8a7 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.make_pynq_proj.rst.txt @@ -0,0 +1,7 @@ +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.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.rst.txt index 435eacf2c4684a3fc9a855f4eee153cb52ea7772..f99673391cc42d9724eb5e584f910b9aa36721c3 100644 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.rst.txt +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.rst.txt @@ -4,126 +4,23 @@ 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\_exec\_mode module -------------------------------------------------------- - -.. automodule:: finn.transformation.fpgadataflow.set_exec_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: - +.. toctree:: + + finn.transformation.fpgadataflow.cleanup + finn.transformation.fpgadataflow.codegen_ipgen + finn.transformation.fpgadataflow.codegen_ipstitch + finn.transformation.fpgadataflow.codegen_npysim + finn.transformation.fpgadataflow.compile + finn.transformation.fpgadataflow.convert_to_hls_layers + finn.transformation.fpgadataflow.create_dataflow_partition + finn.transformation.fpgadataflow.hlssynth_ipgen + finn.transformation.fpgadataflow.insert_tlastmarker + finn.transformation.fpgadataflow.make_deployment + finn.transformation.fpgadataflow.make_pynq_driver + finn.transformation.fpgadataflow.make_pynq_proj + finn.transformation.fpgadataflow.set_exec_mode + finn.transformation.fpgadataflow.synth_pynq_proj + finn.transformation.fpgadataflow.templates Module contents --------------- 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 new file mode 100644 index 0000000000000000000000000000000000000000..7affa78b43e253b781deffce3044d9ca46319b96 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.set_exec_mode.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..e902991a6920a7bf4617814df95ced28a7cd268c --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.synth_pynq_proj.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..a62f377830c8661f9a7f106e19d3c203a8019d81 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.fpgadataflow.templates.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..bfae28100b9e91d5b1d0b728d410a6ec472bc4d4 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.general.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..939d1552157f21b451f4b583ade611b3ae41ab5d --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.infer_datatypes.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..9469557061e450ba356c96f615a1f438be878047 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.infer_shapes.rst.txt @@ -0,0 +1,7 @@ +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.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.rst.txt index 172f6e300f3894dba3b13355120bcb4e23d737e1..da9618ed64e7dbe73ecb376ae9c3faa5992f4f31 100644 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.rst.txt +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.rst.txt @@ -12,54 +12,14 @@ Subpackages 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: +.. toctree:: + finn.transformation.batchnorm_to_affine + finn.transformation.bipolar_to_xnor + finn.transformation.fold_constants + finn.transformation.general + finn.transformation.infer_datatypes + finn.transformation.infer_shapes Module contents --------------- 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 new file mode 100644 index 0000000000000000000000000000000000000000..597a98944b984b1c51b978f8986e300369b533cd --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.absorb.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..a15f72aea74e99f5beef9109f06e2afa38de6619 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.collapse_repeated.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..ac969e1329f444f48df00f7101b5cd1e3da5c363 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.reorder.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..031c65d077f63a3f120211e2ab122c291c5a96e1 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.round_thresholds.rst.txt @@ -0,0 +1,7 @@ +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.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.rst.txt index 33e5930952e01881dfb7e1b19eae11ebc25ac4e0..5b3a88384a38950fb6aa4084093181650319bd27 100644 --- a/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.rst.txt +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.rst.txt @@ -4,46 +4,13 @@ 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: +.. toctree:: + finn.transformation.streamline.absorb + finn.transformation.streamline.collapse_repeated + finn.transformation.streamline.reorder + finn.transformation.streamline.round_thresholds + finn.transformation.streamline.sign_to_thres Module contents --------------- 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 new file mode 100644 index 0000000000000000000000000000000000000000..166717eb352ed0044ad817dc36409a1860f3789c --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.transformation.streamline.sign_to_thres.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..10e8e1ac1c9e9f7f449ce8f3a413424c529b3fa1 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.util.basic.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..6a39cc14b157646fc5305674a18b250d4a0b0946 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.util.data_packing.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..3472ed477b9680baa99a91ce70850bedc79daf6b --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.util.fpgadataflow.rst.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000000000000000000000000000000000000..057cb07cadcaf5819b21bb61878b0964eecbdace --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.util.onnx.rst.txt @@ -0,0 +1,7 @@ +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.rst.txt b/docs/finn/_build/html/_sources/source_code/finn.util.rst.txt index 1c85bcd44b63343ecab12ee12ba82c83d4fc984d..c66d189b3ae0c79b9890cf9b4885916a06f4768c 100644 --- a/docs/finn/_build/html/_sources/source_code/finn.util.rst.txt +++ b/docs/finn/_build/html/_sources/source_code/finn.util.rst.txt @@ -4,46 +4,13 @@ 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: +.. toctree:: + finn.util.basic + finn.util.data_packing + finn.util.fpgadataflow + finn.util.onnx + finn.util.test Module contents --------------- 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 new file mode 100644 index 0000000000000000000000000000000000000000..3fe1bc15e529a36546a589b0b43f26dee58b4511 --- /dev/null +++ b/docs/finn/_build/html/_sources/source_code/finn.util.test.rst.txt @@ -0,0 +1,7 @@ +finn.util.test module +===================== + +.. automodule:: finn.util.test + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/_build/html/genindex.html b/docs/finn/_build/html/genindex.html index e6f72ed0b258e003afdd05b4eb8d6ee2cf3adf8c..3de73522512aeff4f7ae7edc13ec4329c2a896d4 100644 --- a/docs/finn/_build/html/genindex.html +++ b/docs/finn/_build/html/genindex.html @@ -173,90 +173,90 @@ <h2 id="A">A</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul">Absorb1BitMulIntoMatMul (class in finn.transformation.streamline.absorb)</a> + <li><a href="source_code/finn.transformation.streamline.absorb.html#finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul">Absorb1BitMulIntoMatMul (class in finn.transformation.streamline.absorb)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold">AbsorbAddIntoMultiThreshold (class in finn.transformation.streamline.absorb)</a> + <li><a href="source_code/finn.transformation.streamline.absorb.html#finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold">AbsorbAddIntoMultiThreshold (class in finn.transformation.streamline.absorb)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold">AbsorbMulIntoMultiThreshold (class in finn.transformation.streamline.absorb)</a> + <li><a href="source_code/finn.transformation.streamline.absorb.html#finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold">AbsorbMulIntoMultiThreshold (class in finn.transformation.streamline.absorb)</a> </li> - <li><a href="source_code/finn.analysis.html#finn.analysis.topology.all_tensors_f32">all_tensors_f32() (in module finn.analysis.topology)</a> + <li><a href="source_code/finn.analysis.topology.html#finn.analysis.topology.all_tensors_f32">all_tensors_f32() (in module finn.analysis.topology)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.allowed">allowed() (finn.core.datatype.DataType method)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.allowed">allowed() (finn.core.datatype.DataType method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.analysis">analysis() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.analysis">analysis() (finn.core.modelwrapper.ModelWrapper method)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.basic.CppBuilder.append_includes">append_includes() (finn.util.basic.CppBuilder method)</a> + <li><a href="source_code/finn.util.basic.html#finn.util.basic.CppBuilder.append_includes">append_includes() (finn.util.basic.CppBuilder method)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.basic.CppBuilder.append_sources">append_sources() (finn.util.basic.CppBuilder method)</a> + <li><a href="source_code/finn.util.basic.html#finn.util.basic.CppBuilder.append_sources">append_sources() (finn.util.basic.CppBuilder method)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.fpgadataflow.IPGenBuilder.append_tcl">append_tcl() (finn.util.fpgadataflow.IPGenBuilder method)</a> + <li><a href="source_code/finn.util.fpgadataflow.html#finn.util.fpgadataflow.IPGenBuilder.append_tcl">append_tcl() (finn.util.fpgadataflow.IPGenBuilder method)</a> </li> - <li><a href="source_code/finn.transformation.html#finn.transformation.batchnorm_to_affine.BatchNormToAffine.apply">apply() (finn.transformation.batchnorm_to_affine.BatchNormToAffine method)</a> + <li><a href="source_code/finn.transformation.batchnorm_to_affine.html#finn.transformation.batchnorm_to_affine.BatchNormToAffine.apply">apply() (finn.transformation.batchnorm_to_affine.BatchNormToAffine method)</a> <ul> - <li><a href="source_code/finn.transformation.html#finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount.apply">(finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount method)</a> + <li><a href="source_code/finn.transformation.bipolar_to_xnor.html#finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount.apply">(finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount method)</a> </li> - <li><a href="source_code/finn.transformation.html#finn.transformation.fold_constants.FoldConstants.apply">(finn.transformation.fold_constants.FoldConstants method)</a> + <li><a href="source_code/finn.transformation.fold_constants.html#finn.transformation.fold_constants.FoldConstants.apply">(finn.transformation.fold_constants.FoldConstants method)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.cleanup.CleanUp.apply">(finn.transformation.fpgadataflow.cleanup.CleanUp method)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.cleanup.html#finn.transformation.fpgadataflow.cleanup.CleanUp.apply">(finn.transformation.fpgadataflow.cleanup.CleanUp method)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen.apply">(finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen method)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.codegen_ipgen.html#finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen.apply">(finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen method)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch.apply">(finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch method)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.codegen_ipstitch.html#finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch.apply">(finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch method)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim.apply">(finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim method)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.codegen_npysim.html#finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim.apply">(finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim method)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.compile.Compile.apply">(finn.transformation.fpgadataflow.compile.Compile method)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.compile.html#finn.transformation.fpgadataflow.compile.Compile.apply">(finn.transformation.fpgadataflow.compile.Compile method)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer.apply">(finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer method)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.html#finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer.apply">(finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer method)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition.apply">(finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition method)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.create_dataflow_partition.html#finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition.apply">(finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition method)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen.apply">(finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen method)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.html#finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen.apply">(finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen method)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker.apply">(finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker method)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.insert_tlastmarker.html#finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker.apply">(finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker method)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ.apply">(finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ method)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.make_deployment.html#finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ.apply">(finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ method)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver.apply">(finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver method)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.make_pynq_driver.html#finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver.apply">(finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver method)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject.apply">(finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject method)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.make_pynq_proj.html#finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject.apply">(finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject method)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.set_exec_mode.SetExecMode.apply">(finn.transformation.fpgadataflow.set_exec_mode.SetExecMode method)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.set_exec_mode.html#finn.transformation.fpgadataflow.set_exec_mode.SetExecMode.apply">(finn.transformation.fpgadataflow.set_exec_mode.SetExecMode method)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject.apply">(finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject method)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.synth_pynq_proj.html#finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject.apply">(finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject method)</a> </li> - <li><a href="source_code/finn.transformation.html#finn.transformation.general.ConvertSubToAdd.apply">(finn.transformation.general.ConvertSubToAdd method)</a> + <li><a href="source_code/finn.transformation.general.html#finn.transformation.general.ConvertSubToAdd.apply">(finn.transformation.general.ConvertSubToAdd method)</a> </li> - <li><a href="source_code/finn.transformation.html#finn.transformation.general.GiveRandomTensorNames.apply">(finn.transformation.general.GiveRandomTensorNames method)</a> + <li><a href="source_code/finn.transformation.general.html#finn.transformation.general.GiveRandomTensorNames.apply">(finn.transformation.general.GiveRandomTensorNames method)</a> </li> - <li><a href="source_code/finn.transformation.html#finn.transformation.general.GiveReadableTensorNames.apply">(finn.transformation.general.GiveReadableTensorNames method)</a> + <li><a href="source_code/finn.transformation.general.html#finn.transformation.general.GiveReadableTensorNames.apply">(finn.transformation.general.GiveReadableTensorNames method)</a> </li> - <li><a href="source_code/finn.transformation.html#finn.transformation.general.GiveUniqueNodeNames.apply">(finn.transformation.general.GiveUniqueNodeNames method)</a> + <li><a href="source_code/finn.transformation.general.html#finn.transformation.general.GiveUniqueNodeNames.apply">(finn.transformation.general.GiveUniqueNodeNames method)</a> </li> - <li><a href="source_code/finn.transformation.html#finn.transformation.infer_datatypes.InferDataTypes.apply">(finn.transformation.infer_datatypes.InferDataTypes method)</a> + <li><a href="source_code/finn.transformation.infer_datatypes.html#finn.transformation.infer_datatypes.InferDataTypes.apply">(finn.transformation.infer_datatypes.InferDataTypes method)</a> </li> - <li><a href="source_code/finn.transformation.html#finn.transformation.infer_shapes.InferShapes.apply">(finn.transformation.infer_shapes.InferShapes method)</a> + <li><a href="source_code/finn.transformation.infer_shapes.html#finn.transformation.infer_shapes.InferShapes.apply">(finn.transformation.infer_shapes.InferShapes method)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul.apply">(finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul method)</a> + <li><a href="source_code/finn.transformation.streamline.absorb.html#finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul.apply">(finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul method)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold.apply">(finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold method)</a> + <li><a href="source_code/finn.transformation.streamline.absorb.html#finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold.apply">(finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold method)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold.apply">(finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold method)</a> + <li><a href="source_code/finn.transformation.streamline.absorb.html#finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold.apply">(finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold method)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.absorb.FactorOutMulSignMagnitude.apply">(finn.transformation.streamline.absorb.FactorOutMulSignMagnitude method)</a> + <li><a href="source_code/finn.transformation.streamline.absorb.html#finn.transformation.streamline.absorb.FactorOutMulSignMagnitude.apply">(finn.transformation.streamline.absorb.FactorOutMulSignMagnitude method)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp.apply">(finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp method)</a> + <li><a href="source_code/finn.transformation.streamline.collapse_repeated.html#finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp.apply">(finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp method)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.reorder.MoveAddPastMul.apply">(finn.transformation.streamline.reorder.MoveAddPastMul method)</a> + <li><a href="source_code/finn.transformation.streamline.reorder.html#finn.transformation.streamline.reorder.MoveAddPastMul.apply">(finn.transformation.streamline.reorder.MoveAddPastMul method)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.reorder.MoveScalarAddPastMatMul.apply">(finn.transformation.streamline.reorder.MoveScalarAddPastMatMul method)</a> + <li><a href="source_code/finn.transformation.streamline.reorder.html#finn.transformation.streamline.reorder.MoveScalarAddPastMatMul.apply">(finn.transformation.streamline.reorder.MoveScalarAddPastMatMul method)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.reorder.MoveScalarMulPastMatMul.apply">(finn.transformation.streamline.reorder.MoveScalarMulPastMatMul method)</a> + <li><a href="source_code/finn.transformation.streamline.reorder.html#finn.transformation.streamline.reorder.MoveScalarMulPastMatMul.apply">(finn.transformation.streamline.reorder.MoveScalarMulPastMatMul method)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.round_thresholds.RoundAndClipThresholds.apply">(finn.transformation.streamline.round_thresholds.RoundAndClipThresholds method)</a> + <li><a href="source_code/finn.transformation.streamline.round_thresholds.html#finn.transformation.streamline.round_thresholds.RoundAndClipThresholds.apply">(finn.transformation.streamline.round_thresholds.RoundAndClipThresholds method)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.sign_to_thres.ConvertSignToThres.apply">(finn.transformation.streamline.sign_to_thres.ConvertSignToThres method)</a> + <li><a href="source_code/finn.transformation.streamline.sign_to_thres.html#finn.transformation.streamline.sign_to_thres.ConvertSignToThres.apply">(finn.transformation.streamline.sign_to_thres.ConvertSignToThres method)</a> </li> <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.Streamline.apply">(finn.transformation.streamline.Streamline method)</a> </li> @@ -265,7 +265,7 @@ </ul></li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.util.html#finn.util.data_packing.array2hexstring">array2hexstring() (in module finn.util.data_packing)</a> + <li><a href="source_code/finn.util.data_packing.html#finn.util.data_packing.array2hexstring">array2hexstring() (in module finn.util.data_packing)</a> </li> </ul></td> </tr></table> @@ -273,42 +273,42 @@ <h2 id="B">B</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.transformation.html#finn.transformation.batchnorm_to_affine.BatchNormToAffine">BatchNormToAffine (class in finn.transformation.batchnorm_to_affine)</a> + <li><a href="source_code/finn.transformation.batchnorm_to_affine.html#finn.transformation.batchnorm_to_affine.BatchNormToAffine">BatchNormToAffine (class in finn.transformation.batchnorm_to_affine)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.BINARY">BINARY (finn.core.datatype.DataType attribute)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.BINARY">BINARY (finn.core.datatype.DataType attribute)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.BIPOLAR">BIPOLAR (finn.core.datatype.DataType attribute)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.BIPOLAR">BIPOLAR (finn.core.datatype.DataType attribute)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.bitwidth">bitwidth() (finn.core.datatype.DataType method)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.bitwidth">bitwidth() (finn.core.datatype.DataType method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.blackboxfunction">blackboxfunction() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.blackboxfunction">blackboxfunction() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> <ul> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.blackboxfunction">(finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.blackboxfunction">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.blackboxfunction">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.blackboxfunction">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.blackboxfunction">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.blackboxfunction">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.blackboxfunction">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> </ul></li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.bram_estimation">bram_estimation() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.bram_estimation">bram_estimation() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> <ul> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.bram_estimation">(finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.bram_estimation">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.bram_estimation">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.bram_estimation">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.bram_estimation">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> </li> </ul></li> - <li><a href="source_code/finn.util.html#finn.util.basic.CppBuilder.build">build() (finn.util.basic.CppBuilder method)</a> + <li><a href="source_code/finn.util.basic.html#finn.util.basic.CppBuilder.build">build() (finn.util.basic.CppBuilder method)</a> <ul> - <li><a href="source_code/finn.util.html#finn.util.fpgadataflow.IPGenBuilder.build">(finn.util.fpgadataflow.IPGenBuilder method)</a> + <li><a href="source_code/finn.util.fpgadataflow.html#finn.util.fpgadataflow.IPGenBuilder.build">(finn.util.fpgadataflow.IPGenBuilder method)</a> </li> </ul></li> </ul></td> @@ -317,55 +317,55 @@ <h2 id="C">C</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.calc_tmem">calc_tmem() (finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.calc_tmem">calc_tmem() (finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.calc_wmem">calc_wmem() (finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.calc_wmem">calc_wmem() (finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.basic.calculate_signed_dot_prod_range">calculate_signed_dot_prod_range() (in module finn.util.basic)</a> + <li><a href="source_code/finn.util.basic.html#finn.util.basic.calculate_signed_dot_prod_range">calculate_signed_dot_prod_range() (in module finn.util.basic)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.check_all_tensor_shapes_specified">check_all_tensor_shapes_specified() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.check_all_tensor_shapes_specified">check_all_tensor_shapes_specified() (finn.core.modelwrapper.ModelWrapper method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.check_compatibility">check_compatibility() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.check_compatibility">check_compatibility() (finn.core.modelwrapper.ModelWrapper method)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.cleanup.CleanUp">CleanUp (class in finn.transformation.fpgadataflow.cleanup)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.cleanup.html#finn.transformation.fpgadataflow.cleanup.CleanUp">CleanUp (class in finn.transformation.fpgadataflow.cleanup)</a> </li> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.code_generation_ipgen">code_generation_ipgen() (finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.code_generation_npysim">code_generation_npysim() (finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen">CodeGen_ipgen (class in finn.transformation.fpgadataflow.codegen_ipgen)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.codegen_ipgen.html#finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen">CodeGen_ipgen (class in finn.transformation.fpgadataflow.codegen_ipgen)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch">CodeGen_ipstitch (class in finn.transformation.fpgadataflow.codegen_ipstitch)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.codegen_ipstitch.html#finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch">CodeGen_ipstitch (class in finn.transformation.fpgadataflow.codegen_ipstitch)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim">CodeGen_npysim (class in finn.transformation.fpgadataflow.codegen_npysim)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.codegen_npysim.html#finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim">CodeGen_npysim (class in finn.transformation.fpgadataflow.codegen_npysim)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.collapse_repeated.CollapseRepeatedAdd">CollapseRepeatedAdd (class in finn.transformation.streamline.collapse_repeated)</a> + <li><a href="source_code/finn.transformation.streamline.collapse_repeated.html#finn.transformation.streamline.collapse_repeated.CollapseRepeatedAdd">CollapseRepeatedAdd (class in finn.transformation.streamline.collapse_repeated)</a> </li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.collapse_repeated.CollapseRepeatedMul">CollapseRepeatedMul (class in finn.transformation.streamline.collapse_repeated)</a> + <li><a href="source_code/finn.transformation.streamline.collapse_repeated.html#finn.transformation.streamline.collapse_repeated.CollapseRepeatedMul">CollapseRepeatedMul (class in finn.transformation.streamline.collapse_repeated)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp">CollapseRepeatedOp (class in finn.transformation.streamline.collapse_repeated)</a> + <li><a href="source_code/finn.transformation.streamline.collapse_repeated.html#finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp">CollapseRepeatedOp (class in finn.transformation.streamline.collapse_repeated)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.multithreshold.compare">compare() (in module finn.custom_op.multithreshold)</a> + <li><a href="source_code/finn.custom_op.multithreshold.html#finn.custom_op.multithreshold.compare">compare() (in module finn.custom_op.multithreshold)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.onnx_exec.compare_execution">compare_execution() (in module finn.core.onnx_exec)</a> + <li><a href="source_code/finn.core.onnx_exec.html#finn.core.onnx_exec.compare_execution">compare_execution() (in module finn.core.onnx_exec)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.compile.Compile">Compile (class in finn.transformation.fpgadataflow.compile)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.compile.html#finn.transformation.fpgadataflow.compile.Compile">Compile (class in finn.transformation.fpgadataflow.compile)</a> </li> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.compile_singlenode_code">compile_singlenode_code() (finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.transformation.html#finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount">ConvertBipolarMatMulToXnorPopcount (class in finn.transformation.bipolar_to_xnor)</a> + <li><a href="source_code/finn.transformation.bipolar_to_xnor.html#finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount">ConvertBipolarMatMulToXnorPopcount (class in finn.transformation.bipolar_to_xnor)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.sign_to_thres.ConvertSignToThres">ConvertSignToThres (class in finn.transformation.streamline.sign_to_thres)</a> + <li><a href="source_code/finn.transformation.streamline.sign_to_thres.html#finn.transformation.streamline.sign_to_thres.ConvertSignToThres">ConvertSignToThres (class in finn.transformation.streamline.sign_to_thres)</a> </li> - <li><a href="source_code/finn.transformation.html#finn.transformation.general.ConvertSubToAdd">ConvertSubToAdd (class in finn.transformation.general)</a> + <li><a href="source_code/finn.transformation.general.html#finn.transformation.general.ConvertSubToAdd">ConvertSubToAdd (class in finn.transformation.general)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator">ConvolutionInputGenerator (class in finn.custom_op.fpgadataflow.convolutioninputgenerator)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator">ConvolutionInputGenerator (class in finn.custom_op.fpgadataflow.convolutioninputgenerator)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.basic.CppBuilder">CppBuilder (class in finn.util.basic)</a> + <li><a href="source_code/finn.util.basic.html#finn.util.basic.CppBuilder">CppBuilder (class in finn.util.basic)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition">CreateDataflowPartition (class in finn.transformation.fpgadataflow.create_dataflow_partition)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.create_dataflow_partition.html#finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition">CreateDataflowPartition (class in finn.transformation.fpgadataflow.create_dataflow_partition)</a> </li> <li><a href="source_code/finn.custom_op.html#finn.custom_op.CustomOp">CustomOp (class in finn.custom_op)</a> </li> @@ -375,46 +375,46 @@ <h2 id="D">D</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.dataoutstrm">dataoutstrm() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.dataoutstrm">dataoutstrm() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> <ul> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.dataoutstrm">(finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.dataoutstrm">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.dataoutstrm">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.dataoutstrm">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.dataoutstrm">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.dataoutstrm">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.dataoutstrm">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> </ul></li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType">DataType (class in finn.core.datatype)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType">DataType (class in finn.core.datatype)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.defines">defines() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.defines">defines() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> <ul> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.defines">(finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.defines">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.defines">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.defines">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.defines">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.defines">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.defines">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> </ul></li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ">DeployToPYNQ (class in finn.transformation.fpgadataflow.make_deployment)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.make_deployment.html#finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ">DeployToPYNQ (class in finn.transformation.fpgadataflow.make_deployment)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.docompute">docompute() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.docompute">docompute() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> <ul> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.docompute">(finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.docompute">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.docompute">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.docompute">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.docompute">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.docompute">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.docompute">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> </ul></li> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.dynamic_input_to_npy">dynamic_input_to_npy() (finn.custom_op.fpgadataflow.HLSCustomOp method)</a> @@ -427,33 +427,33 @@ <td style="width: 33%; vertical-align: top;"><ul> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.exec_precompiled_singlenode_model">exec_precompiled_singlenode_model() (finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.execute_custom_node.execute_custom_node">execute_custom_node() (in module finn.core.execute_custom_node)</a> + <li><a href="source_code/finn.core.execute_custom_node.html#finn.core.execute_custom_node.execute_custom_node">execute_custom_node() (in module finn.core.execute_custom_node)</a> </li> <li><a href="source_code/finn.custom_op.html#finn.custom_op.CustomOp.execute_node">execute_node() (finn.custom_op.CustomOp method)</a> <ul> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.execute_node">(finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.execute_node">(finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> </li> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.execute_node">(finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.execute_node">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.execute_node">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.execute_node">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.execute_node">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.multithreshold.MultiThreshold.execute_node">(finn.custom_op.multithreshold.MultiThreshold method)</a> + <li><a href="source_code/finn.custom_op.multithreshold.html#finn.custom_op.multithreshold.MultiThreshold.execute_node">(finn.custom_op.multithreshold.MultiThreshold method)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.execute_node">(finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition method)</a> + <li><a href="source_code/finn.custom_op.streamingdataflowpartition.html#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.execute_node">(finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition method)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.xnorpopcount.XnorPopcountMatMul.execute_node">(finn.custom_op.xnorpopcount.XnorPopcountMatMul method)</a> + <li><a href="source_code/finn.custom_op.xnorpopcount.html#finn.custom_op.xnorpopcount.XnorPopcountMatMul.execute_node">(finn.custom_op.xnorpopcount.XnorPopcountMatMul method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.onnx_exec.execute_node">(in module finn.core.onnx_exec)</a> + <li><a href="source_code/finn.core.onnx_exec.html#finn.core.onnx_exec.execute_node">(in module finn.core.onnx_exec)</a> </li> </ul></li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.core.html#finn.core.onnx_exec.execute_onnx">execute_onnx() (in module finn.core.onnx_exec)</a> + <li><a href="source_code/finn.core.onnx_exec.html#finn.core.onnx_exec.execute_onnx">execute_onnx() (in module finn.core.onnx_exec)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.onnx_exec.execute_onnx_and_make_model">execute_onnx_and_make_model() (in module finn.core.onnx_exec)</a> + <li><a href="source_code/finn.core.onnx_exec.html#finn.core.onnx_exec.execute_onnx_and_make_model">execute_onnx_and_make_model() (in module finn.core.onnx_exec)</a> </li> </ul></td> </tr></table> @@ -461,11 +461,11 @@ <h2 id="F">F</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.absorb.FactorOutMulSignMagnitude">FactorOutMulSignMagnitude (class in finn.transformation.streamline.absorb)</a> + <li><a href="source_code/finn.transformation.streamline.absorb.html#finn.transformation.streamline.absorb.FactorOutMulSignMagnitude">FactorOutMulSignMagnitude (class in finn.transformation.streamline.absorb)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.find_consumer">find_consumer() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.find_consumer">find_consumer() (finn.core.modelwrapper.ModelWrapper method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.find_producer">find_producer() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.find_producer">find_producer() (finn.core.modelwrapper.ModelWrapper method)</a> </li> <li><a href="source_code/finn.html#module-finn">finn (module)</a> </li> @@ -473,127 +473,127 @@ </li> <li><a href="source_code/finn.analysis.fpgadataflow.html#module-finn.analysis.fpgadataflow">finn.analysis.fpgadataflow (module)</a> </li> - <li><a href="source_code/finn.analysis.fpgadataflow.html#module-finn.analysis.fpgadataflow.hls_synth_res_estimation">finn.analysis.fpgadataflow.hls_synth_res_estimation (module)</a> + <li><a href="source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.html#module-finn.analysis.fpgadataflow.hls_synth_res_estimation">finn.analysis.fpgadataflow.hls_synth_res_estimation (module)</a> </li> - <li><a href="source_code/finn.analysis.fpgadataflow.html#module-finn.analysis.fpgadataflow.res_estimation">finn.analysis.fpgadataflow.res_estimation (module)</a> + <li><a href="source_code/finn.analysis.fpgadataflow.res_estimation.html#module-finn.analysis.fpgadataflow.res_estimation">finn.analysis.fpgadataflow.res_estimation (module)</a> </li> - <li><a href="source_code/finn.analysis.html#module-finn.analysis.topology">finn.analysis.topology (module)</a> + <li><a href="source_code/finn.analysis.topology.html#module-finn.analysis.topology">finn.analysis.topology (module)</a> </li> - <li><a href="source_code/finn.analysis.html#module-finn.analysis.verify_custom_nodes">finn.analysis.verify_custom_nodes (module)</a> + <li><a href="source_code/finn.analysis.verify_custom_nodes.html#module-finn.analysis.verify_custom_nodes">finn.analysis.verify_custom_nodes (module)</a> </li> <li><a href="source_code/finn.core.html#module-finn.core">finn.core (module)</a> </li> - <li><a href="source_code/finn.core.html#module-finn.core.datatype">finn.core.datatype (module)</a> + <li><a href="source_code/finn.core.datatype.html#module-finn.core.datatype">finn.core.datatype (module)</a> </li> - <li><a href="source_code/finn.core.html#module-finn.core.execute_custom_node">finn.core.execute_custom_node (module)</a> + <li><a href="source_code/finn.core.execute_custom_node.html#module-finn.core.execute_custom_node">finn.core.execute_custom_node (module)</a> </li> - <li><a href="source_code/finn.core.html#module-finn.core.modelwrapper">finn.core.modelwrapper (module)</a> + <li><a href="source_code/finn.core.modelwrapper.html#module-finn.core.modelwrapper">finn.core.modelwrapper (module)</a> </li> - <li><a href="source_code/finn.core.html#module-finn.core.onnx_exec">finn.core.onnx_exec (module)</a> + <li><a href="source_code/finn.core.onnx_exec.html#module-finn.core.onnx_exec">finn.core.onnx_exec (module)</a> </li> - <li><a href="source_code/finn.core.html#module-finn.core.remote_exec">finn.core.remote_exec (module)</a> + <li><a href="source_code/finn.core.remote_exec.html#module-finn.core.remote_exec">finn.core.remote_exec (module)</a> </li> - <li><a href="source_code/finn.core.html#module-finn.core.rtlsim_exec">finn.core.rtlsim_exec (module)</a> + <li><a href="source_code/finn.core.rtlsim_exec.html#module-finn.core.rtlsim_exec">finn.core.rtlsim_exec (module)</a> </li> <li><a href="source_code/finn.custom_op.html#module-finn.custom_op">finn.custom_op (module)</a> </li> <li><a href="source_code/finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow">finn.custom_op.fpgadataflow (module)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.convolutioninputgenerator">finn.custom_op.fpgadataflow.convolutioninputgenerator (module)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#module-finn.custom_op.fpgadataflow.convolutioninputgenerator">finn.custom_op.fpgadataflow.convolutioninputgenerator (module)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.streamingfclayer_batch">finn.custom_op.fpgadataflow.streamingfclayer_batch (module)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#module-finn.custom_op.fpgadataflow.streamingfclayer_batch">finn.custom_op.fpgadataflow.streamingfclayer_batch (module)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.streamingmaxpool_batch">finn.custom_op.fpgadataflow.streamingmaxpool_batch (module)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#module-finn.custom_op.fpgadataflow.streamingmaxpool_batch">finn.custom_op.fpgadataflow.streamingmaxpool_batch (module)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.templates">finn.custom_op.fpgadataflow.templates (module)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.templates.html#module-finn.custom_op.fpgadataflow.templates">finn.custom_op.fpgadataflow.templates (module)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.tlastmarker">finn.custom_op.fpgadataflow.tlastmarker (module)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#module-finn.custom_op.fpgadataflow.tlastmarker">finn.custom_op.fpgadataflow.tlastmarker (module)</a> </li> - <li><a href="source_code/finn.custom_op.html#module-finn.custom_op.multithreshold">finn.custom_op.multithreshold (module)</a> + <li><a href="source_code/finn.custom_op.multithreshold.html#module-finn.custom_op.multithreshold">finn.custom_op.multithreshold (module)</a> </li> - <li><a href="source_code/finn.custom_op.html#module-finn.custom_op.registry">finn.custom_op.registry (module)</a> + <li><a href="source_code/finn.custom_op.registry.html#module-finn.custom_op.registry">finn.custom_op.registry (module)</a> </li> - <li><a href="source_code/finn.custom_op.html#module-finn.custom_op.streamingdataflowpartition">finn.custom_op.streamingdataflowpartition (module)</a> + <li><a href="source_code/finn.custom_op.streamingdataflowpartition.html#module-finn.custom_op.streamingdataflowpartition">finn.custom_op.streamingdataflowpartition (module)</a> </li> - <li><a href="source_code/finn.custom_op.html#module-finn.custom_op.xnorpopcount">finn.custom_op.xnorpopcount (module)</a> + <li><a href="source_code/finn.custom_op.xnorpopcount.html#module-finn.custom_op.xnorpopcount">finn.custom_op.xnorpopcount (module)</a> </li> <li><a href="source_code/finn.transformation.html#module-finn.transformation">finn.transformation (module)</a> </li> - <li><a href="source_code/finn.transformation.html#module-finn.transformation.batchnorm_to_affine">finn.transformation.batchnorm_to_affine (module)</a> + <li><a href="source_code/finn.transformation.batchnorm_to_affine.html#module-finn.transformation.batchnorm_to_affine">finn.transformation.batchnorm_to_affine (module)</a> </li> - <li><a href="source_code/finn.transformation.html#module-finn.transformation.bipolar_to_xnor">finn.transformation.bipolar_to_xnor (module)</a> + <li><a href="source_code/finn.transformation.bipolar_to_xnor.html#module-finn.transformation.bipolar_to_xnor">finn.transformation.bipolar_to_xnor (module)</a> </li> - <li><a href="source_code/finn.transformation.html#module-finn.transformation.fold_constants">finn.transformation.fold_constants (module)</a> + <li><a href="source_code/finn.transformation.fold_constants.html#module-finn.transformation.fold_constants">finn.transformation.fold_constants (module)</a> </li> <li><a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow">finn.transformation.fpgadataflow (module)</a> </li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.cleanup">finn.transformation.fpgadataflow.cleanup (module)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.cleanup.html#module-finn.transformation.fpgadataflow.cleanup">finn.transformation.fpgadataflow.cleanup (module)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.codegen_ipgen">finn.transformation.fpgadataflow.codegen_ipgen (module)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.codegen_ipgen.html#module-finn.transformation.fpgadataflow.codegen_ipgen">finn.transformation.fpgadataflow.codegen_ipgen (module)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.codegen_ipstitch">finn.transformation.fpgadataflow.codegen_ipstitch (module)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.codegen_ipstitch.html#module-finn.transformation.fpgadataflow.codegen_ipstitch">finn.transformation.fpgadataflow.codegen_ipstitch (module)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.codegen_npysim">finn.transformation.fpgadataflow.codegen_npysim (module)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.codegen_npysim.html#module-finn.transformation.fpgadataflow.codegen_npysim">finn.transformation.fpgadataflow.codegen_npysim (module)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.compile">finn.transformation.fpgadataflow.compile (module)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.compile.html#module-finn.transformation.fpgadataflow.compile">finn.transformation.fpgadataflow.compile (module)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.convert_to_hls_layers">finn.transformation.fpgadataflow.convert_to_hls_layers (module)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.html#module-finn.transformation.fpgadataflow.convert_to_hls_layers">finn.transformation.fpgadataflow.convert_to_hls_layers (module)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.create_dataflow_partition">finn.transformation.fpgadataflow.create_dataflow_partition (module)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.create_dataflow_partition.html#module-finn.transformation.fpgadataflow.create_dataflow_partition">finn.transformation.fpgadataflow.create_dataflow_partition (module)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.hlssynth_ipgen">finn.transformation.fpgadataflow.hlssynth_ipgen (module)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.html#module-finn.transformation.fpgadataflow.hlssynth_ipgen">finn.transformation.fpgadataflow.hlssynth_ipgen (module)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.insert_tlastmarker">finn.transformation.fpgadataflow.insert_tlastmarker (module)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.insert_tlastmarker.html#module-finn.transformation.fpgadataflow.insert_tlastmarker">finn.transformation.fpgadataflow.insert_tlastmarker (module)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.make_deployment">finn.transformation.fpgadataflow.make_deployment (module)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.make_deployment.html#module-finn.transformation.fpgadataflow.make_deployment">finn.transformation.fpgadataflow.make_deployment (module)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.make_pynq_driver">finn.transformation.fpgadataflow.make_pynq_driver (module)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.make_pynq_driver.html#module-finn.transformation.fpgadataflow.make_pynq_driver">finn.transformation.fpgadataflow.make_pynq_driver (module)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.make_pynq_proj">finn.transformation.fpgadataflow.make_pynq_proj (module)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.make_pynq_proj.html#module-finn.transformation.fpgadataflow.make_pynq_proj">finn.transformation.fpgadataflow.make_pynq_proj (module)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.set_exec_mode">finn.transformation.fpgadataflow.set_exec_mode (module)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.set_exec_mode.html#module-finn.transformation.fpgadataflow.set_exec_mode">finn.transformation.fpgadataflow.set_exec_mode (module)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.synth_pynq_proj">finn.transformation.fpgadataflow.synth_pynq_proj (module)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.synth_pynq_proj.html#module-finn.transformation.fpgadataflow.synth_pynq_proj">finn.transformation.fpgadataflow.synth_pynq_proj (module)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.templates">finn.transformation.fpgadataflow.templates (module)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.templates.html#module-finn.transformation.fpgadataflow.templates">finn.transformation.fpgadataflow.templates (module)</a> </li> - <li><a href="source_code/finn.transformation.html#module-finn.transformation.general">finn.transformation.general (module)</a> + <li><a href="source_code/finn.transformation.general.html#module-finn.transformation.general">finn.transformation.general (module)</a> </li> - <li><a href="source_code/finn.transformation.html#module-finn.transformation.infer_datatypes">finn.transformation.infer_datatypes (module)</a> + <li><a href="source_code/finn.transformation.infer_datatypes.html#module-finn.transformation.infer_datatypes">finn.transformation.infer_datatypes (module)</a> </li> - <li><a href="source_code/finn.transformation.html#module-finn.transformation.infer_shapes">finn.transformation.infer_shapes (module)</a> + <li><a href="source_code/finn.transformation.infer_shapes.html#module-finn.transformation.infer_shapes">finn.transformation.infer_shapes (module)</a> </li> <li><a href="source_code/finn.transformation.streamline.html#module-finn.transformation.streamline">finn.transformation.streamline (module)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#module-finn.transformation.streamline.absorb">finn.transformation.streamline.absorb (module)</a> + <li><a href="source_code/finn.transformation.streamline.absorb.html#module-finn.transformation.streamline.absorb">finn.transformation.streamline.absorb (module)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#module-finn.transformation.streamline.collapse_repeated">finn.transformation.streamline.collapse_repeated (module)</a> + <li><a href="source_code/finn.transformation.streamline.collapse_repeated.html#module-finn.transformation.streamline.collapse_repeated">finn.transformation.streamline.collapse_repeated (module)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#module-finn.transformation.streamline.reorder">finn.transformation.streamline.reorder (module)</a> + <li><a href="source_code/finn.transformation.streamline.reorder.html#module-finn.transformation.streamline.reorder">finn.transformation.streamline.reorder (module)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#module-finn.transformation.streamline.round_thresholds">finn.transformation.streamline.round_thresholds (module)</a> + <li><a href="source_code/finn.transformation.streamline.round_thresholds.html#module-finn.transformation.streamline.round_thresholds">finn.transformation.streamline.round_thresholds (module)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#module-finn.transformation.streamline.sign_to_thres">finn.transformation.streamline.sign_to_thres (module)</a> + <li><a href="source_code/finn.transformation.streamline.sign_to_thres.html#module-finn.transformation.streamline.sign_to_thres">finn.transformation.streamline.sign_to_thres (module)</a> </li> <li><a href="source_code/finn.util.html#module-finn.util">finn.util (module)</a> </li> - <li><a href="source_code/finn.util.html#module-finn.util.basic">finn.util.basic (module)</a> + <li><a href="source_code/finn.util.basic.html#module-finn.util.basic">finn.util.basic (module)</a> </li> - <li><a href="source_code/finn.util.html#module-finn.util.data_packing">finn.util.data_packing (module)</a> + <li><a href="source_code/finn.util.data_packing.html#module-finn.util.data_packing">finn.util.data_packing (module)</a> </li> - <li><a href="source_code/finn.util.html#module-finn.util.fpgadataflow">finn.util.fpgadataflow (module)</a> + <li><a href="source_code/finn.util.fpgadataflow.html#module-finn.util.fpgadataflow">finn.util.fpgadataflow (module)</a> </li> - <li><a href="source_code/finn.util.html#module-finn.util.onnx">finn.util.onnx (module)</a> + <li><a href="source_code/finn.util.onnx.html#module-finn.util.onnx">finn.util.onnx (module)</a> </li> - <li><a href="source_code/finn.util.html#module-finn.util.test">finn.util.test (module)</a> + <li><a href="source_code/finn.util.test.html#module-finn.util.test">finn.util.test (module)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.data_packing.finnpy_to_packed_bytearray">finnpy_to_packed_bytearray() (in module finn.util.data_packing)</a> + <li><a href="source_code/finn.util.data_packing.html#finn.util.data_packing.finnpy_to_packed_bytearray">finnpy_to_packed_bytearray() (in module finn.util.data_packing)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.FLOAT32">FLOAT32 (finn.core.datatype.DataType attribute)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.FLOAT32">FLOAT32 (finn.core.datatype.DataType attribute)</a> </li> - <li><a href="source_code/finn.transformation.html#finn.transformation.fold_constants.FoldConstants">FoldConstants (class in finn.transformation.fold_constants)</a> + <li><a href="source_code/finn.transformation.fold_constants.html#finn.transformation.fold_constants.FoldConstants">FoldConstants (class in finn.transformation.fold_constants)</a> </li> </ul></td> </tr></table> @@ -601,159 +601,159 @@ <h2 id="G">G</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.util.html#finn.util.basic.gen_finn_dt_tensor">gen_finn_dt_tensor() (in module finn.util.basic)</a> + <li><a href="source_code/finn.util.basic.html#finn.util.basic.gen_finn_dt_tensor">gen_finn_dt_tensor() (in module finn.util.basic)</a> </li> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.generate_params">generate_params() (finn.custom_op.fpgadataflow.HLSCustomOp method)</a> <ul> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.generate_params">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.generate_params">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> </ul></li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.get_all_tensor_names">get_all_tensor_names() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.get_all_tensor_names">get_all_tensor_names() (finn.core.modelwrapper.ModelWrapper method)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.basic.get_by_name">get_by_name() (in module finn.util.basic)</a> + <li><a href="source_code/finn.util.basic.html#finn.util.basic.get_by_name">get_by_name() (in module finn.util.basic)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.basic.get_finn_root">get_finn_root() (in module finn.util.basic)</a> + <li><a href="source_code/finn.util.basic.html#finn.util.basic.get_finn_root">get_finn_root() (in module finn.util.basic)</a> </li> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.get_folded_input_shape">get_folded_input_shape() (finn.custom_op.fpgadataflow.HLSCustomOp method)</a> <ul> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_folded_input_shape">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_folded_input_shape">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_folded_input_shape">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_folded_input_shape">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> </ul></li> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.get_folded_output_shape">get_folded_output_shape() (finn.custom_op.fpgadataflow.HLSCustomOp method)</a> <ul> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_folded_output_shape">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_folded_output_shape">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_folded_output_shape">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_folded_output_shape">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> </ul></li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_hls_compatible_threshold_tensor">get_hls_compatible_threshold_tensor() (finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_hls_compatible_threshold_tensor">get_hls_compatible_threshold_tensor() (finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_hls_compatible_weight_tensor">get_hls_compatible_weight_tensor() (finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_hls_compatible_weight_tensor">get_hls_compatible_weight_tensor() (finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.get_hls_datatype_str">get_hls_datatype_str() (finn.core.datatype.DataType method)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.get_hls_datatype_str">get_hls_datatype_str() (finn.core.datatype.DataType method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.get_initializer">get_initializer() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.get_initializer">get_initializer() (finn.core.modelwrapper.ModelWrapper method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_input_datatype">get_input_datatype() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_input_datatype">get_input_datatype() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> <ul> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_input_datatype">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_input_datatype">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> </ul></li> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.get_instream_width">get_instream_width() (finn.custom_op.fpgadataflow.HLSCustomOp method)</a> <ul> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_instream_width">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_instream_width">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_instream_width">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_instream_width">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> </ul></li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.get_metadata_prop">get_metadata_prop() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.get_metadata_prop">get_metadata_prop() (finn.core.modelwrapper.ModelWrapper method)</a> </li> <li><a href="source_code/finn.custom_op.html#finn.custom_op.CustomOp.get_nodeattr">get_nodeattr() (finn.custom_op.CustomOp method)</a> </li> <li><a href="source_code/finn.custom_op.html#finn.custom_op.CustomOp.get_nodeattr_types">get_nodeattr_types() (finn.custom_op.CustomOp method)</a> <ul> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_nodeattr_types">(finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_nodeattr_types">(finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> </li> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.get_nodeattr_types">(finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_nodeattr_types">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_nodeattr_types">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.get_nodeattr_types">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.get_nodeattr_types">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_nodeattr_types">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_nodeattr_types">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.multithreshold.MultiThreshold.get_nodeattr_types">(finn.custom_op.multithreshold.MultiThreshold method)</a> + <li><a href="source_code/finn.custom_op.multithreshold.html#finn.custom_op.multithreshold.MultiThreshold.get_nodeattr_types">(finn.custom_op.multithreshold.MultiThreshold method)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.get_nodeattr_types">(finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition method)</a> + <li><a href="source_code/finn.custom_op.streamingdataflowpartition.html#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.get_nodeattr_types">(finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition method)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.xnorpopcount.XnorPopcountMatMul.get_nodeattr_types">(finn.custom_op.xnorpopcount.XnorPopcountMatMul method)</a> + <li><a href="source_code/finn.custom_op.xnorpopcount.html#finn.custom_op.xnorpopcount.XnorPopcountMatMul.get_nodeattr_types">(finn.custom_op.xnorpopcount.XnorPopcountMatMul method)</a> </li> </ul></li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.get_num_possible_values">get_num_possible_values() (finn.core.datatype.DataType method)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.get_num_possible_values">get_num_possible_values() (finn.core.datatype.DataType method)</a> </li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_number_output_values">get_number_output_values() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_number_output_values">get_number_output_values() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> <ul> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.get_number_output_values">(finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_number_output_values">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_number_output_values">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.get_number_output_values">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.get_number_output_values">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_number_output_values">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_number_output_values">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> </ul></li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_output_datatype">get_output_datatype() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_output_datatype">get_output_datatype() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> <ul> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_output_datatype">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_output_datatype">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> </ul></li> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.get_outstream_width">get_outstream_width() (finn.custom_op.fpgadataflow.HLSCustomOp method)</a> <ul> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_outstream_width">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_outstream_width">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_outstream_width">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.get_outstream_width">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> </ul></li> - <li><a href="source_code/finn.analysis.html#finn.analysis.topology.get_per_tensor_fanouts">get_per_tensor_fanouts() (in module finn.analysis.topology)</a> + <li><a href="source_code/finn.analysis.topology.html#finn.analysis.topology.get_per_tensor_fanouts">get_per_tensor_fanouts() (in module finn.analysis.topology)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.get_smallest_possible">get_smallest_possible() (finn.core.datatype.DataType method)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.get_smallest_possible">get_smallest_possible() (finn.core.datatype.DataType method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_stream_width">get_stream_width() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.get_stream_width">get_stream_width() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_template_param_values">get_template_param_values() (finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_template_param_values">get_template_param_values() (finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.get_tensor_datatype">get_tensor_datatype() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.get_tensor_datatype">get_tensor_datatype() (finn.core.modelwrapper.ModelWrapper method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.get_tensor_fanout">get_tensor_fanout() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.get_tensor_fanout">get_tensor_fanout() (finn.core.modelwrapper.ModelWrapper method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.get_tensor_shape">get_tensor_shape() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.get_tensor_shape">get_tensor_shape() (finn.core.modelwrapper.ModelWrapper method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.get_tensor_valueinfo">get_tensor_valueinfo() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.get_tensor_valueinfo">get_tensor_valueinfo() (finn.core.modelwrapper.ModelWrapper method)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.test.get_test_model_def_fxn">get_test_model_def_fxn() (in module finn.util.test)</a> + <li><a href="source_code/finn.util.test.html#finn.util.test.get_test_model_def_fxn">get_test_model_def_fxn() (in module finn.util.test)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.test.get_test_model_trained">get_test_model_trained() (in module finn.util.test)</a> + <li><a href="source_code/finn.util.test.html#finn.util.test.get_test_model_trained">get_test_model_trained() (in module finn.util.test)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.test.get_test_model_untrained">get_test_model_untrained() (in module finn.util.test)</a> + <li><a href="source_code/finn.util.test.html#finn.util.test.get_test_model_untrained">get_test_model_untrained() (in module finn.util.test)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.test.get_trained_checkpoint">get_trained_checkpoint() (in module finn.util.test)</a> + <li><a href="source_code/finn.util.test.html#finn.util.test.get_trained_checkpoint">get_trained_checkpoint() (in module finn.util.test)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_weight_datatype">get_weight_datatype() (finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.get_weight_datatype">get_weight_datatype() (finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.registry.getCustomOp">getCustomOp() (in module finn.custom_op.registry)</a> + <li><a href="source_code/finn.custom_op.registry.html#finn.custom_op.registry.getCustomOp">getCustomOp() (in module finn.custom_op.registry)</a> </li> - <li><a href="source_code/finn.transformation.html#finn.transformation.general.GiveRandomTensorNames">GiveRandomTensorNames (class in finn.transformation.general)</a> + <li><a href="source_code/finn.transformation.general.html#finn.transformation.general.GiveRandomTensorNames">GiveRandomTensorNames (class in finn.transformation.general)</a> </li> - <li><a href="source_code/finn.transformation.html#finn.transformation.general.GiveReadableTensorNames">GiveReadableTensorNames (class in finn.transformation.general)</a> + <li><a href="source_code/finn.transformation.general.html#finn.transformation.general.GiveReadableTensorNames">GiveReadableTensorNames (class in finn.transformation.general)</a> </li> - <li><a href="source_code/finn.transformation.html#finn.transformation.general.GiveUniqueNodeNames">GiveUniqueNodeNames (class in finn.transformation.general)</a> + <li><a href="source_code/finn.transformation.general.html#finn.transformation.general.GiveUniqueNodeNames">GiveUniqueNodeNames (class in finn.transformation.general)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.global_includes">global_includes() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.global_includes">global_includes() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> <ul> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.global_includes">(finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.global_includes">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.global_includes">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.global_includes">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.global_includes">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.global_includes">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.global_includes">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> </ul></li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.graph">graph() (finn.core.modelwrapper.ModelWrapper property)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.graph">graph() (finn.core.modelwrapper.ModelWrapper property)</a> </li> </ul></td> </tr></table> @@ -761,15 +761,15 @@ <h2 id="H">H</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.util.html#finn.util.data_packing.hexstring2npbytearray">hexstring2npbytearray() (in module finn.util.data_packing)</a> + <li><a href="source_code/finn.util.data_packing.html#finn.util.data_packing.hexstring2npbytearray">hexstring2npbytearray() (in module finn.util.data_packing)</a> </li> - <li><a href="source_code/finn.analysis.fpgadataflow.html#finn.analysis.fpgadataflow.hls_synth_res_estimation.hls_synth_res_estimation">hls_synth_res_estimation() (in module finn.analysis.fpgadataflow.hls_synth_res_estimation)</a> + <li><a href="source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.html#finn.analysis.fpgadataflow.hls_synth_res_estimation.hls_synth_res_estimation">hls_synth_res_estimation() (in module finn.analysis.fpgadataflow.hls_synth_res_estimation)</a> </li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp">HLSCustomOp (class in finn.custom_op.fpgadataflow)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen">HLSSynth_IPGen (class in finn.transformation.fpgadataflow.hlssynth_ipgen)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.html#finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen">HLSSynth_IPGen (class in finn.transformation.fpgadataflow.hlssynth_ipgen)</a> </li> </ul></td> </tr></table> @@ -780,52 +780,52 @@ <li><a href="source_code/finn.custom_op.html#finn.custom_op.CustomOp.infer_node_datatype">infer_node_datatype() (finn.custom_op.CustomOp method)</a> <ul> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.infer_node_datatype">(finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.infer_node_datatype">(finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.infer_node_datatype">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.infer_node_datatype">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.infer_node_datatype">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.infer_node_datatype">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.infer_node_datatype">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.infer_node_datatype">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.multithreshold.MultiThreshold.infer_node_datatype">(finn.custom_op.multithreshold.MultiThreshold method)</a> + <li><a href="source_code/finn.custom_op.multithreshold.html#finn.custom_op.multithreshold.MultiThreshold.infer_node_datatype">(finn.custom_op.multithreshold.MultiThreshold method)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.infer_node_datatype">(finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition method)</a> + <li><a href="source_code/finn.custom_op.streamingdataflowpartition.html#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.infer_node_datatype">(finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition method)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.xnorpopcount.XnorPopcountMatMul.infer_node_datatype">(finn.custom_op.xnorpopcount.XnorPopcountMatMul method)</a> + <li><a href="source_code/finn.custom_op.xnorpopcount.html#finn.custom_op.xnorpopcount.XnorPopcountMatMul.infer_node_datatype">(finn.custom_op.xnorpopcount.XnorPopcountMatMul method)</a> </li> </ul></li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer">InferBinaryStreamingFCLayer (class in finn.transformation.fpgadataflow.convert_to_hls_layers)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.html#finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer">InferBinaryStreamingFCLayer (class in finn.transformation.fpgadataflow.convert_to_hls_layers)</a> </li> - <li><a href="source_code/finn.transformation.html#finn.transformation.infer_datatypes.InferDataTypes">InferDataTypes (class in finn.transformation.infer_datatypes)</a> + <li><a href="source_code/finn.transformation.infer_datatypes.html#finn.transformation.infer_datatypes.InferDataTypes">InferDataTypes (class in finn.transformation.infer_datatypes)</a> </li> - <li><a href="source_code/finn.transformation.html#finn.transformation.infer_shapes.InferShapes">InferShapes (class in finn.transformation.infer_shapes)</a> + <li><a href="source_code/finn.transformation.infer_shapes.html#finn.transformation.infer_shapes.InferShapes">InferShapes (class in finn.transformation.infer_shapes)</a> </li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker">InsertTLastMarker (class in finn.transformation.fpgadataflow.insert_tlastmarker)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.insert_tlastmarker.html#finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker">InsertTLastMarker (class in finn.transformation.fpgadataflow.insert_tlastmarker)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.INT16">INT16 (finn.core.datatype.DataType attribute)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.INT16">INT16 (finn.core.datatype.DataType attribute)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.INT2">INT2 (finn.core.datatype.DataType attribute)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.INT2">INT2 (finn.core.datatype.DataType attribute)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.INT3">INT3 (finn.core.datatype.DataType attribute)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.INT3">INT3 (finn.core.datatype.DataType attribute)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.INT32">INT32 (finn.core.datatype.DataType attribute)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.INT32">INT32 (finn.core.datatype.DataType attribute)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.INT4">INT4 (finn.core.datatype.DataType attribute)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.INT4">INT4 (finn.core.datatype.DataType attribute)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.INT8">INT8 (finn.core.datatype.DataType attribute)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.INT8">INT8 (finn.core.datatype.DataType attribute)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.basic.interleave_matrix_outer_dim_from_partitions">interleave_matrix_outer_dim_from_partitions() (in module finn.util.basic)</a> + <li><a href="source_code/finn.util.basic.html#finn.util.basic.interleave_matrix_outer_dim_from_partitions">interleave_matrix_outer_dim_from_partitions() (in module finn.util.basic)</a> </li> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.ipgen_singlenode_code">ipgen_singlenode_code() (finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.fpgadataflow.IPGenBuilder">IPGenBuilder (class in finn.util.fpgadataflow)</a> + <li><a href="source_code/finn.util.fpgadataflow.html#finn.util.fpgadataflow.IPGenBuilder">IPGenBuilder (class in finn.util.fpgadataflow)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.is_integer">is_integer() (finn.core.datatype.DataType method)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.is_integer">is_integer() (finn.core.datatype.DataType method)</a> </li> - <li><a href="source_code/finn.analysis.html#finn.analysis.topology.is_linear">is_linear() (in module finn.analysis.topology)</a> + <li><a href="source_code/finn.analysis.topology.html#finn.analysis.topology.is_linear">is_linear() (in module finn.analysis.topology)</a> </li> </ul></td> </tr></table> @@ -833,14 +833,14 @@ <h2 id="L">L</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.lut_estimation">lut_estimation() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.lut_estimation">lut_estimation() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> <ul> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.lut_estimation">(finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.lut_estimation">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.lut_estimation">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.lut_estimation">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.lut_estimation">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> </li> </ul></li> </ul></td> @@ -849,53 +849,53 @@ <h2 id="M">M</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.util.html#finn.util.basic.make_build_dir">make_build_dir() (in module finn.util.basic)</a> + <li><a href="source_code/finn.util.basic.html#finn.util.basic.make_build_dir">make_build_dir() (in module finn.util.basic)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.make_empty_exec_context">make_empty_exec_context() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.make_empty_exec_context">make_empty_exec_context() (finn.core.modelwrapper.ModelWrapper method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.make_new_valueinfo_name">make_new_valueinfo_name() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.make_new_valueinfo_name">make_new_valueinfo_name() (finn.core.modelwrapper.ModelWrapper method)</a> </li> <li><a href="source_code/finn.custom_op.html#finn.custom_op.CustomOp.make_shape_compatible_op">make_shape_compatible_op() (finn.custom_op.CustomOp method)</a> <ul> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.make_shape_compatible_op">(finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.make_shape_compatible_op">(finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.make_shape_compatible_op">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.make_shape_compatible_op">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.make_shape_compatible_op">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.make_shape_compatible_op">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.make_shape_compatible_op">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.make_shape_compatible_op">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.multithreshold.MultiThreshold.make_shape_compatible_op">(finn.custom_op.multithreshold.MultiThreshold method)</a> + <li><a href="source_code/finn.custom_op.multithreshold.html#finn.custom_op.multithreshold.MultiThreshold.make_shape_compatible_op">(finn.custom_op.multithreshold.MultiThreshold method)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.make_shape_compatible_op">(finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition method)</a> + <li><a href="source_code/finn.custom_op.streamingdataflowpartition.html#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.make_shape_compatible_op">(finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition method)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.xnorpopcount.XnorPopcountMatMul.make_shape_compatible_op">(finn.custom_op.xnorpopcount.XnorPopcountMatMul method)</a> + <li><a href="source_code/finn.custom_op.xnorpopcount.html#finn.custom_op.xnorpopcount.XnorPopcountMatMul.make_shape_compatible_op">(finn.custom_op.xnorpopcount.XnorPopcountMatMul method)</a> </li> </ul></li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver">MakePYNQDriver (class in finn.transformation.fpgadataflow.make_pynq_driver)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.make_pynq_driver.html#finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver">MakePYNQDriver (class in finn.transformation.fpgadataflow.make_pynq_driver)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject">MakePYNQProject (class in finn.transformation.fpgadataflow.make_pynq_proj)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.make_pynq_proj.html#finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject">MakePYNQProject (class in finn.transformation.fpgadataflow.make_pynq_proj)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.max">max() (finn.core.datatype.DataType method)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.max">max() (finn.core.datatype.DataType method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.min">min() (finn.core.datatype.DataType method)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.min">min() (finn.core.datatype.DataType method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.model">model() (finn.core.modelwrapper.ModelWrapper property)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.model">model() (finn.core.modelwrapper.ModelWrapper property)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper">ModelWrapper (class in finn.core.modelwrapper)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper">ModelWrapper (class in finn.core.modelwrapper)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.reorder.MoveAddPastMul">MoveAddPastMul (class in finn.transformation.streamline.reorder)</a> + <li><a href="source_code/finn.transformation.streamline.reorder.html#finn.transformation.streamline.reorder.MoveAddPastMul">MoveAddPastMul (class in finn.transformation.streamline.reorder)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.reorder.MoveScalarAddPastMatMul">MoveScalarAddPastMatMul (class in finn.transformation.streamline.reorder)</a> + <li><a href="source_code/finn.transformation.streamline.reorder.html#finn.transformation.streamline.reorder.MoveScalarAddPastMatMul">MoveScalarAddPastMatMul (class in finn.transformation.streamline.reorder)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.reorder.MoveScalarMulPastMatMul">MoveScalarMulPastMatMul (class in finn.transformation.streamline.reorder)</a> + <li><a href="source_code/finn.transformation.streamline.reorder.html#finn.transformation.streamline.reorder.MoveScalarMulPastMatMul">MoveScalarMulPastMatMul (class in finn.transformation.streamline.reorder)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.multithreshold.MultiThreshold">MultiThreshold (class in finn.custom_op.multithreshold)</a> + <li><a href="source_code/finn.custom_op.multithreshold.html#finn.custom_op.multithreshold.MultiThreshold">MultiThreshold (class in finn.custom_op.multithreshold)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.multithreshold.multithreshold">multithreshold() (in module finn.custom_op.multithreshold)</a> + <li><a href="source_code/finn.custom_op.multithreshold.html#finn.custom_op.multithreshold.multithreshold">multithreshold() (in module finn.custom_op.multithreshold)</a> </li> </ul></td> </tr></table> @@ -903,19 +903,19 @@ <h2 id="N">N</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.analysis.html#finn.analysis.topology.node_inputs_in_expected_order">node_inputs_in_expected_order() (in module finn.analysis.topology)</a> + <li><a href="source_code/finn.analysis.topology.html#finn.analysis.topology.node_inputs_in_expected_order">node_inputs_in_expected_order() (in module finn.analysis.topology)</a> </li> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.node_res_estimation">node_res_estimation() (finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.data_packing.npbytearray2hexstring">npbytearray2hexstring() (in module finn.util.data_packing)</a> + <li><a href="source_code/finn.util.data_packing.html#finn.util.data_packing.npbytearray2hexstring">npbytearray2hexstring() (in module finn.util.data_packing)</a> </li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.npy_to_dynamic_output">npy_to_dynamic_output() (finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.data_packing.npy_to_rtlsim_input">npy_to_rtlsim_input() (in module finn.util.data_packing)</a> + <li><a href="source_code/finn.util.data_packing.html#finn.util.data_packing.npy_to_rtlsim_input">npy_to_rtlsim_input() (in module finn.util.data_packing)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.data_packing.numpy_to_hls_code">numpy_to_hls_code() (in module finn.util.data_packing)</a> + <li><a href="source_code/finn.util.data_packing.html#finn.util.data_packing.numpy_to_hls_code">numpy_to_hls_code() (in module finn.util.data_packing)</a> </li> </ul></td> </tr></table> @@ -923,27 +923,27 @@ <h2 id="P">P</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.util.html#finn.util.data_packing.pack_innermost_dim_as_hex_string">pack_innermost_dim_as_hex_string() (in module finn.util.data_packing)</a> + <li><a href="source_code/finn.util.data_packing.html#finn.util.data_packing.pack_innermost_dim_as_hex_string">pack_innermost_dim_as_hex_string() (in module finn.util.data_packing)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.data_packing.packed_bytearray_to_finnpy">packed_bytearray_to_finnpy() (in module finn.util.data_packing)</a> + <li><a href="source_code/finn.util.data_packing.html#finn.util.data_packing.packed_bytearray_to_finnpy">packed_bytearray_to_finnpy() (in module finn.util.data_packing)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.basic.pad_tensor_to_multiple_of">pad_tensor_to_multiple_of() (in module finn.util.basic)</a> + <li><a href="source_code/finn.util.basic.html#finn.util.basic.pad_tensor_to_multiple_of">pad_tensor_to_multiple_of() (in module finn.util.basic)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.pragmas">pragmas() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.pragmas">pragmas() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> <ul> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.pragmas">(finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.pragmas">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.pragmas">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.pragmas">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.pragmas">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.pragmas">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.pragmas">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> </ul></li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.util.html#finn.util.fpgadataflow.pyverilate_stitched_ip">pyverilate_stitched_ip() (in module finn.util.fpgadataflow)</a> + <li><a href="source_code/finn.util.fpgadataflow.html#finn.util.fpgadataflow.pyverilate_stitched_ip">pyverilate_stitched_ip() (in module finn.util.fpgadataflow)</a> </li> </ul></td> </tr></table> @@ -951,41 +951,41 @@ <h2 id="R">R</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.util.html#finn.util.basic.random_string">random_string() (in module finn.util.basic)</a> + <li><a href="source_code/finn.util.basic.html#finn.util.basic.random_string">random_string() (in module finn.util.basic)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.read_npy_data">read_npy_data() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.read_npy_data">read_npy_data() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> <ul> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.read_npy_data">(finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.read_npy_data">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.read_npy_data">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.read_npy_data">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.read_npy_data">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.read_npy_data">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.read_npy_data">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> </ul></li> - <li><a href="source_code/finn.core.html#finn.core.remote_exec.remote_exec">remote_exec() (in module finn.core.remote_exec)</a> + <li><a href="source_code/finn.core.remote_exec.html#finn.core.remote_exec.remote_exec">remote_exec() (in module finn.core.remote_exec)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.basic.remove_by_name">remove_by_name() (in module finn.util.basic)</a> + <li><a href="source_code/finn.util.basic.html#finn.util.basic.remove_by_name">remove_by_name() (in module finn.util.basic)</a> </li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.rename_tensor">rename_tensor() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.rename_tensor">rename_tensor() (finn.core.modelwrapper.ModelWrapper method)</a> </li> - <li><a href="source_code/finn.analysis.fpgadataflow.html#finn.analysis.fpgadataflow.res_estimation.res_estimation">res_estimation() (in module finn.analysis.fpgadataflow.res_estimation)</a> + <li><a href="source_code/finn.analysis.fpgadataflow.res_estimation.html#finn.analysis.fpgadataflow.res_estimation.res_estimation">res_estimation() (in module finn.analysis.fpgadataflow.res_estimation)</a> </li> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.reset_rtlsim">reset_rtlsim() (finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.round_thresholds.RoundAndClipThresholds">RoundAndClipThresholds (class in finn.transformation.streamline.round_thresholds)</a> + <li><a href="source_code/finn.transformation.streamline.round_thresholds.html#finn.transformation.streamline.round_thresholds.RoundAndClipThresholds">RoundAndClipThresholds (class in finn.transformation.streamline.round_thresholds)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.basic.roundup_to_integer_multiple">roundup_to_integer_multiple() (in module finn.util.basic)</a> + <li><a href="source_code/finn.util.basic.html#finn.util.basic.roundup_to_integer_multiple">roundup_to_integer_multiple() (in module finn.util.basic)</a> </li> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.rtlsim">rtlsim() (finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.rtlsim_exec.rtlsim_exec">rtlsim_exec() (in module finn.core.rtlsim_exec)</a> + <li><a href="source_code/finn.core.rtlsim_exec.html#finn.core.rtlsim_exec.rtlsim_exec">rtlsim_exec() (in module finn.core.rtlsim_exec)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.data_packing.rtlsim_output_to_npy">rtlsim_output_to_npy() (in module finn.util.data_packing)</a> + <li><a href="source_code/finn.util.data_packing.html#finn.util.data_packing.rtlsim_output_to_npy">rtlsim_output_to_npy() (in module finn.util.data_packing)</a> </li> </ul></td> </tr></table> @@ -993,61 +993,61 @@ <h2 id="S">S</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.save">save() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.save">save() (finn.core.modelwrapper.ModelWrapper method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.save_as_npy">save_as_npy() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.save_as_npy">save_as_npy() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> <ul> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.save_as_npy">(finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.save_as_npy">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.save_as_npy">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.save_as_npy">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.save_as_npy">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.save_as_npy">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.save_as_npy">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> </ul></li> - <li><a href="source_code/finn.util.html#finn.util.basic.CppBuilder.set_executable_path">set_executable_path() (finn.util.basic.CppBuilder method)</a> + <li><a href="source_code/finn.util.basic.html#finn.util.basic.CppBuilder.set_executable_path">set_executable_path() (finn.util.basic.CppBuilder method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.set_initializer">set_initializer() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.set_initializer">set_initializer() (finn.core.modelwrapper.ModelWrapper method)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.fpgadataflow.IPGenBuilder.set_ipgen_path">set_ipgen_path() (finn.util.fpgadataflow.IPGenBuilder method)</a> + <li><a href="source_code/finn.util.fpgadataflow.html#finn.util.fpgadataflow.IPGenBuilder.set_ipgen_path">set_ipgen_path() (finn.util.fpgadataflow.IPGenBuilder method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.set_metadata_prop">set_metadata_prop() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.set_metadata_prop">set_metadata_prop() (finn.core.modelwrapper.ModelWrapper method)</a> </li> <li><a href="source_code/finn.custom_op.html#finn.custom_op.CustomOp.set_nodeattr">set_nodeattr() (finn.custom_op.CustomOp method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.set_tensor_datatype">set_tensor_datatype() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.set_tensor_datatype">set_tensor_datatype() (finn.core.modelwrapper.ModelWrapper method)</a> </li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.set_tensor_shape">set_tensor_shape() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.set_tensor_shape">set_tensor_shape() (finn.core.modelwrapper.ModelWrapper method)</a> </li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.set_exec_mode.SetExecMode">SetExecMode (class in finn.transformation.fpgadataflow.set_exec_mode)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.set_exec_mode.html#finn.transformation.fpgadataflow.set_exec_mode.SetExecMode">SetExecMode (class in finn.transformation.fpgadataflow.set_exec_mode)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.signed">signed() (finn.core.datatype.DataType method)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.signed">signed() (finn.core.datatype.DataType method)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition">StreamingDataflowPartition (class in finn.custom_op.streamingdataflowpartition)</a> + <li><a href="source_code/finn.custom_op.streamingdataflowpartition.html#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition">StreamingDataflowPartition (class in finn.custom_op.streamingdataflowpartition)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch">StreamingFCLayer_Batch (class in finn.custom_op.fpgadataflow.streamingfclayer_batch)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch">StreamingFCLayer_Batch (class in finn.custom_op.fpgadataflow.streamingfclayer_batch)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch">StreamingMaxPool_Batch (class in finn.custom_op.fpgadataflow.streamingmaxpool_batch)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch">StreamingMaxPool_Batch (class in finn.custom_op.fpgadataflow.streamingmaxpool_batch)</a> </li> <li><a href="source_code/finn.transformation.streamline.html#finn.transformation.streamline.Streamline">Streamline (class in finn.transformation.streamline)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.strm_decl">strm_decl() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.strm_decl">strm_decl() (finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> <ul> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.strm_decl">(finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.strm_decl">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.strm_decl">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.strm_decl">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.strm_decl">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.strm_decl">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.strm_decl">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> </ul></li> - <li><a href="source_code/finn.transformation.fpgadataflow.html#finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject">SynthPYNQProject (class in finn.transformation.fpgadataflow.synth_pynq_proj)</a> + <li><a href="source_code/finn.transformation.fpgadataflow.synth_pynq_proj.html#finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject">SynthPYNQProject (class in finn.transformation.fpgadataflow.synth_pynq_proj)</a> </li> </ul></td> </tr></table> @@ -1055,15 +1055,15 @@ <h2 id="T">T</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.TERNARY">TERNARY (finn.core.datatype.DataType attribute)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.TERNARY">TERNARY (finn.core.datatype.DataType attribute)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker">TLastMarker (class in finn.custom_op.fpgadataflow.tlastmarker)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker">TLastMarker (class in finn.custom_op.fpgadataflow.tlastmarker)</a> </li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.HLSCustomOp.toggle_clk">toggle_clk() (finn.custom_op.fpgadataflow.HLSCustomOp method)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.modelwrapper.ModelWrapper.transform">transform() (finn.core.modelwrapper.ModelWrapper method)</a> + <li><a href="source_code/finn.core.modelwrapper.html#finn.core.modelwrapper.ModelWrapper.transform">transform() (finn.core.modelwrapper.ModelWrapper method)</a> </li> <li><a href="source_code/finn.transformation.html#finn.transformation.Transformation">Transformation (class in finn.transformation)</a> </li> @@ -1073,21 +1073,21 @@ <h2 id="U">U</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.UINT16">UINT16 (finn.core.datatype.DataType attribute)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.UINT16">UINT16 (finn.core.datatype.DataType attribute)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.UINT2">UINT2 (finn.core.datatype.DataType attribute)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.UINT2">UINT2 (finn.core.datatype.DataType attribute)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.UINT3">UINT3 (finn.core.datatype.DataType attribute)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.UINT3">UINT3 (finn.core.datatype.DataType attribute)</a> </li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.UINT32">UINT32 (finn.core.datatype.DataType attribute)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.UINT32">UINT32 (finn.core.datatype.DataType attribute)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.UINT4">UINT4 (finn.core.datatype.DataType attribute)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.UINT4">UINT4 (finn.core.datatype.DataType attribute)</a> </li> - <li><a href="source_code/finn.core.html#finn.core.datatype.DataType.UINT8">UINT8 (finn.core.datatype.DataType attribute)</a> + <li><a href="source_code/finn.core.datatype.html#finn.core.datatype.DataType.UINT8">UINT8 (finn.core.datatype.DataType attribute)</a> </li> - <li><a href="source_code/finn.util.html#finn.util.data_packing.unpack_innermost_dim_from_hex_string">unpack_innermost_dim_from_hex_string() (in module finn.util.data_packing)</a> + <li><a href="source_code/finn.util.data_packing.html#finn.util.data_packing.unpack_innermost_dim_from_hex_string">unpack_innermost_dim_from_hex_string() (in module finn.util.data_packing)</a> </li> </ul></td> </tr></table> @@ -1095,29 +1095,29 @@ <h2 id="V">V</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.util.html#finn.util.onnx.valueinfo_to_tensor">valueinfo_to_tensor() (in module finn.util.onnx)</a> + <li><a href="source_code/finn.util.onnx.html#finn.util.onnx.valueinfo_to_tensor">valueinfo_to_tensor() (in module finn.util.onnx)</a> </li> <li><a href="source_code/finn.custom_op.html#finn.custom_op.CustomOp.verify_node">verify_node() (finn.custom_op.CustomOp method)</a> <ul> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.verify_node">(finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator.verify_node">(finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.verify_node">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch.verify_node">(finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.verify_node">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch.verify_node">(finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch method)</a> </li> - <li><a href="source_code/finn.custom_op.fpgadataflow.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.verify_node">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> + <li><a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#finn.custom_op.fpgadataflow.tlastmarker.TLastMarker.verify_node">(finn.custom_op.fpgadataflow.tlastmarker.TLastMarker method)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.multithreshold.MultiThreshold.verify_node">(finn.custom_op.multithreshold.MultiThreshold method)</a> + <li><a href="source_code/finn.custom_op.multithreshold.html#finn.custom_op.multithreshold.MultiThreshold.verify_node">(finn.custom_op.multithreshold.MultiThreshold method)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.verify_node">(finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition method)</a> + <li><a href="source_code/finn.custom_op.streamingdataflowpartition.html#finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition.verify_node">(finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition method)</a> </li> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.xnorpopcount.XnorPopcountMatMul.verify_node">(finn.custom_op.xnorpopcount.XnorPopcountMatMul method)</a> + <li><a href="source_code/finn.custom_op.xnorpopcount.html#finn.custom_op.xnorpopcount.XnorPopcountMatMul.verify_node">(finn.custom_op.xnorpopcount.XnorPopcountMatMul method)</a> </li> </ul></li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.analysis.html#finn.analysis.verify_custom_nodes.verify_nodes">verify_nodes() (in module finn.analysis.verify_custom_nodes)</a> + <li><a href="source_code/finn.analysis.verify_custom_nodes.html#finn.analysis.verify_custom_nodes.verify_nodes">verify_nodes() (in module finn.analysis.verify_custom_nodes)</a> </li> </ul></td> </tr></table> @@ -1125,11 +1125,11 @@ <h2 id="X">X</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.xnorpopcount.XnorPopcountMatMul">XnorPopcountMatMul (class in finn.custom_op.xnorpopcount)</a> + <li><a href="source_code/finn.custom_op.xnorpopcount.html#finn.custom_op.xnorpopcount.XnorPopcountMatMul">XnorPopcountMatMul (class in finn.custom_op.xnorpopcount)</a> </li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="source_code/finn.custom_op.html#finn.custom_op.xnorpopcount.xnorpopcountmatmul">xnorpopcountmatmul() (in module finn.custom_op.xnorpopcount)</a> + <li><a href="source_code/finn.custom_op.xnorpopcount.html#finn.custom_op.xnorpopcount.xnorpopcountmatmul">xnorpopcountmatmul() (in module finn.custom_op.xnorpopcount)</a> </li> </ul></td> </tr></table> diff --git a/docs/finn/_build/html/objects.inv b/docs/finn/_build/html/objects.inv index 2a4e77eea14176ccb516ab4444a424fe97632698..a971c58564a2f9c835ae2bab0f78f9db501f3457 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/py-modindex.html b/docs/finn/_build/html/py-modindex.html index 1a992f29ac5b2b95613dc15991895e95aed97e1f..423baaf74aa9e2cf537c83459fd0f1fa0c7fce76 100644 --- a/docs/finn/_build/html/py-modindex.html +++ b/docs/finn/_build/html/py-modindex.html @@ -175,22 +175,22 @@ <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.analysis.fpgadataflow.html#module-finn.analysis.fpgadataflow.hls_synth_res_estimation"><code class="xref">finn.analysis.fpgadataflow.hls_synth_res_estimation</code></a></td><td> + <a href="source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.html#module-finn.analysis.fpgadataflow.hls_synth_res_estimation"><code class="xref">finn.analysis.fpgadataflow.hls_synth_res_estimation</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.analysis.fpgadataflow.html#module-finn.analysis.fpgadataflow.res_estimation"><code class="xref">finn.analysis.fpgadataflow.res_estimation</code></a></td><td> + <a href="source_code/finn.analysis.fpgadataflow.res_estimation.html#module-finn.analysis.fpgadataflow.res_estimation"><code class="xref">finn.analysis.fpgadataflow.res_estimation</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.analysis.html#module-finn.analysis.topology"><code class="xref">finn.analysis.topology</code></a></td><td> + <a href="source_code/finn.analysis.topology.html#module-finn.analysis.topology"><code class="xref">finn.analysis.topology</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.analysis.html#module-finn.analysis.verify_custom_nodes"><code class="xref">finn.analysis.verify_custom_nodes</code></a></td><td> + <a href="source_code/finn.analysis.verify_custom_nodes.html#module-finn.analysis.verify_custom_nodes"><code class="xref">finn.analysis.verify_custom_nodes</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> @@ -200,32 +200,32 @@ <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.core.html#module-finn.core.datatype"><code class="xref">finn.core.datatype</code></a></td><td> + <a href="source_code/finn.core.datatype.html#module-finn.core.datatype"><code class="xref">finn.core.datatype</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.core.html#module-finn.core.execute_custom_node"><code class="xref">finn.core.execute_custom_node</code></a></td><td> + <a href="source_code/finn.core.execute_custom_node.html#module-finn.core.execute_custom_node"><code class="xref">finn.core.execute_custom_node</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.core.html#module-finn.core.modelwrapper"><code class="xref">finn.core.modelwrapper</code></a></td><td> + <a href="source_code/finn.core.modelwrapper.html#module-finn.core.modelwrapper"><code class="xref">finn.core.modelwrapper</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.core.html#module-finn.core.onnx_exec"><code class="xref">finn.core.onnx_exec</code></a></td><td> + <a href="source_code/finn.core.onnx_exec.html#module-finn.core.onnx_exec"><code class="xref">finn.core.onnx_exec</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.core.html#module-finn.core.remote_exec"><code class="xref">finn.core.remote_exec</code></a></td><td> + <a href="source_code/finn.core.remote_exec.html#module-finn.core.remote_exec"><code class="xref">finn.core.remote_exec</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.core.html#module-finn.core.rtlsim_exec"><code class="xref">finn.core.rtlsim_exec</code></a></td><td> + <a href="source_code/finn.core.rtlsim_exec.html#module-finn.core.rtlsim_exec"><code class="xref">finn.core.rtlsim_exec</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> @@ -240,47 +240,47 @@ <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.convolutioninputgenerator"><code class="xref">finn.custom_op.fpgadataflow.convolutioninputgenerator</code></a></td><td> + <a href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html#module-finn.custom_op.fpgadataflow.convolutioninputgenerator"><code class="xref">finn.custom_op.fpgadataflow.convolutioninputgenerator</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.streamingfclayer_batch"><code class="xref">finn.custom_op.fpgadataflow.streamingfclayer_batch</code></a></td><td> + <a href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html#module-finn.custom_op.fpgadataflow.streamingfclayer_batch"><code class="xref">finn.custom_op.fpgadataflow.streamingfclayer_batch</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.streamingmaxpool_batch"><code class="xref">finn.custom_op.fpgadataflow.streamingmaxpool_batch</code></a></td><td> + <a href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html#module-finn.custom_op.fpgadataflow.streamingmaxpool_batch"><code class="xref">finn.custom_op.fpgadataflow.streamingmaxpool_batch</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.templates"><code class="xref">finn.custom_op.fpgadataflow.templates</code></a></td><td> + <a href="source_code/finn.custom_op.fpgadataflow.templates.html#module-finn.custom_op.fpgadataflow.templates"><code class="xref">finn.custom_op.fpgadataflow.templates</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.tlastmarker"><code class="xref">finn.custom_op.fpgadataflow.tlastmarker</code></a></td><td> + <a href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html#module-finn.custom_op.fpgadataflow.tlastmarker"><code class="xref">finn.custom_op.fpgadataflow.tlastmarker</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.custom_op.html#module-finn.custom_op.multithreshold"><code class="xref">finn.custom_op.multithreshold</code></a></td><td> + <a href="source_code/finn.custom_op.multithreshold.html#module-finn.custom_op.multithreshold"><code class="xref">finn.custom_op.multithreshold</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.custom_op.html#module-finn.custom_op.registry"><code class="xref">finn.custom_op.registry</code></a></td><td> + <a href="source_code/finn.custom_op.registry.html#module-finn.custom_op.registry"><code class="xref">finn.custom_op.registry</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.custom_op.html#module-finn.custom_op.streamingdataflowpartition"><code class="xref">finn.custom_op.streamingdataflowpartition</code></a></td><td> + <a href="source_code/finn.custom_op.streamingdataflowpartition.html#module-finn.custom_op.streamingdataflowpartition"><code class="xref">finn.custom_op.streamingdataflowpartition</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.custom_op.html#module-finn.custom_op.xnorpopcount"><code class="xref">finn.custom_op.xnorpopcount</code></a></td><td> + <a href="source_code/finn.custom_op.xnorpopcount.html#module-finn.custom_op.xnorpopcount"><code class="xref">finn.custom_op.xnorpopcount</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> @@ -290,17 +290,17 @@ <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.html#module-finn.transformation.batchnorm_to_affine"><code class="xref">finn.transformation.batchnorm_to_affine</code></a></td><td> + <a href="source_code/finn.transformation.batchnorm_to_affine.html#module-finn.transformation.batchnorm_to_affine"><code class="xref">finn.transformation.batchnorm_to_affine</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.html#module-finn.transformation.bipolar_to_xnor"><code class="xref">finn.transformation.bipolar_to_xnor</code></a></td><td> + <a href="source_code/finn.transformation.bipolar_to_xnor.html#module-finn.transformation.bipolar_to_xnor"><code class="xref">finn.transformation.bipolar_to_xnor</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.html#module-finn.transformation.fold_constants"><code class="xref">finn.transformation.fold_constants</code></a></td><td> + <a href="source_code/finn.transformation.fold_constants.html#module-finn.transformation.fold_constants"><code class="xref">finn.transformation.fold_constants</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> @@ -310,92 +310,92 @@ <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.cleanup"><code class="xref">finn.transformation.fpgadataflow.cleanup</code></a></td><td> + <a href="source_code/finn.transformation.fpgadataflow.cleanup.html#module-finn.transformation.fpgadataflow.cleanup"><code class="xref">finn.transformation.fpgadataflow.cleanup</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.codegen_ipgen"><code class="xref">finn.transformation.fpgadataflow.codegen_ipgen</code></a></td><td> + <a href="source_code/finn.transformation.fpgadataflow.codegen_ipgen.html#module-finn.transformation.fpgadataflow.codegen_ipgen"><code class="xref">finn.transformation.fpgadataflow.codegen_ipgen</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.codegen_ipstitch"><code class="xref">finn.transformation.fpgadataflow.codegen_ipstitch</code></a></td><td> + <a href="source_code/finn.transformation.fpgadataflow.codegen_ipstitch.html#module-finn.transformation.fpgadataflow.codegen_ipstitch"><code class="xref">finn.transformation.fpgadataflow.codegen_ipstitch</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.codegen_npysim"><code class="xref">finn.transformation.fpgadataflow.codegen_npysim</code></a></td><td> + <a href="source_code/finn.transformation.fpgadataflow.codegen_npysim.html#module-finn.transformation.fpgadataflow.codegen_npysim"><code class="xref">finn.transformation.fpgadataflow.codegen_npysim</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.compile"><code class="xref">finn.transformation.fpgadataflow.compile</code></a></td><td> + <a href="source_code/finn.transformation.fpgadataflow.compile.html#module-finn.transformation.fpgadataflow.compile"><code class="xref">finn.transformation.fpgadataflow.compile</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.convert_to_hls_layers"><code class="xref">finn.transformation.fpgadataflow.convert_to_hls_layers</code></a></td><td> + <a href="source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.html#module-finn.transformation.fpgadataflow.convert_to_hls_layers"><code class="xref">finn.transformation.fpgadataflow.convert_to_hls_layers</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.create_dataflow_partition"><code class="xref">finn.transformation.fpgadataflow.create_dataflow_partition</code></a></td><td> + <a href="source_code/finn.transformation.fpgadataflow.create_dataflow_partition.html#module-finn.transformation.fpgadataflow.create_dataflow_partition"><code class="xref">finn.transformation.fpgadataflow.create_dataflow_partition</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.hlssynth_ipgen"><code class="xref">finn.transformation.fpgadataflow.hlssynth_ipgen</code></a></td><td> + <a href="source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.html#module-finn.transformation.fpgadataflow.hlssynth_ipgen"><code class="xref">finn.transformation.fpgadataflow.hlssynth_ipgen</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.insert_tlastmarker"><code class="xref">finn.transformation.fpgadataflow.insert_tlastmarker</code></a></td><td> + <a href="source_code/finn.transformation.fpgadataflow.insert_tlastmarker.html#module-finn.transformation.fpgadataflow.insert_tlastmarker"><code class="xref">finn.transformation.fpgadataflow.insert_tlastmarker</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.make_deployment"><code class="xref">finn.transformation.fpgadataflow.make_deployment</code></a></td><td> + <a href="source_code/finn.transformation.fpgadataflow.make_deployment.html#module-finn.transformation.fpgadataflow.make_deployment"><code class="xref">finn.transformation.fpgadataflow.make_deployment</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.make_pynq_driver"><code class="xref">finn.transformation.fpgadataflow.make_pynq_driver</code></a></td><td> + <a href="source_code/finn.transformation.fpgadataflow.make_pynq_driver.html#module-finn.transformation.fpgadataflow.make_pynq_driver"><code class="xref">finn.transformation.fpgadataflow.make_pynq_driver</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.make_pynq_proj"><code class="xref">finn.transformation.fpgadataflow.make_pynq_proj</code></a></td><td> + <a href="source_code/finn.transformation.fpgadataflow.make_pynq_proj.html#module-finn.transformation.fpgadataflow.make_pynq_proj"><code class="xref">finn.transformation.fpgadataflow.make_pynq_proj</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.set_exec_mode"><code class="xref">finn.transformation.fpgadataflow.set_exec_mode</code></a></td><td> + <a href="source_code/finn.transformation.fpgadataflow.set_exec_mode.html#module-finn.transformation.fpgadataflow.set_exec_mode"><code class="xref">finn.transformation.fpgadataflow.set_exec_mode</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.synth_pynq_proj"><code class="xref">finn.transformation.fpgadataflow.synth_pynq_proj</code></a></td><td> + <a href="source_code/finn.transformation.fpgadataflow.synth_pynq_proj.html#module-finn.transformation.fpgadataflow.synth_pynq_proj"><code class="xref">finn.transformation.fpgadataflow.synth_pynq_proj</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.templates"><code class="xref">finn.transformation.fpgadataflow.templates</code></a></td><td> + <a href="source_code/finn.transformation.fpgadataflow.templates.html#module-finn.transformation.fpgadataflow.templates"><code class="xref">finn.transformation.fpgadataflow.templates</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.html#module-finn.transformation.general"><code class="xref">finn.transformation.general</code></a></td><td> + <a href="source_code/finn.transformation.general.html#module-finn.transformation.general"><code class="xref">finn.transformation.general</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.html#module-finn.transformation.infer_datatypes"><code class="xref">finn.transformation.infer_datatypes</code></a></td><td> + <a href="source_code/finn.transformation.infer_datatypes.html#module-finn.transformation.infer_datatypes"><code class="xref">finn.transformation.infer_datatypes</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.html#module-finn.transformation.infer_shapes"><code class="xref">finn.transformation.infer_shapes</code></a></td><td> + <a href="source_code/finn.transformation.infer_shapes.html#module-finn.transformation.infer_shapes"><code class="xref">finn.transformation.infer_shapes</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> @@ -405,27 +405,27 @@ <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.streamline.html#module-finn.transformation.streamline.absorb"><code class="xref">finn.transformation.streamline.absorb</code></a></td><td> + <a href="source_code/finn.transformation.streamline.absorb.html#module-finn.transformation.streamline.absorb"><code class="xref">finn.transformation.streamline.absorb</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.streamline.html#module-finn.transformation.streamline.collapse_repeated"><code class="xref">finn.transformation.streamline.collapse_repeated</code></a></td><td> + <a href="source_code/finn.transformation.streamline.collapse_repeated.html#module-finn.transformation.streamline.collapse_repeated"><code class="xref">finn.transformation.streamline.collapse_repeated</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.streamline.html#module-finn.transformation.streamline.reorder"><code class="xref">finn.transformation.streamline.reorder</code></a></td><td> + <a href="source_code/finn.transformation.streamline.reorder.html#module-finn.transformation.streamline.reorder"><code class="xref">finn.transformation.streamline.reorder</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.streamline.html#module-finn.transformation.streamline.round_thresholds"><code class="xref">finn.transformation.streamline.round_thresholds</code></a></td><td> + <a href="source_code/finn.transformation.streamline.round_thresholds.html#module-finn.transformation.streamline.round_thresholds"><code class="xref">finn.transformation.streamline.round_thresholds</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.transformation.streamline.html#module-finn.transformation.streamline.sign_to_thres"><code class="xref">finn.transformation.streamline.sign_to_thres</code></a></td><td> + <a href="source_code/finn.transformation.streamline.sign_to_thres.html#module-finn.transformation.streamline.sign_to_thres"><code class="xref">finn.transformation.streamline.sign_to_thres</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> @@ -435,27 +435,27 @@ <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.util.html#module-finn.util.basic"><code class="xref">finn.util.basic</code></a></td><td> + <a href="source_code/finn.util.basic.html#module-finn.util.basic"><code class="xref">finn.util.basic</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.util.html#module-finn.util.data_packing"><code class="xref">finn.util.data_packing</code></a></td><td> + <a href="source_code/finn.util.data_packing.html#module-finn.util.data_packing"><code class="xref">finn.util.data_packing</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.util.html#module-finn.util.fpgadataflow"><code class="xref">finn.util.fpgadataflow</code></a></td><td> + <a href="source_code/finn.util.fpgadataflow.html#module-finn.util.fpgadataflow"><code class="xref">finn.util.fpgadataflow</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.util.html#module-finn.util.onnx"><code class="xref">finn.util.onnx</code></a></td><td> + <a href="source_code/finn.util.onnx.html#module-finn.util.onnx"><code class="xref">finn.util.onnx</code></a></td><td> <em></em></td></tr> <tr class="cg-1"> <td></td> <td>    - <a href="source_code/finn.util.html#module-finn.util.test"><code class="xref">finn.util.test</code></a></td><td> + <a href="source_code/finn.util.test.html#module-finn.util.test"><code class="xref">finn.util.test</code></a></td><td> <em></em></td></tr> </table> diff --git a/docs/finn/_build/html/searchindex.js b/docs/finn/_build/html/searchindex.js index 69ac8240fd292b3cccf3d3d4b8732e9c5b26d2d3..9125c56f08966436c00b83ce913ebe973b26e271 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:[4,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:[4,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:[4,5,15],batchnorm:11,batchnorm_to_affin:[4,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:[4,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:[4,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:[4,5,11],codegen_ipstitch:[4,5,11],codegen_npysim:[4,5,11],collaps:13,collapse_rep:[4,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,4,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:[4,15],context:[8,9,10],contribut:2,convent:6,convert:[1,10,11,12,13,14],convert_to_hls_lay:[4,5,11],convertbipolarmatmultoxnorpopcount:11,convertsigntothr:13,convertsubtoadd:11,convolutioninputgener:[4,5,9],copi:[8,11,12],core:[4,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:[4,5,11],createdataflowpartit:12,current:[2,8],custom:[1,2,6,8],custom_op:[4,5,15],customop:[9,10],data:[9,12,14],data_pack:[4,5,15],dataflow:[2,8,12],dataoutstrm:10,datatyp:[4,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:[4,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:4,finn_dt:14,finnpy_to_packed_bytearrai:14,first:[6,13],fix:[11,14],flatten:14,float32:[6,8],flow:[],fold_const:[4,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:[4,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,4,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:[4,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:[4,5,6],hls_var_nam:14,hlscustomop:10,hlslib:[2,10],hlssynth_ipgen:[4,5,11],homepag:2,host:[1,14],how:[4,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:[4,5,15],infer_node_datatyp:[9,10],infer_shap:[4,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:[4,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:[4,5,11],make_empty_exec_context:8,make_new_valueinfo_nam:8,make_project:12,make_pynq_driv:[4,5,11],make_pynq_proj:[4,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:[4,5,6,11,15],modul:[4,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:[4,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:[4,5,8,9,10,12,15],onnx_exec:[4,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:[4,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:[4,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:[4,5,15],relat:2,remot:8,remote_exec:[4,5,15],remov:[12,14],remove_by_nam:14,remove_prefix:14,renam:8,rename_tensor:8,reorder:[4,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:[4,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:[4,5,11],roundandclipthreshold:13,roundup_to_integer_multipl:14,row:10,rtlsim:[8,10],rtlsim_exec:[4,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:[4,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:[4,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:[4,5,12,15],streamingfclayer_batch:[4,5,9,12],streamingmaxpool_batch:[4,5,9],streamlin:[4,5,11],string:[6,14],stringlength:14,strm_decl:10,structur:6,style:2,sub:11,subdirectori:12,subgraph:8,submodul:[4,5,15],subpackag:[4,15],subset:6,success:12,suitabl:10,sure:1,surviv:14,synth_pynq_proj:[4,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:[4,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:[4,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:[4,5,9,12],tmem:10,togeth:12,toggle_clk:10,token:1,tool:[1,2],topolog:[4,5,15],train:[1,2],transform:[4,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:[4,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:[4,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,4,5],xdnn:[],xilinx:2,xnorpopcount:[4,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.analysis.fpgadataflow.hls_synth_res_estimation","source_code/finn.analysis.fpgadataflow.res_estimation","source_code/finn.analysis.topology","source_code/finn.analysis.verify_custom_nodes","source_code/finn.core","source_code/finn.core.datatype","source_code/finn.core.execute_custom_node","source_code/finn.core.modelwrapper","source_code/finn.core.onnx_exec","source_code/finn.core.remote_exec","source_code/finn.core.rtlsim_exec","source_code/finn.custom_op","source_code/finn.custom_op.fpgadataflow","source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator","source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch","source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch","source_code/finn.custom_op.fpgadataflow.templates","source_code/finn.custom_op.fpgadataflow.tlastmarker","source_code/finn.custom_op.multithreshold","source_code/finn.custom_op.registry","source_code/finn.custom_op.streamingdataflowpartition","source_code/finn.custom_op.xnorpopcount","source_code/finn.transformation","source_code/finn.transformation.batchnorm_to_affine","source_code/finn.transformation.bipolar_to_xnor","source_code/finn.transformation.fold_constants","source_code/finn.transformation.fpgadataflow","source_code/finn.transformation.fpgadataflow.cleanup","source_code/finn.transformation.fpgadataflow.codegen_ipgen","source_code/finn.transformation.fpgadataflow.codegen_ipstitch","source_code/finn.transformation.fpgadataflow.codegen_npysim","source_code/finn.transformation.fpgadataflow.compile","source_code/finn.transformation.fpgadataflow.convert_to_hls_layers","source_code/finn.transformation.fpgadataflow.create_dataflow_partition","source_code/finn.transformation.fpgadataflow.hlssynth_ipgen","source_code/finn.transformation.fpgadataflow.insert_tlastmarker","source_code/finn.transformation.fpgadataflow.make_deployment","source_code/finn.transformation.fpgadataflow.make_pynq_driver","source_code/finn.transformation.fpgadataflow.make_pynq_proj","source_code/finn.transformation.fpgadataflow.set_exec_mode","source_code/finn.transformation.fpgadataflow.synth_pynq_proj","source_code/finn.transformation.fpgadataflow.templates","source_code/finn.transformation.general","source_code/finn.transformation.infer_datatypes","source_code/finn.transformation.infer_shapes","source_code/finn.transformation.streamline","source_code/finn.transformation.streamline.absorb","source_code/finn.transformation.streamline.collapse_repeated","source_code/finn.transformation.streamline.reorder","source_code/finn.transformation.streamline.round_thresholds","source_code/finn.transformation.streamline.sign_to_thres","source_code/finn.util","source_code/finn.util.basic","source_code/finn.util.data_packing","source_code/finn.util.fpgadataflow","source_code/finn.util.onnx","source_code/finn.util.test","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.analysis.fpgadataflow.hls_synth_res_estimation.rst","source_code/finn.analysis.fpgadataflow.res_estimation.rst","source_code/finn.analysis.topology.rst","source_code/finn.analysis.verify_custom_nodes.rst","source_code/finn.core.rst","source_code/finn.core.datatype.rst","source_code/finn.core.execute_custom_node.rst","source_code/finn.core.modelwrapper.rst","source_code/finn.core.onnx_exec.rst","source_code/finn.core.remote_exec.rst","source_code/finn.core.rtlsim_exec.rst","source_code/finn.custom_op.rst","source_code/finn.custom_op.fpgadataflow.rst","source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.rst","source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.rst","source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.rst","source_code/finn.custom_op.fpgadataflow.templates.rst","source_code/finn.custom_op.fpgadataflow.tlastmarker.rst","source_code/finn.custom_op.multithreshold.rst","source_code/finn.custom_op.registry.rst","source_code/finn.custom_op.streamingdataflowpartition.rst","source_code/finn.custom_op.xnorpopcount.rst","source_code/finn.transformation.rst","source_code/finn.transformation.batchnorm_to_affine.rst","source_code/finn.transformation.bipolar_to_xnor.rst","source_code/finn.transformation.fold_constants.rst","source_code/finn.transformation.fpgadataflow.rst","source_code/finn.transformation.fpgadataflow.cleanup.rst","source_code/finn.transformation.fpgadataflow.codegen_ipgen.rst","source_code/finn.transformation.fpgadataflow.codegen_ipstitch.rst","source_code/finn.transformation.fpgadataflow.codegen_npysim.rst","source_code/finn.transformation.fpgadataflow.compile.rst","source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.rst","source_code/finn.transformation.fpgadataflow.create_dataflow_partition.rst","source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.rst","source_code/finn.transformation.fpgadataflow.insert_tlastmarker.rst","source_code/finn.transformation.fpgadataflow.make_deployment.rst","source_code/finn.transformation.fpgadataflow.make_pynq_driver.rst","source_code/finn.transformation.fpgadataflow.make_pynq_proj.rst","source_code/finn.transformation.fpgadataflow.set_exec_mode.rst","source_code/finn.transformation.fpgadataflow.synth_pynq_proj.rst","source_code/finn.transformation.fpgadataflow.templates.rst","source_code/finn.transformation.general.rst","source_code/finn.transformation.infer_datatypes.rst","source_code/finn.transformation.infer_shapes.rst","source_code/finn.transformation.streamline.rst","source_code/finn.transformation.streamline.absorb.rst","source_code/finn.transformation.streamline.collapse_repeated.rst","source_code/finn.transformation.streamline.reorder.rst","source_code/finn.transformation.streamline.round_thresholds.rst","source_code/finn.transformation.streamline.sign_to_thres.rst","source_code/finn.util.rst","source_code/finn.util.basic.rst","source_code/finn.util.data_packing.rst","source_code/finn.util.fpgadataflow.rst","source_code/finn.util.onnx.rst","source_code/finn.util.test.rst","source_code/modules.rst"],objects:{"":{finn:[5,0,0,"-"]},"finn.analysis":{fpgadataflow:[7,0,0,"-"],topology:[10,0,0,"-"],verify_custom_nodes:[11,0,0,"-"]},"finn.analysis.fpgadataflow":{hls_synth_res_estimation:[8,0,0,"-"],res_estimation:[9,0,0,"-"]},"finn.analysis.fpgadataflow.hls_synth_res_estimation":{hls_synth_res_estimation:[8,1,1,""]},"finn.analysis.fpgadataflow.res_estimation":{res_estimation:[9,1,1,""]},"finn.analysis.topology":{all_tensors_f32:[10,1,1,""],get_per_tensor_fanouts:[10,1,1,""],is_linear:[10,1,1,""],node_inputs_in_expected_order:[10,1,1,""]},"finn.analysis.verify_custom_nodes":{verify_nodes:[11,1,1,""]},"finn.core":{datatype:[13,0,0,"-"],execute_custom_node:[14,0,0,"-"],modelwrapper:[15,0,0,"-"],onnx_exec:[16,0,0,"-"],remote_exec:[17,0,0,"-"],rtlsim_exec:[18,0,0,"-"]},"finn.core.datatype":{DataType:[13,2,1,""]},"finn.core.datatype.DataType":{BINARY:[13,3,1,""],BIPOLAR:[13,3,1,""],FLOAT32:[13,3,1,""],INT16:[13,3,1,""],INT2:[13,3,1,""],INT32:[13,3,1,""],INT3:[13,3,1,""],INT4:[13,3,1,""],INT8:[13,3,1,""],TERNARY:[13,3,1,""],UINT16:[13,3,1,""],UINT2:[13,3,1,""],UINT32:[13,3,1,""],UINT3:[13,3,1,""],UINT4:[13,3,1,""],UINT8:[13,3,1,""],allowed:[13,4,1,""],bitwidth:[13,4,1,""],get_hls_datatype_str:[13,4,1,""],get_num_possible_values:[13,4,1,""],get_smallest_possible:[13,4,1,""],is_integer:[13,4,1,""],max:[13,4,1,""],min:[13,4,1,""],signed:[13,4,1,""]},"finn.core.execute_custom_node":{execute_custom_node:[14,1,1,""]},"finn.core.modelwrapper":{ModelWrapper:[15,2,1,""]},"finn.core.modelwrapper.ModelWrapper":{analysis:[15,4,1,""],check_all_tensor_shapes_specified:[15,4,1,""],check_compatibility:[15,4,1,""],find_consumer:[15,4,1,""],find_producer:[15,4,1,""],get_all_tensor_names:[15,4,1,""],get_initializer:[15,4,1,""],get_metadata_prop:[15,4,1,""],get_tensor_datatype:[15,4,1,""],get_tensor_fanout:[15,4,1,""],get_tensor_shape:[15,4,1,""],get_tensor_valueinfo:[15,4,1,""],graph:[15,4,1,""],make_empty_exec_context:[15,4,1,""],make_new_valueinfo_name:[15,4,1,""],model:[15,4,1,""],rename_tensor:[15,4,1,""],save:[15,4,1,""],set_initializer:[15,4,1,""],set_metadata_prop:[15,4,1,""],set_tensor_datatype:[15,4,1,""],set_tensor_shape:[15,4,1,""],transform:[15,4,1,""]},"finn.core.onnx_exec":{compare_execution:[16,1,1,""],execute_node:[16,1,1,""],execute_onnx:[16,1,1,""],execute_onnx_and_make_model:[16,1,1,""]},"finn.core.remote_exec":{remote_exec:[17,1,1,""]},"finn.core.rtlsim_exec":{rtlsim_exec:[18,1,1,""]},"finn.custom_op":{CustomOp:[19,2,1,""],fpgadataflow:[20,0,0,"-"],multithreshold:[26,0,0,"-"],registry:[27,0,0,"-"],streamingdataflowpartition:[28,0,0,"-"],xnorpopcount:[29,0,0,"-"]},"finn.custom_op.CustomOp":{execute_node:[19,4,1,""],get_nodeattr:[19,4,1,""],get_nodeattr_types:[19,4,1,""],infer_node_datatype:[19,4,1,""],make_shape_compatible_op:[19,4,1,""],set_nodeattr:[19,4,1,""],verify_node:[19,4,1,""]},"finn.custom_op.fpgadataflow":{HLSCustomOp:[20,2,1,""],convolutioninputgenerator:[21,0,0,"-"],streamingfclayer_batch:[22,0,0,"-"],streamingmaxpool_batch:[23,0,0,"-"],templates:[24,0,0,"-"],tlastmarker:[25,0,0,"-"]},"finn.custom_op.fpgadataflow.HLSCustomOp":{blackboxfunction:[20,4,1,""],bram_estimation:[20,4,1,""],code_generation_ipgen:[20,4,1,""],code_generation_npysim:[20,4,1,""],compile_singlenode_code:[20,4,1,""],dataoutstrm:[20,4,1,""],defines:[20,4,1,""],docompute:[20,4,1,""],dynamic_input_to_npy:[20,4,1,""],exec_precompiled_singlenode_model:[20,4,1,""],execute_node:[20,4,1,""],generate_params:[20,4,1,""],get_folded_input_shape:[20,4,1,""],get_folded_output_shape:[20,4,1,""],get_instream_width:[20,4,1,""],get_nodeattr_types:[20,4,1,""],get_number_output_values:[20,4,1,""],get_outstream_width:[20,4,1,""],global_includes:[20,4,1,""],ipgen_singlenode_code:[20,4,1,""],lut_estimation:[20,4,1,""],node_res_estimation:[20,4,1,""],npy_to_dynamic_output:[20,4,1,""],pragmas:[20,4,1,""],read_npy_data:[20,4,1,""],reset_rtlsim:[20,4,1,""],rtlsim:[20,4,1,""],save_as_npy:[20,4,1,""],strm_decl:[20,4,1,""],toggle_clk:[20,4,1,""]},"finn.custom_op.fpgadataflow.convolutioninputgenerator":{ConvolutionInputGenerator:[21,2,1,""]},"finn.custom_op.fpgadataflow.convolutioninputgenerator.ConvolutionInputGenerator":{blackboxfunction:[21,4,1,""],bram_estimation:[21,4,1,""],dataoutstrm:[21,4,1,""],defines:[21,4,1,""],docompute:[21,4,1,""],execute_node:[21,4,1,""],get_input_datatype:[21,4,1,""],get_nodeattr_types:[21,4,1,""],get_number_output_values:[21,4,1,""],get_output_datatype:[21,4,1,""],get_stream_width:[21,4,1,""],global_includes:[21,4,1,""],infer_node_datatype:[21,4,1,""],lut_estimation:[21,4,1,""],make_shape_compatible_op:[21,4,1,""],pragmas:[21,4,1,""],read_npy_data:[21,4,1,""],save_as_npy:[21,4,1,""],strm_decl:[21,4,1,""],verify_node:[21,4,1,""]},"finn.custom_op.fpgadataflow.streamingfclayer_batch":{StreamingFCLayer_Batch:[22,2,1,""]},"finn.custom_op.fpgadataflow.streamingfclayer_batch.StreamingFCLayer_Batch":{blackboxfunction:[22,4,1,""],bram_estimation:[22,4,1,""],calc_tmem:[22,4,1,""],calc_wmem:[22,4,1,""],dataoutstrm:[22,4,1,""],defines:[22,4,1,""],docompute:[22,4,1,""],execute_node:[22,4,1,""],generate_params:[22,4,1,""],get_folded_input_shape:[22,4,1,""],get_folded_output_shape:[22,4,1,""],get_hls_compatible_threshold_tensor:[22,4,1,""],get_hls_compatible_weight_tensor:[22,4,1,""],get_input_datatype:[22,4,1,""],get_instream_width:[22,4,1,""],get_nodeattr_types:[22,4,1,""],get_number_output_values:[22,4,1,""],get_output_datatype:[22,4,1,""],get_outstream_width:[22,4,1,""],get_template_param_values:[22,4,1,""],get_weight_datatype:[22,4,1,""],global_includes:[22,4,1,""],infer_node_datatype:[22,4,1,""],lut_estimation:[22,4,1,""],make_shape_compatible_op:[22,4,1,""],pragmas:[22,4,1,""],read_npy_data:[22,4,1,""],save_as_npy:[22,4,1,""],strm_decl:[22,4,1,""],verify_node:[22,4,1,""]},"finn.custom_op.fpgadataflow.streamingmaxpool_batch":{StreamingMaxPool_Batch:[23,2,1,""]},"finn.custom_op.fpgadataflow.streamingmaxpool_batch.StreamingMaxPool_Batch":{blackboxfunction:[23,4,1,""],bram_estimation:[23,4,1,""],dataoutstrm:[23,4,1,""],defines:[23,4,1,""],docompute:[23,4,1,""],get_nodeattr_types:[23,4,1,""],get_number_output_values:[23,4,1,""],global_includes:[23,4,1,""],infer_node_datatype:[23,4,1,""],lut_estimation:[23,4,1,""],make_shape_compatible_op:[23,4,1,""],pragmas:[23,4,1,""],read_npy_data:[23,4,1,""],save_as_npy:[23,4,1,""],strm_decl:[23,4,1,""],verify_node:[23,4,1,""]},"finn.custom_op.fpgadataflow.tlastmarker":{TLastMarker:[25,2,1,""]},"finn.custom_op.fpgadataflow.tlastmarker.TLastMarker":{blackboxfunction:[25,4,1,""],dataoutstrm:[25,4,1,""],defines:[25,4,1,""],docompute:[25,4,1,""],execute_node:[25,4,1,""],get_folded_input_shape:[25,4,1,""],get_folded_output_shape:[25,4,1,""],get_instream_width:[25,4,1,""],get_nodeattr_types:[25,4,1,""],get_number_output_values:[25,4,1,""],get_outstream_width:[25,4,1,""],global_includes:[25,4,1,""],infer_node_datatype:[25,4,1,""],make_shape_compatible_op:[25,4,1,""],pragmas:[25,4,1,""],read_npy_data:[25,4,1,""],save_as_npy:[25,4,1,""],strm_decl:[25,4,1,""],verify_node:[25,4,1,""]},"finn.custom_op.multithreshold":{MultiThreshold:[26,2,1,""],compare:[26,1,1,""],multithreshold:[26,1,1,""]},"finn.custom_op.multithreshold.MultiThreshold":{execute_node:[26,4,1,""],get_nodeattr_types:[26,4,1,""],infer_node_datatype:[26,4,1,""],make_shape_compatible_op:[26,4,1,""],verify_node:[26,4,1,""]},"finn.custom_op.registry":{getCustomOp:[27,1,1,""]},"finn.custom_op.streamingdataflowpartition":{StreamingDataflowPartition:[28,2,1,""]},"finn.custom_op.streamingdataflowpartition.StreamingDataflowPartition":{execute_node:[28,4,1,""],get_nodeattr_types:[28,4,1,""],infer_node_datatype:[28,4,1,""],make_shape_compatible_op:[28,4,1,""],verify_node:[28,4,1,""]},"finn.custom_op.xnorpopcount":{XnorPopcountMatMul:[29,2,1,""],xnorpopcountmatmul:[29,1,1,""]},"finn.custom_op.xnorpopcount.XnorPopcountMatMul":{execute_node:[29,4,1,""],get_nodeattr_types:[29,4,1,""],infer_node_datatype:[29,4,1,""],make_shape_compatible_op:[29,4,1,""],verify_node:[29,4,1,""]},"finn.transformation":{Transformation:[30,2,1,""],batchnorm_to_affine:[31,0,0,"-"],bipolar_to_xnor:[32,0,0,"-"],fold_constants:[33,0,0,"-"],fpgadataflow:[34,0,0,"-"],general:[50,0,0,"-"],infer_datatypes:[51,0,0,"-"],infer_shapes:[52,0,0,"-"],streamline:[53,0,0,"-"]},"finn.transformation.Transformation":{apply:[30,4,1,""]},"finn.transformation.batchnorm_to_affine":{BatchNormToAffine:[31,2,1,""]},"finn.transformation.batchnorm_to_affine.BatchNormToAffine":{apply:[31,4,1,""]},"finn.transformation.bipolar_to_xnor":{ConvertBipolarMatMulToXnorPopcount:[32,2,1,""]},"finn.transformation.bipolar_to_xnor.ConvertBipolarMatMulToXnorPopcount":{apply:[32,4,1,""]},"finn.transformation.fold_constants":{FoldConstants:[33,2,1,""]},"finn.transformation.fold_constants.FoldConstants":{apply:[33,4,1,""]},"finn.transformation.fpgadataflow":{cleanup:[35,0,0,"-"],codegen_ipgen:[36,0,0,"-"],codegen_ipstitch:[37,0,0,"-"],codegen_npysim:[38,0,0,"-"],compile:[39,0,0,"-"],convert_to_hls_layers:[40,0,0,"-"],create_dataflow_partition:[41,0,0,"-"],hlssynth_ipgen:[42,0,0,"-"],insert_tlastmarker:[43,0,0,"-"],make_deployment:[44,0,0,"-"],make_pynq_driver:[45,0,0,"-"],make_pynq_proj:[46,0,0,"-"],set_exec_mode:[47,0,0,"-"],synth_pynq_proj:[48,0,0,"-"],templates:[49,0,0,"-"]},"finn.transformation.fpgadataflow.cleanup":{CleanUp:[35,2,1,""]},"finn.transformation.fpgadataflow.cleanup.CleanUp":{apply:[35,4,1,""]},"finn.transformation.fpgadataflow.codegen_ipgen":{CodeGen_ipgen:[36,2,1,""]},"finn.transformation.fpgadataflow.codegen_ipgen.CodeGen_ipgen":{apply:[36,4,1,""]},"finn.transformation.fpgadataflow.codegen_ipstitch":{CodeGen_ipstitch:[37,2,1,""]},"finn.transformation.fpgadataflow.codegen_ipstitch.CodeGen_ipstitch":{apply:[37,4,1,""]},"finn.transformation.fpgadataflow.codegen_npysim":{CodeGen_npysim:[38,2,1,""]},"finn.transformation.fpgadataflow.codegen_npysim.CodeGen_npysim":{apply:[38,4,1,""]},"finn.transformation.fpgadataflow.compile":{Compile:[39,2,1,""]},"finn.transformation.fpgadataflow.compile.Compile":{apply:[39,4,1,""]},"finn.transformation.fpgadataflow.convert_to_hls_layers":{InferBinaryStreamingFCLayer:[40,2,1,""]},"finn.transformation.fpgadataflow.convert_to_hls_layers.InferBinaryStreamingFCLayer":{apply:[40,4,1,""]},"finn.transformation.fpgadataflow.create_dataflow_partition":{CreateDataflowPartition:[41,2,1,""]},"finn.transformation.fpgadataflow.create_dataflow_partition.CreateDataflowPartition":{apply:[41,4,1,""]},"finn.transformation.fpgadataflow.hlssynth_ipgen":{HLSSynth_IPGen:[42,2,1,""]},"finn.transformation.fpgadataflow.hlssynth_ipgen.HLSSynth_IPGen":{apply:[42,4,1,""]},"finn.transformation.fpgadataflow.insert_tlastmarker":{InsertTLastMarker:[43,2,1,""]},"finn.transformation.fpgadataflow.insert_tlastmarker.InsertTLastMarker":{apply:[43,4,1,""]},"finn.transformation.fpgadataflow.make_deployment":{DeployToPYNQ:[44,2,1,""]},"finn.transformation.fpgadataflow.make_deployment.DeployToPYNQ":{apply:[44,4,1,""]},"finn.transformation.fpgadataflow.make_pynq_driver":{MakePYNQDriver:[45,2,1,""]},"finn.transformation.fpgadataflow.make_pynq_driver.MakePYNQDriver":{apply:[45,4,1,""]},"finn.transformation.fpgadataflow.make_pynq_proj":{MakePYNQProject:[46,2,1,""]},"finn.transformation.fpgadataflow.make_pynq_proj.MakePYNQProject":{apply:[46,4,1,""]},"finn.transformation.fpgadataflow.set_exec_mode":{SetExecMode:[47,2,1,""]},"finn.transformation.fpgadataflow.set_exec_mode.SetExecMode":{apply:[47,4,1,""]},"finn.transformation.fpgadataflow.synth_pynq_proj":{SynthPYNQProject:[48,2,1,""]},"finn.transformation.fpgadataflow.synth_pynq_proj.SynthPYNQProject":{apply:[48,4,1,""]},"finn.transformation.general":{ConvertSubToAdd:[50,2,1,""],GiveRandomTensorNames:[50,2,1,""],GiveReadableTensorNames:[50,2,1,""],GiveUniqueNodeNames:[50,2,1,""]},"finn.transformation.general.ConvertSubToAdd":{apply:[50,4,1,""]},"finn.transformation.general.GiveRandomTensorNames":{apply:[50,4,1,""]},"finn.transformation.general.GiveReadableTensorNames":{apply:[50,4,1,""]},"finn.transformation.general.GiveUniqueNodeNames":{apply:[50,4,1,""]},"finn.transformation.infer_datatypes":{InferDataTypes:[51,2,1,""]},"finn.transformation.infer_datatypes.InferDataTypes":{apply:[51,4,1,""]},"finn.transformation.infer_shapes":{InferShapes:[52,2,1,""]},"finn.transformation.infer_shapes.InferShapes":{apply:[52,4,1,""]},"finn.transformation.streamline":{Streamline:[53,2,1,""],absorb:[54,0,0,"-"],collapse_repeated:[55,0,0,"-"],reorder:[56,0,0,"-"],round_thresholds:[57,0,0,"-"],sign_to_thres:[58,0,0,"-"]},"finn.transformation.streamline.Streamline":{apply:[53,4,1,""]},"finn.transformation.streamline.absorb":{Absorb1BitMulIntoMatMul:[54,2,1,""],AbsorbAddIntoMultiThreshold:[54,2,1,""],AbsorbMulIntoMultiThreshold:[54,2,1,""],FactorOutMulSignMagnitude:[54,2,1,""]},"finn.transformation.streamline.absorb.Absorb1BitMulIntoMatMul":{apply:[54,4,1,""]},"finn.transformation.streamline.absorb.AbsorbAddIntoMultiThreshold":{apply:[54,4,1,""]},"finn.transformation.streamline.absorb.AbsorbMulIntoMultiThreshold":{apply:[54,4,1,""]},"finn.transformation.streamline.absorb.FactorOutMulSignMagnitude":{apply:[54,4,1,""]},"finn.transformation.streamline.collapse_repeated":{CollapseRepeatedAdd:[55,2,1,""],CollapseRepeatedMul:[55,2,1,""],CollapseRepeatedOp:[55,2,1,""]},"finn.transformation.streamline.collapse_repeated.CollapseRepeatedOp":{apply:[55,4,1,""]},"finn.transformation.streamline.reorder":{MoveAddPastMul:[56,2,1,""],MoveScalarAddPastMatMul:[56,2,1,""],MoveScalarMulPastMatMul:[56,2,1,""]},"finn.transformation.streamline.reorder.MoveAddPastMul":{apply:[56,4,1,""]},"finn.transformation.streamline.reorder.MoveScalarAddPastMatMul":{apply:[56,4,1,""]},"finn.transformation.streamline.reorder.MoveScalarMulPastMatMul":{apply:[56,4,1,""]},"finn.transformation.streamline.round_thresholds":{RoundAndClipThresholds:[57,2,1,""]},"finn.transformation.streamline.round_thresholds.RoundAndClipThresholds":{apply:[57,4,1,""]},"finn.transformation.streamline.sign_to_thres":{ConvertSignToThres:[58,2,1,""]},"finn.transformation.streamline.sign_to_thres.ConvertSignToThres":{apply:[58,4,1,""]},"finn.util":{basic:[60,0,0,"-"],data_packing:[61,0,0,"-"],fpgadataflow:[62,0,0,"-"],onnx:[63,0,0,"-"],test:[64,0,0,"-"]},"finn.util.basic":{CppBuilder:[60,2,1,""],calculate_signed_dot_prod_range:[60,1,1,""],gen_finn_dt_tensor:[60,1,1,""],get_by_name:[60,1,1,""],get_finn_root:[60,1,1,""],interleave_matrix_outer_dim_from_partitions:[60,1,1,""],make_build_dir:[60,1,1,""],pad_tensor_to_multiple_of:[60,1,1,""],random_string:[60,1,1,""],remove_by_name:[60,1,1,""],roundup_to_integer_multiple:[60,1,1,""]},"finn.util.basic.CppBuilder":{append_includes:[60,4,1,""],append_sources:[60,4,1,""],build:[60,4,1,""],set_executable_path:[60,4,1,""]},"finn.util.data_packing":{array2hexstring:[61,1,1,""],finnpy_to_packed_bytearray:[61,1,1,""],hexstring2npbytearray:[61,1,1,""],npbytearray2hexstring:[61,1,1,""],npy_to_rtlsim_input:[61,1,1,""],numpy_to_hls_code:[61,1,1,""],pack_innermost_dim_as_hex_string:[61,1,1,""],packed_bytearray_to_finnpy:[61,1,1,""],rtlsim_output_to_npy:[61,1,1,""],unpack_innermost_dim_from_hex_string:[61,1,1,""]},"finn.util.fpgadataflow":{IPGenBuilder:[62,2,1,""],pyverilate_stitched_ip:[62,1,1,""]},"finn.util.fpgadataflow.IPGenBuilder":{append_tcl:[62,4,1,""],build:[62,4,1,""],set_ipgen_path:[62,4,1,""]},"finn.util.onnx":{valueinfo_to_tensor:[63,1,1,""]},"finn.util.test":{get_test_model_def_fxn:[64,1,1,""],get_test_model_trained:[64,1,1,""],get_test_model_untrained:[64,1,1,""],get_trained_checkpoint:[64,1,1,""]},finn:{analysis:[6,0,0,"-"],core:[12,0,0,"-"],custom_op:[19,0,0,"-"],transformation:[30,0,0,"-"],util:[59,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":61,"0x07":61,"0x0e":61,"0x0f01":61,"0xb":61,"0xe":61,"600px":[],"abstract":[19,20,30],"boolean":16,"class":[13,15,19,20,21,22,23,25,26,28,29,30,31,32,33,35,36,37,38,39,40,41,42,43,44,45,46,47,48,50,51,52,53,54,55,56,57,58,60,62],"const":33,"default":[19,20,21,22,23,25,26,28,29,30],"enum":13,"final":16,"float":61,"function":[1,15,16,30,60],"import":1,"new":[1,2,15,16],"return":[6,8,9,10,11,13,15,16,19,20,21,22,23,25,26,27,28,29,30,55,60,61,62],"static":10,"true":[15,16,61],"try":1,"var":[20,21,22,23,25],For:57,HLS:[2,13],IPs:37,PEs:22,The:[1,2,6,15,30,37,41,45,48,56,61],There:1,Use:[18,60],abc:[19,30],abit:64,about:[2,6,11,44],abov:1,absorb1bitmulintomatmul:54,absorb:[4,5,30,40,53],absorbaddintomultithreshold:54,absorbmulintomultithreshold:54,acceler:[1,45],account:15,action:41,activ:[15,16],add:[31,50,54,56],adding:1,addit:1,addition:57,address:44,after:60,aim:56,align:[],all:[1,10,11,15,16,19,21,22,23,25,26,28,29,32,36,37,38,39,42,44,46,47,50,51,60,63],all_tensors_f32:10,allow:[13,15],alreadi:[45,46],also:[19,21,22,23,25,26,28,29,37,40],amount:60,analysi:[4,5,15,65],analysis_fxn:15,anaylsis_fxn:15,ani:[1,15,30,31,35,40,60,61],annot:[10,19,21,22,23,25,26,28,29],anoth:41,append_includ:60,append_sourc:60,append_tcl:62,appli:[15,30,31,32,33,35,36,37,38,39,40,41,42,43,44,45,46,47,48,50,51,52,53,54,55,56,57,58],apply_rep:30,appropri:[1,50],arbitrari:61,architectur:2,argument:1,around:15,arrai:61,array2hexstr:61,arxiv:53,assign:15,associ:[15,32],assum:61,attribut:[11,19,20,21,22,23,25,26,28,29,37,41,45,46,47],attribute_nam:[19,20,21,22,23,25,26,28,29],attributeproto:[19,20,21,22,23,25,26,28,29],back:1,backend:[37,46],base:[13,15,19,20,21,22,23,25,26,28,29,30,31,32,33,35,36,37,38,39,40,41,42,43,44,45,46,47,48,50,51,52,53,54,55,56,57,58,60,62],basic:[4,5,59,61],batchnorm:31,batchnorm_to_affin:[4,5,30],batchnormtoaffin:31,been:[37,45,46],befor:60,between:[22,60],binari:[13,22,40,54,61],bipolar:[13,22,32,54,61],bipolar_to_xnor:[4,5,30],bit:[13,61],bitfil:1,bitwidth:13,blackboxfunct:[20,21,22,23,25],block:[37,46],blott:22,board:44,bool:[10,30],both:60,bram_estim:[20,21,22,23],brevita:2,brien:22,browser:1,build:[60,62],built:11,calc_tmem:22,calc_wmem:22,calcul:22,calculate_signed_dot_prod_rang:60,call:[1,14,22,30,37],can:[1,2,13,15,30,37,54,56,60,61],cannot:30,center:[],centerpiec:2,certain:6,chang:[1,15,30],check:[10,11,13,15,19,21,22,23,25,26,28,29],check_all_tensor_shapes_specifi:15,check_compat:15,cleanup:[4,5,30,34],clk:[20,36],clone:[1,60],code:[36,38,45,61],code_gen_dir:[60,62],code_generation_ipgen:20,code_generation_npysim:20,codegen_ipgen:[4,5,30,34,37],codegen_ipstitch:[4,5,30,34,46],codegen_npysim:[4,5,30,34],collaps:[55,56],collapse_rep:[4,5,30,53],collapserepeatedadd:55,collapserepeatedmul:55,collapserepeatedop:55,collect:[1,44],colloqui:2,come:[1,10],command:1,commun:2,compar:[16,26],compare_execut:16,compare_fxn:16,compat:[15,19,21,22,23,25,26,28,29],compil:[2,4,5,30,34,42],compile_singlenode_cod:20,complet:1,compon:2,comput:[1,15],consecut:55,constant:[10,15,54,55],construct:2,consum:15,contain:[1,2,16,19,41,60],content:[4,65],context:[14,15,16,19,20,21,22,25,26,28,29],contribut:2,convent:6,convert:[1,22,32,40,50,58,61],convert_to_hls_lay:[4,5,30,34],convertbipolarmatmultoxnorpopcount:32,convertsigntothr:58,convertsubtoadd:50,convolutioninputgener:[4,5,19,20],copi:[15,30,44],core:[4,5,65],corner:2,correct:32,correctli:[1,11,19,21,22,23,25,26,28,29,45],correspond:[2,13,19,21,22,23,25,26,28,29],count:20,cpp_file:60,cppbuilder:60,creat:[1,15,37,45,46,60,63],create_dataflow_partit:[4,5,30,34],createdataflowpartit:41,current:[2,15],custom:[1,2,11,14,16],custom_op:[4,5,65],customop:[19,20,21,22,23,25,26,27,28,29],data:[19,45,61],data_pack:[4,5,59],dataflow:[2,16,41],dataoutstrm:[20,21,22,23,25],datatyp:[4,5,12,15,19,21,22,23,25,26,28,29,51,60,61],debug:16,declar:30,deep:[2,15,22,30],default_v:[19,20,21,22,23,25,26,28,29],default_valu:[19,20,21,22,23,25,26,28,29],defin:[20,21,22,23,25],depend:1,deploi:1,deploy:44,deploytopynq:44,design:[1,37],detail:2,develop:2,dict:[15,16,19,20,21,22,23,25,26,28,29],dictionari:[6,10,15],differ:1,digit:[60,61],dimens:[60,61],dimension:61,dir:[37,45,46,60],directori:[1,44,60],distr_pad:60,divis:60,dnn:[],doc:2,docker:60,dockerfil:1,docomput:[20,21,22,23,25],doe:1,don:30,done:10,dot:60,down:1,driver:45,dt_a:60,dt_b:60,dtype:[10,15,19,20,21,22,23,25,26,28,29,61],dynam:10,dynamic_input_to_npi:20,each:[2,10,16,50,56,60,61],editor:1,effect:30,either:1,element:[60,61],embed:15,emit:61,emphasi:2,empti:15,end:22,ensur:[22,43,52,60,61],entir:1,enumer:[13,50],environ:1,equal:[19,21,22,23,25,26,28,29],equival:55,estim:[8,9],even:30,evenli:60,everi:52,everyth:1,exampl:[1,61],excel:1,exec_precompiled_singlenode_model:20,execut:[14,15,16,18,19,20,21,22,25,26,28,29],execute_custom_nod:[4,5,12],execute_nod:[16,19,20,21,22,25,26,28,29],execute_onnx:16,execute_onnx_and_make_model:16,execution_context:[17,18],exist:[27,60],exit:60,expect:[10,15,19,21,22,23,25,26,28,29,44],experi:2,experiment:2,explor:[2,15,22],expos:15,extens:1,extra:[1,10,60],extract:[6,8],f5c6bd32ae93ec103a88152214baedff4ce1850d81065bfc:1,factor:60,factoroutmulsignmagnitud:54,fals:[15,16,30,60,61],familiar:1,fan:10,fast:22,fewest:13,field:[37,45,46,60],file:[1,15,35,44,60,61],filenam:[15,41],find:15,find_consum:15,find_produc:15,finn:4,finn_dt:60,finnpy_to_packed_bytearrai:61,first:[10,54],fix:[30,61],flatten:61,float32:[10,13],flow:[],fold_const:[4,5,30],foldconst:33,folder:[1,37,60],follow:[1,2,10,40],form:22,forward:1,found:[2,37],four:61,fpga:[1,2],fpgadataflow:[4,5,6,19,30,59],fpgapart:[20,36,37],framework:[2,22],fraser:22,from:[1,2,8,15,16,37,46,60,61,63],full:16,further:30,gambardella:22,gen_finn_dt_tensor:60,gener:[2,4,5,30,35,36,37,38,45,60,61],generate_param:[20,22],get:[15,19],get_all_tensor_nam:15,get_by_nam:60,get_finn_root:60,get_folded_input_shap:[20,22,25],get_folded_output_shap:[20,22,25],get_hls_compatible_threshold_tensor:22,get_hls_compatible_weight_tensor:22,get_hls_datatype_str:13,get_initi:15,get_input_datatyp:[21,22],get_instream_width:[20,22,25],get_metadata_prop:15,get_nodeattr:19,get_nodeattr_typ:[19,20,21,22,23,25,26,28,29],get_num_possible_valu:13,get_number_output_valu:[20,21,22,23,25],get_output_datatyp:[21,22],get_outstream_width:[20,22,25],get_per_tensor_fanout:10,get_smallest_poss:13,get_stream_width:21,get_template_param_valu:22,get_tensor_datatyp:15,get_tensor_fanout:15,get_tensor_shap:15,get_tensor_valueinfo:15,get_test_model_def_fxn:64,get_test_model_train:64,get_test_model_untrain:64,get_trained_checkpoint:64,get_weight_datatyp:22,getcustomop:27,github:2,give:[1,50,55],give_unique_node_nam:50,given:[9,10,13,15,16,18,19,20,21,22,25,26,27,28,29,60,61,62],giverandomtensornam:50,givereadabletensornam:50,giveuniquenodenam:50,global_includ:[20,21,22,23,25],graph:[6,10,11,14,15,16,19,20,21,22,25,26,28,29,37,41,43,46,48,50],graphic:2,guarante:30,guid:[4,5],hand:2,has:[10,15,41,52,61],have:[1,10,15,30,37,45,46,56],height:[],help:1,hex:61,hexstr:61,hexstring2npbytearrai:61,high:1,highli:2,hls_synth_res_estim:[4,5,6,7],hls_var_nam:61,hlscustomop:[20,21,22,23,25],hlslib:[2,22],hlssynth_ipgen:[4,5,30,34],homepag:2,host:[1,60],how:[4,5,61],http:1,human:50,imag:[],img:[],immedi:40,implement:[13,14],includ:[2,15,16,45,46],index:[],indic:[16,19,20,21,22,23,25,26,28,29,30,41],infer:[1,2,15,19,21,22,23,25,26,28,29,51,61],infer_datatyp:[4,5,30],infer_node_datatyp:[19,21,22,23,25,26,28,29],infer_shap:[4,5,30],inferbinarystreamingfclay:40,inferdatatyp:51,infershap:52,infinit:30,info:[51,61],info_messag:11,inform:[6,44],infrastructur:46,inherit:30,initi:[10,15,16],innermost:61,inp0:29,inp1:29,inp:20,input:[10,11,14,15,16,19,21,22,23,25,26,28,29,30,32,33,51,57,61],input_dict:16,input_dtyp:61,input_fil:61,insert:[43,60],insert_tlastmark:[4,5,30,34],inserttlastmark:43,insid:[1,19],instal:1,instanc:[15,19,20,21,22,25,26,27,28,29,58],instanti:37,instead:60,int16:13,int2:13,int32:13,int3:13,int4:13,int8:13,integ:[13,57,60,61],intend:[],interfac:45,interleav:22,interleave_matrix_outer_dim_from_partit:60,intermedi:[15,16,51],intern:50,involv:1,ipgen_singlenode_cod:20,ipgenbuild:62,is_integ:13,is_linear:10,item:60,jupyt:2,kei:15,know:30,lab:2,lambda:16,largest:13,launch:1,layer:[31,37,40],lead:61,learn:[2,22],leeser:22,len:60,let:30,letter:60,librari:2,library_path:60,like:1,linear:[10,15],link:[1,2],list:[11,15],locat:1,look:[1,10],loop:30,lut_estim:[20,21,22,23],made:[15,30],magnitud:54,mai:1,make:[1,30,44],make_build_dir:60,make_collapsed_param_fxn:55,make_deepcopi:15,make_deploy:[4,5,30,34],make_empty_exec_context:15,make_new_valueinfo_nam:15,make_project:37,make_pynq_driv:[4,5,30,34],make_pynq_proj:[4,5,30,34],make_shape_compatible_op:[19,21,22,23,25,26,28,29],makepynqdriv:45,makepynqproject:[45,46,48],mani:1,manipul:15,manual:30,matmul:[32,56],matrix:[22,54,60],max:[13,60],mean:60,meant:30,member:[19,20,21,22,23,25,26,28,29],metadata_prop:[15,37,45,46],min:[13,60],minimum:61,mixtur:10,mkdtemp:60,mode:[1,47],model:[8,9,10,11,15,16,17,18,19,20,21,22,23,25,26,28,29,30,31,32,33,35,36,37,38,39,40,41,42,43,44,45,46,47,48,50,51,52,53,54,55,56,57,58,62],model_a:16,model_b:16,model_was_chang:30,modelproto:[15,37,45,46],modelwrapp:[4,5,6,12,16,30],modul:[4,65],modular:2,more:[2,15,50,61],mount:1,move:56,moveaddpastmul:56,movescalaraddpastmatmul:56,movescalarmulpastmatmul:56,mul:[31,54,56],multidimension:61,multipl:[30,54,60,61],multipli:[54,56],multithreshold:[4,5,19,40,54,57,58],must:[19,30,37,45,46,48,55,60],mvtu:40,n_partit:60,n_thres_step:22,name:[6,8,9,13,15,16,19,50,60,61],name_field:60,ndarrai:[60,61],nearest:[57,60,61],necessari:[43,44],need:[9,19,21,22,23,25,26,28,29,30],neg:[13,57],netnam:64,netron:1,network:[1,2,22],neural:[2,22],new_nam:15,next:56,no_decl:61,node:[8,9,10,11,14,15,16,19,20,21,22,23,25,26,27,28,29,32,33,35,36,37,38,39,41,42,43,46,47,50,51,54,57,58],node_inputs_in_expected_ord:10,node_res_estim:20,non:41,none:[15,26,60,61],note:1,notebook:2,notwithstand:10,now:[10,13],npbytearrai:61,npbytearray2hexstr:61,npy:61,npy_to_dynamic_output:20,npy_to_rtlsim_input:61,number:[13,15,19,21,22,23,25,26,28,29,61],numpi:[22,60,61,63],numpy_to_hls_cod:61,object:[15,60,62],old_nam:15,onc:30,one:[10,15,41,43,60,61],ones:1,onli:[10,13,15,30,33,41,54],onlin:1,onnx:[4,5,15,16,19,20,21,22,23,25,26,27,28,29,37,45,46,59],onnx_exec:[4,5,12],onnx_model_proto:15,onnx_nod:[19,20,21,22,23,25,26,28,29],onnxruntim:16,op_nam:55,op_typ:[10,11],open:1,oper:[15,55,56,57],ops:[11,54],option:1,order:10,orig_thres_matrix:22,orig_weight_matrix:22,origin:22,other:[15,56],otherwis:[1,15,30,60],out:10,out_bia:26,out_scal:26,out_shap:61,outcom:[37,45,46],output:[14,15,16,19,21,22,23,25,26,28,29,33,51,61],output_shap:61,overlai:46,overview:2,own:1,pack:[45,61],pack_innermost_dim:61,pack_innermost_dim_as_hex_str:61,packag:[4,37,65],packed_bytearrai:61,packed_bytearray_to_finnpi:61,packedbit:61,pad:[60,61],pad_tensor_to_multiple_of:60,pad_to_dim:60,pad_to_nbit:61,page:[],pair:40,paramet:55,part:[19,61],particular:[19,21,22,23,25,26,28,29,60],partit:16,pass:[4,5,22],password:44,past:56,path:[20,22,60,61,62],per:37,perform:[1,19,21,22,23,25,26,28,29],permit:[19,20,21,22,23,25,26,28,29],place:37,platform:46,png:[],point:[1,30],port:1,posit:[22,54,60],possibl:[13,44],pragma:[20,21,22,23,25],preced:54,precid:54,precis:61,precomput:33,prefer:13,prefix:[60,61],prepend:61,preusser:22,previous:[37,46],print:1,prior:[48,50,61],process:1,produc:[6,15],product:60,project:[2,37,46,48],properti:[6,15],provid:[1,14,16],pushbutton:1,pynq:[44,45,46,48],pynq_driver_dir:45,python:[1,45,61],pyveril:[18,62],pyverilate_stitched_ip:62,qnn:[1,2],quantiz:[2,10,22],random:[50,60],random_str:60,randomli:60,rather:1,reach:30,read:2,read_npy_data:[20,21,22,23,25],readabl:50,readthedoc:[],recommend:50,refer:2,reflect:1,registri:[4,5,19],relat:2,remot:16,remote_exec:[4,5,12],remov:[35,60,61],remove_by_nam:60,remove_prefix:61,renam:15,rename_tensor:15,reorder:[4,5,30,53],repeat:[30,55],repeatedli:15,replac:[31,33],repo:1,repositori:[1,2],repositroi:[],repres:[13,61],represent:61,requir:[13,19,20,21,22,23,25,26,28,29],res_estim:[4,5,6,7],research:2,reset_rtlsim:20,reshap:22,resourc:[1,8,9],respect:60,result:[8,11,15,32,33,37,55,61],return_full_exec_context:16,returned_dict:[19,20,21,22,23,25,26,28,29],revers:61,reverse_endian:61,reverse_inn:61,right:2,root:[1,60],round:[57,60],round_threshold:[4,5,30,53],roundandclipthreshold:57,roundup_to_integer_multipl:60,row:22,rtlsim:[16,20],rtlsim_exec:[4,5,12],rtlsim_output_to_npi:61,run:[15,37,46,48],run_dock:1,same:[37,61],save:[15,61],save_as_npi:[20,21,22,23,25],scalar:[54,56],scale:[],scp:44,script:[1,37],search:[],second:[41,54],see:[53,61],seen:2,sep:22,separ:2,sequenc:61,server:1,set:[1,15,16,19,20,21,22,23,25,26,28,29,37,45,46,47,57,60,61],set_attribut:[],set_exec_mod:[4,5,30,34],set_executable_path:60,set_initi:15,set_ipgen_path:62,set_metadata_prop:15,set_nodeattr:19,set_sim_mod:[],set_tensor_datatyp:15,set_tensor_shap:15,setexecmod:47,setsimmod:[],settings64:1,sever:1,shape:[15,19,21,22,23,25,26,28,29,52,60,61],shell:46,should:[1,10,16,30],sign:[13,50,54,58,60],sign_to_thr:[4,5,30,53],sim:[20,62],sim_mod:47,simd:22,simpli:1,sinc:[16,61],singl:[1,14,16,55,56,61],small:10,smallest:13,some:[1,2,15,30],someth:1,space:[],spawn:1,specif:2,specifi:[15,52,61],split:[41,54,60],stai:2,standard:[15,19,21,22,23,25,26,28,29],stitch:[18,37,46,62],store:[19,44,61],streamingdataflowpartit:[4,5,19,41],streamingfclayer_batch:[4,5,19,20,40],streamingmaxpool_batch:[4,5,19,20],streamlin:[4,5,30],string:[11,60,61],stringlength:60,strm_decl:[20,21,22,23,25],structur:6,style:2,sub:50,subdirectori:37,subgraph:15,submodul:[4,5,65],subpackag:[4,65],subset:10,success:[37,45,46],suitabl:22,sure:1,surviv:60,synth_pynq_proj:[4,5,30,34],synthesi:[8,48],synthpynqproject:48,take:[1,6,13,16,30,55,60],taken:[2,15,16,41],target:[2,44],target_dir:44,targetbit:61,tcl:37,tcl_script:62,tempfil:60,templat:[4,5,19,20,30,34],temporari:60,tensor:[10,15,16,50,51,52,55,60,63],tensor_fanout:10,tensor_nam:[10,15],tensor_shap:[15,60],tensor_valu:15,termin:[1,43],ternari:13,test:[4,5,31,59],text:1,thei:56,them:[10,37,44,56],thi:[1,2,10,13,15,16,19,20,21,22,23,25,26,28,29,30,46,48,50,60],thing:2,thought:1,threshold:[22,26,54,57,58],time:[1,30,31],tlastmark:[4,5,19,20,43],tmem:22,togeth:37,toggle_clk:20,token:1,tool:[1,2],topolog:[4,5,6],train:[1,2],transform:[4,5,15,65],transformed_model:30,travers:6,tune:2,tupl:30,two:[2,16,41,54,55,60],type:[13,51,60,61],ubuntu:1,uint16:13,uint2:[13,61],uint32:13,uint3:13,uint4:13,uint8:[13,61],umuroglu:22,under:[2,37],uniqu:50,unpack:[45,61],unpack_innermost_dim_from_hex_str:61,unsign:[13,57],until:15,updat:[2,54],upper:2,use:2,used:[2,15,16,19,20,21,22,23,25,26,28,29,60,61],useful:[15,16],user:30,usernam:44,using:[2,16,30,50,55,60,61],util:[4,5,15,19,20,21,22,23,25,26,28,29,65],val:60,valu:[13,15,16,19,20,21,22,23,25,26,28,29,37,45,46,54,57,60,61],value_info:15,valueinfo:[15,52],valueinfo_to_tensor:63,valueinfoproto:[15,63],variabl:[1,61],vector:[54,60],verif:11,verifi:[10,19,21,22,23,25,26,28,29],verify_custom_nod:[4,5,6],verify_nod:[11,19,21,22,23,25,26,28,29],version:2,via:[14,16],view:2,visser:22,vivado:[1,2,8,13,37,46],vivado_path:1,vivado_pynq_proj:46,vivado_stitch_proj:37,wai:[1,10],want:56,wbit:64,websit:2,weight:[16,22],welcom:2,well:1,when:[10,30],where:[1,13,16,19,20,21,22,23,25,26,28,29,44,54],whether:[10,13,15,19,20,21,22,23,25,26,28,29,30],which:[1,2,15,19,20,21,22,23,25,26,28,29,37,41,55,61],width:61,without:1,wmem:22,work:[1,15,61],workspac:1,wrapper:15,write:[1,4,5],xdnn:[],xilinx:2,xnorpopcount:[4,5,19],xnorpopcountmatmul:[29,32,40],you:[1,30],your:[1,30],zero:[15,57,61,63]},titles:["FINN - End-to-End Flow","Getting Started","FINN","src","Source Code","finn package","finn.analysis package","finn.analysis.fpgadataflow package","finn.analysis.fpgadataflow.hls_synth_res_estimation module","finn.analysis.fpgadataflow.res_estimation module","finn.analysis.topology module","finn.analysis.verify_custom_nodes module","finn.core package","finn.core.datatype module","finn.core.execute_custom_node module","finn.core.modelwrapper module","finn.core.onnx_exec module","finn.core.remote_exec module","finn.core.rtlsim_exec module","finn.custom_op package","finn.custom_op.fpgadataflow package","finn.custom_op.fpgadataflow.convolutioninputgenerator module","finn.custom_op.fpgadataflow.streamingfclayer_batch module","finn.custom_op.fpgadataflow.streamingmaxpool_batch module","finn.custom_op.fpgadataflow.templates module","finn.custom_op.fpgadataflow.tlastmarker module","finn.custom_op.multithreshold module","finn.custom_op.registry module","finn.custom_op.streamingdataflowpartition module","finn.custom_op.xnorpopcount module","finn.transformation package","finn.transformation.batchnorm_to_affine module","finn.transformation.bipolar_to_xnor module","finn.transformation.fold_constants module","finn.transformation.fpgadataflow package","finn.transformation.fpgadataflow.cleanup module","finn.transformation.fpgadataflow.codegen_ipgen module","finn.transformation.fpgadataflow.codegen_ipstitch module","finn.transformation.fpgadataflow.codegen_npysim module","finn.transformation.fpgadataflow.compile module","finn.transformation.fpgadataflow.convert_to_hls_layers module","finn.transformation.fpgadataflow.create_dataflow_partition module","finn.transformation.fpgadataflow.hlssynth_ipgen module","finn.transformation.fpgadataflow.insert_tlastmarker module","finn.transformation.fpgadataflow.make_deployment module","finn.transformation.fpgadataflow.make_pynq_driver module","finn.transformation.fpgadataflow.make_pynq_proj module","finn.transformation.fpgadataflow.set_exec_mode module","finn.transformation.fpgadataflow.synth_pynq_proj module","finn.transformation.fpgadataflow.templates module","finn.transformation.general module","finn.transformation.infer_datatypes module","finn.transformation.infer_shapes module","finn.transformation.streamline package","finn.transformation.streamline.absorb module","finn.transformation.streamline.collapse_repeated module","finn.transformation.streamline.reorder module","finn.transformation.streamline.round_thresholds module","finn.transformation.streamline.sign_to_thres module","finn.util package","finn.util.basic module","finn.util.data_packing module","finn.util.fpgadataflow module","finn.util.onnx module","finn.util.test module","finn"],titleterms:{absorb:54,analysi:[6,7,8,9,10,11],basic:60,batchnorm_to_affin:31,bipolar_to_xnor:32,cleanup:35,code:4,codegen_ipgen:36,codegen_ipstitch:37,codegen_npysim:38,collapse_rep:55,compil:[1,39],content:[5,6,7,12,19,20,30,34,53,59],convert_to_hls_lay:40,convolutioninputgener:21,core:[12,13,14,15,16,17,18],create_dataflow_partit:41,custom_op:[19,20,21,22,23,24,25,26,27,28,29],data_pack:61,datatyp:13,develop:1,directli:1,docker:1,document:[],end:0,execute_custom_nod:14,experiment:1,finn:[0,1,2,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65],flow:0,fold_const:33,fpgadataflow:[7,8,9,20,21,22,23,24,25,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,62],gener:50,get:1,guid:30,hls_synth_res_estim:8,hlssynth_ipgen:42,how:[1,6],indic:[],infer_datatyp:51,infer_shap:52,insert_tlastmark:43,interact:1,jenkin:1,jupyt:1,make_deploy:44,make_pynq_driv:45,make_pynq_proj:46,modelwrapp:15,modul:[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64],multithreshold:26,notebook:1,onnx:63,onnx_exec:16,packag:[5,6,7,12,19,20,30,34,53,59],pass:6,registri:27,remote_exec:17,reorder:56,requir:1,res_estim:9,round_threshold:57,rtlsim_exec:18,run:1,set_exec_mod:47,set_sim_mod:[],shell:1,sign_to_thr:58,sourc:4,src:3,start:1,streamingdataflowpartit:28,streamingfclayer_batch:22,streamingmaxpool_batch:23,streamlin:[53,54,55,56,57,58],submodul:[6,7,12,19,20,30,34,53,59],subpackag:[5,6,19,30],suit:1,synth_pynq_proj:48,tabl:[],templat:[24,49],test:[1,64],tlastmark:25,topolog:10,transform:[30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58],use:1,using:1,util:[59,60,61,62,63,64],verify_custom_nod:11,welcom:[],what:2,write:[6,30],xnorpopcount:29}}) \ No newline at end of file diff --git a/docs/finn/_build/html/source_code.html b/docs/finn/_build/html/source_code.html index 6662fd362ca5254c942847fdd92e446dc2020ff8..825d89aff6090355153dd9c412e653342d05e0ba 100644 --- a/docs/finn/_build/html/source_code.html +++ b/docs/finn/_build/html/source_code.html @@ -160,17 +160,21 @@ <li class="toctree-l3"><a class="reference internal" href="source_code/finn.analysis.html">finn.analysis package</a><ul> <li class="toctree-l4"><a class="reference internal" href="source_code/finn.analysis.html#subpackages">Subpackages</a><ul> <li class="toctree-l5"><a class="reference internal" href="source_code/finn.analysis.fpgadataflow.html">finn.analysis.fpgadataflow package</a><ul> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.analysis.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/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-l6"><a class="reference internal" href="source_code/finn.analysis.fpgadataflow.html#module-finn.analysis.fpgadataflow.res_estimation">finn.analysis.fpgadataflow.res_estimation module</a></li> +<li class="toctree-l6"><a class="reference internal" href="source_code/finn.analysis.fpgadataflow.html#submodules">Submodules</a><ul> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.html">finn.analysis.fpgadataflow.hls_synth_res_estimation module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.analysis.fpgadataflow.res_estimation.html">finn.analysis.fpgadataflow.res_estimation module</a></li> +</ul> +</li> <li class="toctree-l6"><a class="reference internal" href="source_code/finn.analysis.fpgadataflow.html#module-finn.analysis.fpgadataflow">Module contents</a></li> </ul> </li> </ul> </li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.analysis.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.analysis.html#module-finn.analysis.topology">finn.analysis.topology module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.analysis.html#module-finn.analysis.verify_custom_nodes">finn.analysis.verify_custom_nodes module</a></li> +<li class="toctree-l4"><a class="reference internal" href="source_code/finn.analysis.html#submodules">Submodules</a><ul> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.analysis.topology.html">finn.analysis.topology module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.analysis.verify_custom_nodes.html">finn.analysis.verify_custom_nodes module</a></li> +</ul> +</li> <li class="toctree-l4"><a class="reference internal" href="source_code/finn.analysis.html#module-finn.analysis">Module contents</a><ul> <li class="toctree-l5"><a class="reference internal" href="source_code/finn.analysis.html#how-to-write-an-analysis-pass-for-finn">How to write an analysis pass for FINN</a></li> </ul> @@ -178,79 +182,91 @@ </ul> </li> <li class="toctree-l3"><a class="reference internal" href="source_code/finn.core.html">finn.core package</a><ul> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.core.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.core.html#module-finn.core.datatype">finn.core.datatype module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.core.html#module-finn.core.execute_custom_node">finn.core.execute_custom_node module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.core.html#module-finn.core.modelwrapper">finn.core.modelwrapper module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.core.html#module-finn.core.onnx_exec">finn.core.onnx_exec module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.core.html#module-finn.core.remote_exec">finn.core.remote_exec module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.core.html#module-finn.core.rtlsim_exec">finn.core.rtlsim_exec module</a></li> +<li class="toctree-l4"><a class="reference internal" href="source_code/finn.core.html#submodules">Submodules</a><ul> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.core.datatype.html">finn.core.datatype module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.core.execute_custom_node.html">finn.core.execute_custom_node module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.core.modelwrapper.html">finn.core.modelwrapper module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.core.onnx_exec.html">finn.core.onnx_exec module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.core.remote_exec.html">finn.core.remote_exec module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.core.rtlsim_exec.html">finn.core.rtlsim_exec module</a></li> +</ul> +</li> <li class="toctree-l4"><a class="reference internal" href="source_code/finn.core.html#module-finn.core">Module contents</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="source_code/finn.custom_op.html">finn.custom_op package</a><ul> <li class="toctree-l4"><a class="reference internal" href="source_code/finn.custom_op.html#subpackages">Subpackages</a><ul> <li class="toctree-l5"><a class="reference internal" href="source_code/finn.custom_op.fpgadataflow.html">finn.custom_op.fpgadataflow package</a><ul> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.custom_op.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.convolutioninputgenerator">finn.custom_op.fpgadataflow.convolutioninputgenerator module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.streamingfclayer_batch">finn.custom_op.fpgadataflow.streamingfclayer_batch module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.streamingmaxpool_batch">finn.custom_op.fpgadataflow.streamingmaxpool_batch module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.templates">finn.custom_op.fpgadataflow.templates module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow.tlastmarker">finn.custom_op.fpgadataflow.tlastmarker module</a></li> +<li class="toctree-l6"><a class="reference internal" href="source_code/finn.custom_op.fpgadataflow.html#submodules">Submodules</a><ul> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html">finn.custom_op.fpgadataflow.convolutioninputgenerator module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html">finn.custom_op.fpgadataflow.streamingfclayer_batch module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html">finn.custom_op.fpgadataflow.streamingmaxpool_batch module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.custom_op.fpgadataflow.templates.html">finn.custom_op.fpgadataflow.templates module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.custom_op.fpgadataflow.tlastmarker.html">finn.custom_op.fpgadataflow.tlastmarker module</a></li> +</ul> +</li> <li class="toctree-l6"><a class="reference internal" href="source_code/finn.custom_op.fpgadataflow.html#module-finn.custom_op.fpgadataflow">Module contents</a></li> </ul> </li> </ul> </li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.custom_op.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.custom_op.html#module-finn.custom_op.multithreshold">finn.custom_op.multithreshold module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.custom_op.html#module-finn.custom_op.registry">finn.custom_op.registry module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.custom_op.html#module-finn.custom_op.streamingdataflowpartition">finn.custom_op.streamingdataflowpartition module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.custom_op.html#module-finn.custom_op.xnorpopcount">finn.custom_op.xnorpopcount module</a></li> +<li class="toctree-l4"><a class="reference internal" href="source_code/finn.custom_op.html#submodules">Submodules</a><ul> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.custom_op.multithreshold.html">finn.custom_op.multithreshold module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.custom_op.registry.html">finn.custom_op.registry module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.custom_op.streamingdataflowpartition.html">finn.custom_op.streamingdataflowpartition module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.custom_op.xnorpopcount.html">finn.custom_op.xnorpopcount module</a></li> +</ul> +</li> <li class="toctree-l4"><a class="reference internal" href="source_code/finn.custom_op.html#module-finn.custom_op">Module contents</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="source_code/finn.transformation.html">finn.transformation package</a><ul> <li class="toctree-l4"><a class="reference internal" href="source_code/finn.transformation.html#subpackages">Subpackages</a><ul> <li class="toctree-l5"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html">finn.transformation.fpgadataflow package</a><ul> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html#submodules">Submodules</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.cleanup">finn.transformation.fpgadataflow.cleanup module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.codegen_ipgen">finn.transformation.fpgadataflow.codegen_ipgen module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.codegen_ipstitch">finn.transformation.fpgadataflow.codegen_ipstitch module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.codegen_npysim">finn.transformation.fpgadataflow.codegen_npysim module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.compile">finn.transformation.fpgadataflow.compile module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/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-l6"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.create_dataflow_partition">finn.transformation.fpgadataflow.create_dataflow_partition module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.hlssynth_ipgen">finn.transformation.fpgadataflow.hlssynth_ipgen module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.insert_tlastmarker">finn.transformation.fpgadataflow.insert_tlastmarker module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.make_deployment">finn.transformation.fpgadataflow.make_deployment module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.make_pynq_driver">finn.transformation.fpgadataflow.make_pynq_driver module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.make_pynq_proj">finn.transformation.fpgadataflow.make_pynq_proj module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.set_exec_mode">finn.transformation.fpgadataflow.set_exec_mode module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.synth_pynq_proj">finn.transformation.fpgadataflow.synth_pynq_proj module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow.templates">finn.transformation.fpgadataflow.templates module</a></li> +<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html#submodules">Submodules</a><ul> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.cleanup.html">finn.transformation.fpgadataflow.cleanup module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.codegen_ipgen.html">finn.transformation.fpgadataflow.codegen_ipgen module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.codegen_ipstitch.html">finn.transformation.fpgadataflow.codegen_ipstitch module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.codegen_npysim.html">finn.transformation.fpgadataflow.codegen_npysim module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.compile.html">finn.transformation.fpgadataflow.compile module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.html">finn.transformation.fpgadataflow.convert_to_hls_layers module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.create_dataflow_partition.html">finn.transformation.fpgadataflow.create_dataflow_partition module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.html">finn.transformation.fpgadataflow.hlssynth_ipgen module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.insert_tlastmarker.html">finn.transformation.fpgadataflow.insert_tlastmarker module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.make_deployment.html">finn.transformation.fpgadataflow.make_deployment module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.make_pynq_driver.html">finn.transformation.fpgadataflow.make_pynq_driver module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.make_pynq_proj.html">finn.transformation.fpgadataflow.make_pynq_proj module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.set_exec_mode.html">finn.transformation.fpgadataflow.set_exec_mode module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.synth_pynq_proj.html">finn.transformation.fpgadataflow.synth_pynq_proj module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.templates.html">finn.transformation.fpgadataflow.templates module</a></li> +</ul> +</li> <li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.fpgadataflow.html#module-finn.transformation.fpgadataflow">Module contents</a></li> </ul> </li> <li class="toctree-l5"><a class="reference internal" href="source_code/finn.transformation.streamline.html">finn.transformation.streamline package</a><ul> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.streamline.html#submodules">Submodules</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.streamline.html#module-finn.transformation.streamline.absorb">finn.transformation.streamline.absorb module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.streamline.html#module-finn.transformation.streamline.collapse_repeated">finn.transformation.streamline.collapse_repeated module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.streamline.html#module-finn.transformation.streamline.reorder">finn.transformation.streamline.reorder module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.streamline.html#module-finn.transformation.streamline.round_thresholds">finn.transformation.streamline.round_thresholds module</a></li> -<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.streamline.html#module-finn.transformation.streamline.sign_to_thres">finn.transformation.streamline.sign_to_thres module</a></li> +<li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.streamline.html#submodules">Submodules</a><ul> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.streamline.absorb.html">finn.transformation.streamline.absorb module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.streamline.collapse_repeated.html">finn.transformation.streamline.collapse_repeated module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.streamline.reorder.html">finn.transformation.streamline.reorder module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.streamline.round_thresholds.html">finn.transformation.streamline.round_thresholds module</a></li> +<li class="toctree-l7"><a class="reference internal" href="source_code/finn.transformation.streamline.sign_to_thres.html">finn.transformation.streamline.sign_to_thres module</a></li> +</ul> +</li> <li class="toctree-l6"><a class="reference internal" href="source_code/finn.transformation.streamline.html#module-finn.transformation.streamline">Module contents</a></li> </ul> </li> </ul> </li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.transformation.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.transformation.html#module-finn.transformation.batchnorm_to_affine">finn.transformation.batchnorm_to_affine module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.transformation.html#module-finn.transformation.bipolar_to_xnor">finn.transformation.bipolar_to_xnor module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.transformation.html#module-finn.transformation.fold_constants">finn.transformation.fold_constants module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.transformation.html#module-finn.transformation.general">finn.transformation.general module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.transformation.html#module-finn.transformation.infer_datatypes">finn.transformation.infer_datatypes module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.transformation.html#module-finn.transformation.infer_shapes">finn.transformation.infer_shapes module</a></li> +<li class="toctree-l4"><a class="reference internal" href="source_code/finn.transformation.html#submodules">Submodules</a><ul> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.transformation.batchnorm_to_affine.html">finn.transformation.batchnorm_to_affine module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.transformation.bipolar_to_xnor.html">finn.transformation.bipolar_to_xnor module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.transformation.fold_constants.html">finn.transformation.fold_constants module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.transformation.general.html">finn.transformation.general module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.transformation.infer_datatypes.html">finn.transformation.infer_datatypes module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.transformation.infer_shapes.html">finn.transformation.infer_shapes module</a></li> +</ul> +</li> <li class="toctree-l4"><a class="reference internal" href="source_code/finn.transformation.html#module-finn.transformation">Module contents</a><ul> <li class="toctree-l5"><a class="reference internal" href="source_code/finn.transformation.html#guide-to-writing-finn-transformations">Guide to writing FINN transformations</a></li> </ul> @@ -258,12 +274,14 @@ </ul> </li> <li class="toctree-l3"><a class="reference internal" href="source_code/finn.util.html">finn.util package</a><ul> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.util.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.util.html#module-finn.util.basic">finn.util.basic module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.util.html#module-finn.util.data_packing">finn.util.data_packing module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.util.html#module-finn.util.fpgadataflow">finn.util.fpgadataflow module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.util.html#module-finn.util.onnx">finn.util.onnx module</a></li> -<li class="toctree-l4"><a class="reference internal" href="source_code/finn.util.html#module-finn.util.test">finn.util.test module</a></li> +<li class="toctree-l4"><a class="reference internal" href="source_code/finn.util.html#submodules">Submodules</a><ul> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.util.basic.html">finn.util.basic module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.util.data_packing.html">finn.util.data_packing module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.util.fpgadataflow.html">finn.util.fpgadataflow module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.util.onnx.html">finn.util.onnx module</a></li> +<li class="toctree-l5"><a class="reference internal" href="source_code/finn.util.test.html">finn.util.test module</a></li> +</ul> +</li> <li class="toctree-l4"><a class="reference internal" href="source_code/finn.util.html#module-finn.util">Module contents</a></li> </ul> </li> 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 new file mode 100644 index 0000000000000000000000000000000000000000..a333ed66b3935eddf9f78ccc47f807e014f87939 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.html @@ -0,0 +1,219 @@ + + +<!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 bdaa8bda5f16972218db543223c3e4229cc65963..8f2fb5a294ae31018460008917749083c947bd66 100644 --- a/docs/finn/_build/html/source_code/finn.analysis.fpgadataflow.html +++ b/docs/finn/_build/html/source_code/finn.analysis.fpgadataflow.html @@ -35,7 +35,7 @@ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> - <link rel="next" title="finn.core package" href="finn.core.html" /> + <link rel="next" title="finn.analysis.fpgadataflow.hls_synth_res_estimation module" href="finn.analysis.fpgadataflow.hls_synth_res_estimation.html" /> <link rel="prev" title="finn.analysis package" href="finn.analysis.html" /> </head> @@ -158,26 +158,12 @@ <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 class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="finn.analysis.fpgadataflow.hls_synth_res_estimation.html">finn.analysis.fpgadataflow.hls_synth_res_estimation module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.analysis.fpgadataflow.res_estimation.html">finn.analysis.fpgadataflow.res_estimation module</a></li> +</ul> </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> @@ -192,7 +178,7 @@ Returns {node name : resource estimation}</p> <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.fpgadataflow.hls_synth_res_estimation.html" class="btn btn-neutral float-right" title="finn.analysis.fpgadataflow.hls_synth_res_estimation module" 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> 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 new file mode 100644 index 0000000000000000000000000000000000000000..7e52637fc0fb47ee2ac9b6c8c2c65b35b802faf8 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.analysis.fpgadataflow.res_estimation.html @@ -0,0 +1,219 @@ + + +<!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 095e509874aefeeafb71734df3dc61fabac5a274..ef0bd54622019deef89a067940b8d1fa8bc1d975 100644 --- a/docs/finn/_build/html/source_code/finn.analysis.html +++ b/docs/finn/_build/html/source_code/finn.analysis.html @@ -159,9 +159,11 @@ <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#submodules">Submodules</a><ul> +<li class="toctree-l3"><a class="reference internal" href="finn.analysis.fpgadataflow.hls_synth_res_estimation.html">finn.analysis.fpgadataflow.hls_synth_res_estimation module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.analysis.fpgadataflow.res_estimation.html">finn.analysis.fpgadataflow.res_estimation module</a></li> +</ul> +</li> <li class="toctree-l2"><a class="reference internal" href="finn.analysis.fpgadataflow.html#module-finn.analysis.fpgadataflow">Module contents</a></li> </ul> </li> @@ -170,50 +172,12 @@ </div> <div class="section" id="submodules"> <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="finn.analysis.topology.html">finn.analysis.topology module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.analysis.verify_custom_nodes.html">finn.analysis.verify_custom_nodes module</a></li> +</ul> </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> diff --git a/docs/finn/_build/html/source_code/finn.analysis.topology.html b/docs/finn/_build/html/source_code/finn.analysis.topology.html new file mode 100644 index 0000000000000000000000000000000000000000..f602bb8f2bf0280cab567b6dc2cefa693b8a2cee --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.analysis.topology.html @@ -0,0 +1,240 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..5c7b82a0dea878b9e6e680e93c11dcd6db03d88f --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.analysis.verify_custom_nodes.html @@ -0,0 +1,218 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..2d35ed438f8ee1cfbdcf928e2fbc5009c7046bf0 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.core.datatype.html @@ -0,0 +1,354 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..45ac552b12ec7a217bcc47c63ccb7f7ee0a5471d --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.core.execute_custom_node.html @@ -0,0 +1,217 @@ + + +<!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 98aff76d9cd871b7c29d70324ff95650f894eb99..383d445767bb60d71015e70168503f108e421bf4 100644 --- a/docs/finn/_build/html/source_code/finn.core.html +++ b/docs/finn/_build/html/source_code/finn.core.html @@ -35,8 +35,8 @@ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> - <link rel="next" title="finn.custom_op package" href="finn.custom_op.html" /> - <link rel="prev" title="finn.analysis.fpgadataflow package" href="finn.analysis.fpgadataflow.html" /> + <link rel="next" title="finn.core.datatype module" href="finn.core.datatype.html" /> + <link rel="prev" title="finn.analysis.verify_custom_nodes module" href="finn.analysis.verify_custom_nodes.html" /> </head> <body class="wy-body-for-nav"> @@ -156,379 +156,16 @@ <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 class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="finn.core.datatype.html">finn.core.datatype module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.core.execute_custom_node.html">finn.core.execute_custom_node module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.core.modelwrapper.html">finn.core.modelwrapper module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.core.onnx_exec.html">finn.core.onnx_exec module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.core.remote_exec.html">finn.core.remote_exec module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.core.rtlsim_exec.html">finn.core.rtlsim_exec module</a></li> +</ul> </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.remote_exec"> -<span id="finn-core-remote-exec-module"></span><h2>finn.core.remote_exec module<a class="headerlink" href="#module-finn.core.remote_exec" title="Permalink to this headline">¶</a></h2> -<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 class="section" id="module-finn.core.rtlsim_exec"> -<span id="finn-core-rtlsim-exec-module"></span><h2>finn.core.rtlsim_exec module<a class="headerlink" href="#module-finn.core.rtlsim_exec" title="Permalink to this headline">¶</a></h2> -<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 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> @@ -543,10 +180,10 @@ all the intermediate activation values.</p> <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.datatype.html" class="btn btn-neutral float-right" title="finn.core.datatype 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> + <a href="finn.analysis.verify_custom_nodes.html" class="btn btn-neutral float-left" title="finn.analysis.verify_custom_nodes module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> diff --git a/docs/finn/_build/html/source_code/finn.core.modelwrapper.html b/docs/finn/_build/html/source_code/finn.core.modelwrapper.html new file mode 100644 index 0000000000000000000000000000000000000000..a1db6121278c826421deaed513696028e025df23 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.core.modelwrapper.html @@ -0,0 +1,368 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..a6e8dd8d9b2983016c0d9b90ffae85a09e20fbe7 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.core.onnx_exec.html @@ -0,0 +1,245 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..771b6d0defb24e94dd6fb366713e8cd3b9c61259 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.core.remote_exec.html @@ -0,0 +1,215 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..8d6ea24d47f9d2784ee15e09d9b923487d9709f4 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.core.rtlsim_exec.html @@ -0,0 +1,216 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..742ecdeae9b7bcd9da67217d544f755eda425c7c --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.html @@ -0,0 +1,334 @@ + + +<!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 f263769e12895f4344ab63e5a5b76d4e508f4a77..caa62f1421c9f675af15fbdfd724bc0c7f923690 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 @@ -35,7 +35,7 @@ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> - <link rel="next" title="finn.transformation package" href="finn.transformation.html" /> + <link rel="next" title="finn.custom_op.fpgadataflow.convolutioninputgenerator module" href="finn.custom_op.fpgadataflow.convolutioninputgenerator.html" /> <link rel="prev" title="finn.custom_op package" href="finn.custom_op.html" /> </head> @@ -158,556 +158,15 @@ <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 class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="finn.custom_op.fpgadataflow.convolutioninputgenerator.html">finn.custom_op.fpgadataflow.convolutioninputgenerator module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.custom_op.fpgadataflow.streamingfclayer_batch.html">finn.custom_op.fpgadataflow.streamingfclayer_batch module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.custom_op.fpgadataflow.streamingmaxpool_batch.html">finn.custom_op.fpgadataflow.streamingmaxpool_batch module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.custom_op.fpgadataflow.templates.html">finn.custom_op.fpgadataflow.templates module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.custom_op.fpgadataflow.tlastmarker.html">finn.custom_op.fpgadataflow.tlastmarker module</a></li> +</ul> </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> @@ -887,7 +346,7 @@ attribute is not set</p> <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.fpgadataflow.convolutioninputgenerator.html" class="btn btn-neutral float-right" title="finn.custom_op.fpgadataflow.convolutioninputgenerator module" 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> 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 new file mode 100644 index 0000000000000000000000000000000000000000..87ed52c67e52e1c0471ef62b3493c29090f2b939 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.html @@ -0,0 +1,408 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..1f0df0549bf9e5d3889633fc17a0220c60a8d29c --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.html @@ -0,0 +1,312 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..6a18a9d3b469827a2a7e4448b2f21caa22d5611c --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.templates.html @@ -0,0 +1,212 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..bbee90cff9a101095a1c03c3173291c3524218a0 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.custom_op.fpgadataflow.tlastmarker.html @@ -0,0 +1,329 @@ + + +<!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 59373404b90354966140f281ac854568d71cfd8c..86714518443d1770a92d805e5f02a69d835f38bf 100644 --- a/docs/finn/_build/html/source_code/finn.custom_op.html +++ b/docs/finn/_build/html/source_code/finn.custom_op.html @@ -36,7 +36,7 @@ <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="finn.custom_op.fpgadataflow package" href="finn.custom_op.fpgadataflow.html" /> - <link rel="prev" title="finn.core package" href="finn.core.html" /> + <link rel="prev" title="finn.core.rtlsim_exec module" href="finn.core.rtlsim_exec.html" /> </head> <body class="wy-body-for-nav"> @@ -159,12 +159,14 @@ <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#submodules">Submodules</a><ul> +<li class="toctree-l3"><a class="reference internal" href="finn.custom_op.fpgadataflow.convolutioninputgenerator.html">finn.custom_op.fpgadataflow.convolutioninputgenerator module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.custom_op.fpgadataflow.streamingfclayer_batch.html">finn.custom_op.fpgadataflow.streamingfclayer_batch module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.custom_op.fpgadataflow.streamingmaxpool_batch.html">finn.custom_op.fpgadataflow.streamingmaxpool_batch module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.custom_op.fpgadataflow.templates.html">finn.custom_op.fpgadataflow.templates module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.custom_op.fpgadataflow.tlastmarker.html">finn.custom_op.fpgadataflow.tlastmarker module</a></li> +</ul> +</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> @@ -173,180 +175,14 @@ </div> <div class="section" id="submodules"> <h2>Submodules<a class="headerlink" href="#submodules" 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.multithreshold.html">finn.custom_op.multithreshold module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.custom_op.registry.html">finn.custom_op.registry module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.custom_op.streamingdataflowpartition.html">finn.custom_op.streamingdataflowpartition module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.custom_op.xnorpopcount.html">finn.custom_op.xnorpopcount module</a></li> +</ul> </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> @@ -426,7 +262,7 @@ the number of inputs is equal to the expected number</p> <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> + <a href="finn.core.rtlsim_exec.html" class="btn btn-neutral float-left" title="finn.core.rtlsim_exec module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> diff --git a/docs/finn/_build/html/source_code/finn.custom_op.multithreshold.html b/docs/finn/_build/html/source_code/finn.custom_op.multithreshold.html new file mode 100644 index 0000000000000000000000000000000000000000..0ba6f08e39c7b759fd6351b3e5765a326a1e98eb --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.custom_op.multithreshold.html @@ -0,0 +1,267 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..257e4a9d8d4fe8a5e104abbbb2e24570ad465012 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.custom_op.registry.html @@ -0,0 +1,216 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..82daf99f8093b47c33fea50d3ba844d530077dd5 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.custom_op.streamingdataflowpartition.html @@ -0,0 +1,257 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..e4e92ce4b3a82ec139d5c47427b3445a01ad84b8 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.custom_op.xnorpopcount.html @@ -0,0 +1,262 @@ + + +<!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 51b1f6b6f5fdca01ebc7036395802cd3f794dd77..2f11a60b2e9a533d2860ab6fdf11ba54f09fab6c 100644 --- a/docs/finn/_build/html/source_code/finn.html +++ b/docs/finn/_build/html/source_code/finn.html @@ -159,17 +159,21 @@ <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#submodules">Submodules</a><ul> +<li class="toctree-l5"><a class="reference internal" href="finn.analysis.fpgadataflow.hls_synth_res_estimation.html">finn.analysis.fpgadataflow.hls_synth_res_estimation module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.analysis.fpgadataflow.res_estimation.html">finn.analysis.fpgadataflow.res_estimation module</a></li> +</ul> +</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#submodules">Submodules</a><ul> +<li class="toctree-l3"><a class="reference internal" href="finn.analysis.topology.html">finn.analysis.topology module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.analysis.verify_custom_nodes.html">finn.analysis.verify_custom_nodes module</a></li> +</ul> +</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> @@ -177,79 +181,91 @@ </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.remote_exec">finn.core.remote_exec module</a></li> -<li class="toctree-l2"><a class="reference internal" href="finn.core.html#module-finn.core.rtlsim_exec">finn.core.rtlsim_exec module</a></li> +<li class="toctree-l2"><a class="reference internal" href="finn.core.html#submodules">Submodules</a><ul> +<li class="toctree-l3"><a class="reference internal" href="finn.core.datatype.html">finn.core.datatype module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.core.execute_custom_node.html">finn.core.execute_custom_node module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.core.modelwrapper.html">finn.core.modelwrapper module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.core.onnx_exec.html">finn.core.onnx_exec module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.core.remote_exec.html">finn.core.remote_exec module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.core.rtlsim_exec.html">finn.core.rtlsim_exec module</a></li> +</ul> +</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#submodules">Submodules</a><ul> +<li class="toctree-l5"><a class="reference internal" href="finn.custom_op.fpgadataflow.convolutioninputgenerator.html">finn.custom_op.fpgadataflow.convolutioninputgenerator module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.custom_op.fpgadataflow.streamingfclayer_batch.html">finn.custom_op.fpgadataflow.streamingfclayer_batch module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.custom_op.fpgadataflow.streamingmaxpool_batch.html">finn.custom_op.fpgadataflow.streamingmaxpool_batch module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.custom_op.fpgadataflow.templates.html">finn.custom_op.fpgadataflow.templates module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.custom_op.fpgadataflow.tlastmarker.html">finn.custom_op.fpgadataflow.tlastmarker module</a></li> +</ul> +</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#submodules">Submodules</a><ul> +<li class="toctree-l3"><a class="reference internal" href="finn.custom_op.multithreshold.html">finn.custom_op.multithreshold module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.custom_op.registry.html">finn.custom_op.registry module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.custom_op.streamingdataflowpartition.html">finn.custom_op.streamingdataflowpartition module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.custom_op.xnorpopcount.html">finn.custom_op.xnorpopcount module</a></li> +</ul> +</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#module-finn.transformation.fpgadataflow.set_exec_mode">finn.transformation.fpgadataflow.set_exec_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#submodules">Submodules</a><ul> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.fpgadataflow.cleanup.html">finn.transformation.fpgadataflow.cleanup module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.fpgadataflow.codegen_ipgen.html">finn.transformation.fpgadataflow.codegen_ipgen module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.fpgadataflow.codegen_ipstitch.html">finn.transformation.fpgadataflow.codegen_ipstitch module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.fpgadataflow.codegen_npysim.html">finn.transformation.fpgadataflow.codegen_npysim module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.fpgadataflow.compile.html">finn.transformation.fpgadataflow.compile module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.fpgadataflow.convert_to_hls_layers.html">finn.transformation.fpgadataflow.convert_to_hls_layers module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.fpgadataflow.create_dataflow_partition.html">finn.transformation.fpgadataflow.create_dataflow_partition module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.fpgadataflow.hlssynth_ipgen.html">finn.transformation.fpgadataflow.hlssynth_ipgen module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.fpgadataflow.insert_tlastmarker.html">finn.transformation.fpgadataflow.insert_tlastmarker module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.fpgadataflow.make_deployment.html">finn.transformation.fpgadataflow.make_deployment module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.fpgadataflow.make_pynq_driver.html">finn.transformation.fpgadataflow.make_pynq_driver module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.fpgadataflow.make_pynq_proj.html">finn.transformation.fpgadataflow.make_pynq_proj module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.fpgadataflow.set_exec_mode.html">finn.transformation.fpgadataflow.set_exec_mode module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.fpgadataflow.synth_pynq_proj.html">finn.transformation.fpgadataflow.synth_pynq_proj module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.fpgadataflow.templates.html">finn.transformation.fpgadataflow.templates module</a></li> +</ul> +</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#submodules">Submodules</a><ul> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.streamline.absorb.html">finn.transformation.streamline.absorb module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.streamline.collapse_repeated.html">finn.transformation.streamline.collapse_repeated module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.streamline.reorder.html">finn.transformation.streamline.reorder module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.streamline.round_thresholds.html">finn.transformation.streamline.round_thresholds module</a></li> +<li class="toctree-l5"><a class="reference internal" href="finn.transformation.streamline.sign_to_thres.html">finn.transformation.streamline.sign_to_thres module</a></li> +</ul> +</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#submodules">Submodules</a><ul> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.batchnorm_to_affine.html">finn.transformation.batchnorm_to_affine module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.bipolar_to_xnor.html">finn.transformation.bipolar_to_xnor module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.fold_constants.html">finn.transformation.fold_constants module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.general.html">finn.transformation.general module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.infer_datatypes.html">finn.transformation.infer_datatypes module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.infer_shapes.html">finn.transformation.infer_shapes module</a></li> +</ul> +</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> @@ -257,12 +273,14 @@ </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#submodules">Submodules</a><ul> +<li class="toctree-l3"><a class="reference internal" href="finn.util.basic.html">finn.util.basic module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.util.data_packing.html">finn.util.data_packing module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.util.fpgadataflow.html">finn.util.fpgadataflow module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.util.onnx.html">finn.util.onnx module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.util.test.html">finn.util.test module</a></li> +</ul> +</li> <li class="toctree-l2"><a class="reference internal" href="finn.util.html#module-finn.util">Module contents</a></li> </ul> </li> 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 new file mode 100644 index 0000000000000000000000000000000000000000..956339611f1b5aaa96d6b821c0d0b810a7c1b618 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.batchnorm_to_affine.html @@ -0,0 +1,222 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..60ba89ae7dd7c482409140873b1a76b2635e497f --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.bipolar_to_xnor.html @@ -0,0 +1,223 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..d02be36478b150f89b43e0df4116a0dbed79e3fd --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.fold_constants.html @@ -0,0 +1,223 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..ce38981d4321aeb7f5c4a3dbc3fb9b6706d9ed48 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.cleanup.html @@ -0,0 +1,224 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..15ee3487e3b1f72659537154e75ef3f1bcf8a667 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.codegen_ipgen.html @@ -0,0 +1,224 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..53fcfe1174605a92f1ac60e690ccf97970d54920 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.codegen_ipstitch.html @@ -0,0 +1,232 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..36e1774c56dcef424bcd6bf227c7a8ac4ed84e31 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.codegen_npysim.html @@ -0,0 +1,224 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..3ee88f9b1ea74f2422cd73c6db9e579528ca4ea2 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.compile.html @@ -0,0 +1,224 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..31b287d2b1fa982a93bac7935264290872c2c3d8 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.html @@ -0,0 +1,226 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..e47ba3493e8538776cb3582a9f08a44102aeff7d --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.create_dataflow_partition.html @@ -0,0 +1,228 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..1d2a3d9ec69dd56fb81bb76075fad1237d1fc472 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.html @@ -0,0 +1,224 @@ + + +<!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 194aa7cc1a7c82471f11fe1eb6e1806f20736e54..6d71ce40146a358cecd564c010e031030b615132 100644 --- a/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.html +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.html @@ -35,7 +35,7 @@ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> - <link rel="next" title="finn.transformation.streamline package" href="finn.transformation.streamline.html" /> + <link rel="next" title="finn.transformation.fpgadataflow.cleanup module" href="finn.transformation.fpgadataflow.cleanup.html" /> <link rel="prev" title="finn.transformation package" href="finn.transformation.html" /> </head> @@ -158,251 +158,25 @@ <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 class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.fpgadataflow.cleanup.html">finn.transformation.fpgadataflow.cleanup module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.fpgadataflow.codegen_ipgen.html">finn.transformation.fpgadataflow.codegen_ipgen module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.fpgadataflow.codegen_ipstitch.html">finn.transformation.fpgadataflow.codegen_ipstitch module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.fpgadataflow.codegen_npysim.html">finn.transformation.fpgadataflow.codegen_npysim module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.fpgadataflow.compile.html">finn.transformation.fpgadataflow.compile module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.fpgadataflow.convert_to_hls_layers.html">finn.transformation.fpgadataflow.convert_to_hls_layers module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.fpgadataflow.create_dataflow_partition.html">finn.transformation.fpgadataflow.create_dataflow_partition module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.fpgadataflow.hlssynth_ipgen.html">finn.transformation.fpgadataflow.hlssynth_ipgen module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.fpgadataflow.insert_tlastmarker.html">finn.transformation.fpgadataflow.insert_tlastmarker module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.fpgadataflow.make_deployment.html">finn.transformation.fpgadataflow.make_deployment module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.fpgadataflow.make_pynq_driver.html">finn.transformation.fpgadataflow.make_pynq_driver module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.fpgadataflow.make_pynq_proj.html">finn.transformation.fpgadataflow.make_pynq_proj module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.fpgadataflow.set_exec_mode.html">finn.transformation.fpgadataflow.set_exec_mode module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.fpgadataflow.synth_pynq_proj.html">finn.transformation.fpgadataflow.synth_pynq_proj module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.fpgadataflow.templates.html">finn.transformation.fpgadataflow.templates module</a></li> +</ul> </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="module-finn.transformation.fpgadataflow.set_exec_mode"> -<span id="finn-transformation-fpgadataflow-set-exec-mode-module"></span><h2>finn.transformation.fpgadataflow.set_exec_mode module<a class="headerlink" href="#module-finn.transformation.fpgadataflow.set_exec_mode" title="Permalink to this headline">¶</a></h2> -<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 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> @@ -417,7 +191,7 @@ transformation must be applied prior to this transformation.</p> <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.cleanup.html" class="btn btn-neutral float-right" title="finn.transformation.fpgadataflow.cleanup module" 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> 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 new file mode 100644 index 0000000000000000000000000000000000000000..1b972534f4b2feec670783778c2d606911a86500 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.insert_tlastmarker.html @@ -0,0 +1,225 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..8a3bb6955891a5b5eb0b39d0fe8565f990447ceb --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.make_deployment.html @@ -0,0 +1,228 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..1e21d93b911b55d976650f5aad323f0e30767690 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.make_pynq_driver.html @@ -0,0 +1,229 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..c95642fa51356af6907ddebae041e37100cc60ef --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.make_pynq_proj.html @@ -0,0 +1,231 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..f7263416c286d8761f4877bcb1c0372e28f7717a --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.set_exec_mode.html @@ -0,0 +1,224 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..4f24fdad42643766518d36826dcfccb788d24683 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.synth_pynq_proj.html @@ -0,0 +1,225 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..9777fad44965c77edfdf37a1436df85e7e4997cb --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.fpgadataflow.templates.html @@ -0,0 +1,212 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..0c1dc50f0c7089bc81e8f174510bf8aebe8af884 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.general.html @@ -0,0 +1,259 @@ + + +<!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 939edb332ced4c0f024eaa6232ad2a5bb95ff11c..d7a4042b0189bf4247eade93551969d3e385d8a5 100644 --- a/docs/finn/_build/html/source_code/finn.transformation.html +++ b/docs/finn/_build/html/source_code/finn.transformation.html @@ -36,7 +36,7 @@ <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="finn.transformation.fpgadataflow package" href="finn.transformation.fpgadataflow.html" /> - <link rel="prev" title="finn.custom_op.fpgadataflow package" href="finn.custom_op.fpgadataflow.html" /> + <link rel="prev" title="finn.custom_op.xnorpopcount module" href="finn.custom_op.xnorpopcount.html" /> </head> <body class="wy-body-for-nav"> @@ -159,32 +159,36 @@ <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#module-finn.transformation.fpgadataflow.set_exec_mode">finn.transformation.fpgadataflow.set_exec_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#submodules">Submodules</a><ul> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.fpgadataflow.cleanup.html">finn.transformation.fpgadataflow.cleanup module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.fpgadataflow.codegen_ipgen.html">finn.transformation.fpgadataflow.codegen_ipgen module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.fpgadataflow.codegen_ipstitch.html">finn.transformation.fpgadataflow.codegen_ipstitch module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.fpgadataflow.codegen_npysim.html">finn.transformation.fpgadataflow.codegen_npysim module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.fpgadataflow.compile.html">finn.transformation.fpgadataflow.compile module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.fpgadataflow.convert_to_hls_layers.html">finn.transformation.fpgadataflow.convert_to_hls_layers module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.fpgadataflow.create_dataflow_partition.html">finn.transformation.fpgadataflow.create_dataflow_partition module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.fpgadataflow.hlssynth_ipgen.html">finn.transformation.fpgadataflow.hlssynth_ipgen module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.fpgadataflow.insert_tlastmarker.html">finn.transformation.fpgadataflow.insert_tlastmarker module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.fpgadataflow.make_deployment.html">finn.transformation.fpgadataflow.make_deployment module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.fpgadataflow.make_pynq_driver.html">finn.transformation.fpgadataflow.make_pynq_driver module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.fpgadataflow.make_pynq_proj.html">finn.transformation.fpgadataflow.make_pynq_proj module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.fpgadataflow.set_exec_mode.html">finn.transformation.fpgadataflow.set_exec_mode module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.fpgadataflow.synth_pynq_proj.html">finn.transformation.fpgadataflow.synth_pynq_proj module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.fpgadataflow.templates.html">finn.transformation.fpgadataflow.templates module</a></li> +</ul> +</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#submodules">Submodules</a><ul> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.streamline.absorb.html">finn.transformation.streamline.absorb module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.streamline.collapse_repeated.html">finn.transformation.streamline.collapse_repeated module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.streamline.reorder.html">finn.transformation.streamline.reorder module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.streamline.round_thresholds.html">finn.transformation.streamline.round_thresholds module</a></li> +<li class="toctree-l3"><a class="reference internal" href="finn.transformation.streamline.sign_to_thres.html">finn.transformation.streamline.sign_to_thres module</a></li> +</ul> +</li> <li class="toctree-l2"><a class="reference internal" href="finn.transformation.streamline.html#module-finn.transformation.streamline">Module contents</a></li> </ul> </li> @@ -193,136 +197,16 @@ </div> <div class="section" id="submodules"> <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.batchnorm_to_affine.html">finn.transformation.batchnorm_to_affine module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.bipolar_to_xnor.html">finn.transformation.bipolar_to_xnor module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.fold_constants.html">finn.transformation.fold_constants module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.general.html">finn.transformation.general module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.infer_datatypes.html">finn.transformation.infer_datatypes module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.infer_shapes.html">finn.transformation.infer_shapes module</a></li> +</ul> </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> @@ -371,7 +255,7 @@ manually re-apply the transform.</p></li> <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> + <a href="finn.custom_op.xnorpopcount.html" class="btn btn-neutral float-left" title="finn.custom_op.xnorpopcount module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> diff --git a/docs/finn/_build/html/source_code/finn.transformation.infer_datatypes.html b/docs/finn/_build/html/source_code/finn.transformation.infer_datatypes.html new file mode 100644 index 0000000000000000000000000000000000000000..5987f219e8c8579a2044f7c15a2a77f336deb632 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.infer_datatypes.html @@ -0,0 +1,223 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..f2b1f440de4ed3d7b49acf206a43a44620e18318 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.infer_shapes.html @@ -0,0 +1,222 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..72ae8104a1ba7830a9257608234bab9ada541b23 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.streamline.absorb.html @@ -0,0 +1,265 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..bae88456af7be40a65e156003c573cde2082a2fc --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.streamline.collapse_repeated.html @@ -0,0 +1,238 @@ + + +<!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 c3faa75ab9c203bb6214ef6a9f68a4f7dd665362..fb8d76b591a8b48286a3ca33abcbc24d58bc45f8 100644 --- a/docs/finn/_build/html/source_code/finn.transformation.streamline.html +++ b/docs/finn/_build/html/source_code/finn.transformation.streamline.html @@ -35,8 +35,8 @@ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> - <link rel="next" title="finn.util package" href="finn.util.html" /> - <link rel="prev" title="finn.transformation.fpgadataflow package" href="finn.transformation.fpgadataflow.html" /> + <link rel="next" title="finn.transformation.streamline.absorb module" href="finn.transformation.streamline.absorb.html" /> + <link rel="prev" title="finn.transformation.fpgadataflow.templates module" href="finn.transformation.fpgadataflow.templates.html" /> </head> <body class="wy-body-for-nav"> @@ -158,165 +158,15 @@ <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 class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.streamline.absorb.html">finn.transformation.streamline.absorb module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.streamline.collapse_repeated.html">finn.transformation.streamline.collapse_repeated module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.streamline.reorder.html">finn.transformation.streamline.reorder module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.streamline.round_thresholds.html">finn.transformation.streamline.round_thresholds module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.transformation.streamline.sign_to_thres.html">finn.transformation.streamline.sign_to_thres module</a></li> +</ul> </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> @@ -343,10 +193,10 @@ is unsigned, sets negative thresholds to zero.</p> <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.streamline.absorb.html" class="btn btn-neutral float-right" title="finn.transformation.streamline.absorb 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> + <a href="finn.transformation.fpgadataflow.templates.html" class="btn btn-neutral float-left" title="finn.transformation.fpgadataflow.templates module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> diff --git a/docs/finn/_build/html/source_code/finn.transformation.streamline.reorder.html b/docs/finn/_build/html/source_code/finn.transformation.streamline.reorder.html new file mode 100644 index 0000000000000000000000000000000000000000..042fffbdad5dd93e67fdbe53f1375f05247f2bcd --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.streamline.reorder.html @@ -0,0 +1,251 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..78981939ab8b41f740c812d001151b6250be4117 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.streamline.round_thresholds.html @@ -0,0 +1,226 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..a4a663b6212c678b919495839d3a8ed297f67b9e --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.transformation.streamline.sign_to_thres.html @@ -0,0 +1,224 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..8b2eefee430f06a86e11c6efb2fced6a9db5adc5 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.util.basic.html @@ -0,0 +1,305 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..de8e3cc3cd30caeacf71e5efaca2885068333fa3 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.util.data_packing.html @@ -0,0 +1,313 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..e78854a1b2cf5a039af601bd759b5a288affc303 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.util.fpgadataflow.html @@ -0,0 +1,237 @@ + + +<!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 eff5daeba706c16a69b15d1c41dc15cdf4f09cd6..900b9619f249debb90848e71021b4a4adfd56032 100644 --- a/docs/finn/_build/html/source_code/finn.util.html +++ b/docs/finn/_build/html/source_code/finn.util.html @@ -35,7 +35,8 @@ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> - <link rel="prev" title="finn.transformation.streamline package" href="finn.transformation.streamline.html" /> + <link rel="next" title="finn.util.basic module" href="finn.util.basic.html" /> + <link rel="prev" title="finn.transformation.infer_shapes module" href="finn.transformation.infer_shapes.html" /> </head> <body class="wy-body-for-nav"> @@ -155,272 +156,15 @@ <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 class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="finn.util.basic.html">finn.util.basic module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.util.data_packing.html">finn.util.data_packing module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.util.fpgadataflow.html">finn.util.fpgadataflow module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.util.onnx.html">finn.util.onnx module</a></li> +<li class="toctree-l1"><a class="reference internal" href="finn.util.test.html">finn.util.test module</a></li> +</ul> </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> @@ -435,8 +179,10 @@ is set, the innermost unpacked dimension will be reversed.</p> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + <a href="finn.util.basic.html" class="btn btn-neutral float-right" title="finn.util.basic 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> + <a href="finn.transformation.infer_shapes.html" class="btn btn-neutral float-left" title="finn.transformation.infer_shapes module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> diff --git a/docs/finn/_build/html/source_code/finn.util.onnx.html b/docs/finn/_build/html/source_code/finn.util.onnx.html new file mode 100644 index 0000000000000000000000000000000000000000..ef69d1d79e63715b7c361ddd0d9aa796a4999fd9 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.util.onnx.html @@ -0,0 +1,216 @@ + + +<!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 new file mode 100644 index 0000000000000000000000000000000000000000..6c9a032f1d7377a0583d32c76cf332de39ecf2e4 --- /dev/null +++ b/docs/finn/_build/html/source_code/finn.util.test.html @@ -0,0 +1,227 @@ + + +<!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/source_code/modules.html b/docs/finn/_build/html/source_code/modules.html index bd87c9b3e5e673db0ea2763e3da5a2429f14c828..9ab863aa306fe29cdb85a752d7028312408b574d 100644 --- a/docs/finn/_build/html/source_code/modules.html +++ b/docs/finn/_build/html/source_code/modules.html @@ -155,51 +155,28 @@ <li class="toctree-l3"><a class="reference internal" href="finn.analysis.html">finn.analysis package</a><ul> <li class="toctree-l4"><a class="reference internal" href="finn.analysis.html#subpackages">Subpackages</a></li> <li class="toctree-l4"><a class="reference internal" href="finn.analysis.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.analysis.html#module-finn.analysis.topology">finn.analysis.topology module</a></li> -<li class="toctree-l4"><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-l4"><a class="reference internal" href="finn.analysis.html#module-finn.analysis">Module contents</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="finn.core.html">finn.core package</a><ul> <li class="toctree-l4"><a class="reference internal" href="finn.core.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.core.html#module-finn.core.datatype">finn.core.datatype module</a></li> -<li class="toctree-l4"><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-l4"><a class="reference internal" href="finn.core.html#module-finn.core.modelwrapper">finn.core.modelwrapper module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.core.html#module-finn.core.onnx_exec">finn.core.onnx_exec module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.core.html#module-finn.core.remote_exec">finn.core.remote_exec module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.core.html#module-finn.core.rtlsim_exec">finn.core.rtlsim_exec module</a></li> <li class="toctree-l4"><a class="reference internal" href="finn.core.html#module-finn.core">Module contents</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="finn.custom_op.html">finn.custom_op package</a><ul> <li class="toctree-l4"><a class="reference internal" href="finn.custom_op.html#subpackages">Subpackages</a></li> <li class="toctree-l4"><a class="reference internal" href="finn.custom_op.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.custom_op.html#module-finn.custom_op.multithreshold">finn.custom_op.multithreshold module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.custom_op.html#module-finn.custom_op.registry">finn.custom_op.registry module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.custom_op.html#module-finn.custom_op.streamingdataflowpartition">finn.custom_op.streamingdataflowpartition module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.custom_op.html#module-finn.custom_op.xnorpopcount">finn.custom_op.xnorpopcount module</a></li> <li class="toctree-l4"><a class="reference internal" href="finn.custom_op.html#module-finn.custom_op">Module contents</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="finn.transformation.html">finn.transformation package</a><ul> <li class="toctree-l4"><a class="reference internal" href="finn.transformation.html#subpackages">Subpackages</a></li> <li class="toctree-l4"><a class="reference internal" href="finn.transformation.html#submodules">Submodules</a></li> -<li class="toctree-l4"><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-l4"><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-l4"><a class="reference internal" href="finn.transformation.html#module-finn.transformation.fold_constants">finn.transformation.fold_constants module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.html#module-finn.transformation.general">finn.transformation.general module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.html#module-finn.transformation.infer_datatypes">finn.transformation.infer_datatypes module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.transformation.html#module-finn.transformation.infer_shapes">finn.transformation.infer_shapes module</a></li> <li class="toctree-l4"><a class="reference internal" href="finn.transformation.html#module-finn.transformation">Module contents</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="finn.util.html">finn.util package</a><ul> <li class="toctree-l4"><a class="reference internal" href="finn.util.html#submodules">Submodules</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.util.html#module-finn.util.basic">finn.util.basic module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.util.html#module-finn.util.data_packing">finn.util.data_packing module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.util.html#module-finn.util.fpgadataflow">finn.util.fpgadataflow module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.util.html#module-finn.util.onnx">finn.util.onnx module</a></li> -<li class="toctree-l4"><a class="reference internal" href="finn.util.html#module-finn.util.test">finn.util.test module</a></li> <li class="toctree-l4"><a class="reference internal" href="finn.util.html#module-finn.util">Module contents</a></li> </ul> </li> diff --git a/docs/finn/source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.rst b/docs/finn/source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.rst new file mode 100644 index 0000000000000000000000000000000000000000..616064c16dfb61e9d66d7a8f9e76addd48e93ef9 --- /dev/null +++ b/docs/finn/source_code/finn.analysis.fpgadataflow.hls_synth_res_estimation.rst @@ -0,0 +1,7 @@ +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/source_code/finn.analysis.fpgadataflow.res_estimation.rst b/docs/finn/source_code/finn.analysis.fpgadataflow.res_estimation.rst new file mode 100644 index 0000000000000000000000000000000000000000..eb5b773b123cc686116313d1043b668601fc229f --- /dev/null +++ b/docs/finn/source_code/finn.analysis.fpgadataflow.res_estimation.rst @@ -0,0 +1,7 @@ +finn.analysis.fpgadataflow.res\_estimation module +================================================= + +.. automodule:: finn.analysis.fpgadataflow.res_estimation + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.analysis.fpgadataflow.rst b/docs/finn/source_code/finn.analysis.fpgadataflow.rst index cd8075d753f617f4e97a851e9b54139c966a18b2..4f5cd7cbbf2ab61770ab519e287e884f839ba2c0 100644 --- a/docs/finn/source_code/finn.analysis.fpgadataflow.rst +++ b/docs/finn/source_code/finn.analysis.fpgadataflow.rst @@ -4,22 +4,10 @@ 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: +.. toctree:: + finn.analysis.fpgadataflow.hls_synth_res_estimation + finn.analysis.fpgadataflow.res_estimation Module contents --------------- diff --git a/docs/finn/source_code/finn.analysis.rst b/docs/finn/source_code/finn.analysis.rst index e4eec7717a1119de8ef5381b67361973a9ac29c5..0799598595ff5f01dc23543bb5de9a14b3d8b863 100644 --- a/docs/finn/source_code/finn.analysis.rst +++ b/docs/finn/source_code/finn.analysis.rst @@ -11,22 +11,10 @@ Subpackages 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: +.. toctree:: + finn.analysis.topology + finn.analysis.verify_custom_nodes Module contents --------------- diff --git a/docs/finn/source_code/finn.analysis.topology.rst b/docs/finn/source_code/finn.analysis.topology.rst new file mode 100644 index 0000000000000000000000000000000000000000..896f3fb8d704c23a58f10f9513fd00ca7f7b99b0 --- /dev/null +++ b/docs/finn/source_code/finn.analysis.topology.rst @@ -0,0 +1,7 @@ +finn.analysis.topology module +============================= + +.. automodule:: finn.analysis.topology + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.analysis.verify_custom_nodes.rst b/docs/finn/source_code/finn.analysis.verify_custom_nodes.rst new file mode 100644 index 0000000000000000000000000000000000000000..60e1a33e25e6f8751aadd3e0181225af6e24e779 --- /dev/null +++ b/docs/finn/source_code/finn.analysis.verify_custom_nodes.rst @@ -0,0 +1,7 @@ +finn.analysis.verify\_custom\_nodes module +========================================== + +.. automodule:: finn.analysis.verify_custom_nodes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.core.datatype.rst b/docs/finn/source_code/finn.core.datatype.rst new file mode 100644 index 0000000000000000000000000000000000000000..d55952ecf81556365510a3191f2b2a75a6873f72 --- /dev/null +++ b/docs/finn/source_code/finn.core.datatype.rst @@ -0,0 +1,7 @@ +finn.core.datatype module +========================= + +.. automodule:: finn.core.datatype + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.core.execute_custom_node.rst b/docs/finn/source_code/finn.core.execute_custom_node.rst new file mode 100644 index 0000000000000000000000000000000000000000..94d8ea143fadf32caf874036d6f652de9561bc1f --- /dev/null +++ b/docs/finn/source_code/finn.core.execute_custom_node.rst @@ -0,0 +1,7 @@ +finn.core.execute\_custom\_node module +====================================== + +.. automodule:: finn.core.execute_custom_node + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.core.modelwrapper.rst b/docs/finn/source_code/finn.core.modelwrapper.rst new file mode 100644 index 0000000000000000000000000000000000000000..5bd74864ba63eda5b8a03093d02a6c54dabda973 --- /dev/null +++ b/docs/finn/source_code/finn.core.modelwrapper.rst @@ -0,0 +1,7 @@ +finn.core.modelwrapper module +============================= + +.. automodule:: finn.core.modelwrapper + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.core.onnx_exec.rst b/docs/finn/source_code/finn.core.onnx_exec.rst new file mode 100644 index 0000000000000000000000000000000000000000..87bf9d29dcf450d92529ce7987df8f59832ddd1a --- /dev/null +++ b/docs/finn/source_code/finn.core.onnx_exec.rst @@ -0,0 +1,7 @@ +finn.core.onnx\_exec module +=========================== + +.. automodule:: finn.core.onnx_exec + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.core.remote_exec.rst b/docs/finn/source_code/finn.core.remote_exec.rst new file mode 100644 index 0000000000000000000000000000000000000000..39c470eb0e4cc32c4d604dc3df7a7c9a51532d27 --- /dev/null +++ b/docs/finn/source_code/finn.core.remote_exec.rst @@ -0,0 +1,7 @@ +finn.core.remote\_exec module +============================= + +.. automodule:: finn.core.remote_exec + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.core.rst b/docs/finn/source_code/finn.core.rst index 6563d7a4342048e37e4eac5da6b47cf9798cdd73..acb9de8a753c6269411e35d45621c84f2ff4e0bc 100644 --- a/docs/finn/source_code/finn.core.rst +++ b/docs/finn/source_code/finn.core.rst @@ -4,54 +4,14 @@ 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: - -finn.core.remote\_exec module ------------------------------ - -.. automodule:: finn.core.remote_exec - :members: - :undoc-members: - :show-inheritance: - -finn.core.rtlsim\_exec module ------------------------------ - -.. automodule:: finn.core.rtlsim_exec - :members: - :undoc-members: - :show-inheritance: - +.. toctree:: + + finn.core.datatype + finn.core.execute_custom_node + finn.core.modelwrapper + finn.core.onnx_exec + finn.core.remote_exec + finn.core.rtlsim_exec Module contents --------------- diff --git a/docs/finn/source_code/finn.core.rtlsim_exec.rst b/docs/finn/source_code/finn.core.rtlsim_exec.rst new file mode 100644 index 0000000000000000000000000000000000000000..9d4acef6e8a61b537280ab441d7bb0bbf48158cf --- /dev/null +++ b/docs/finn/source_code/finn.core.rtlsim_exec.rst @@ -0,0 +1,7 @@ +finn.core.rtlsim\_exec module +============================= + +.. automodule:: finn.core.rtlsim_exec + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.rst b/docs/finn/source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.rst new file mode 100644 index 0000000000000000000000000000000000000000..aa36e86ee210e242ae7fd3e8447bb23663a7eb2c --- /dev/null +++ b/docs/finn/source_code/finn.custom_op.fpgadataflow.convolutioninputgenerator.rst @@ -0,0 +1,7 @@ +finn.custom\_op.fpgadataflow.convolutioninputgenerator module +============================================================= + +.. automodule:: finn.custom_op.fpgadataflow.convolutioninputgenerator + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.custom_op.fpgadataflow.rst b/docs/finn/source_code/finn.custom_op.fpgadataflow.rst index 632c021beb247e077f87c5af68d62bc51f88ecdc..79a05080b620797c79c6c7624a19010dbe3230d8 100644 --- a/docs/finn/source_code/finn.custom_op.fpgadataflow.rst +++ b/docs/finn/source_code/finn.custom_op.fpgadataflow.rst @@ -4,46 +4,13 @@ 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: +.. toctree:: + finn.custom_op.fpgadataflow.convolutioninputgenerator + finn.custom_op.fpgadataflow.streamingfclayer_batch + finn.custom_op.fpgadataflow.streamingmaxpool_batch + finn.custom_op.fpgadataflow.templates + finn.custom_op.fpgadataflow.tlastmarker Module contents --------------- diff --git a/docs/finn/source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.rst b/docs/finn/source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.rst new file mode 100644 index 0000000000000000000000000000000000000000..45a9a963a5a36e5152ff77dbe6b8ec08b1f60611 --- /dev/null +++ b/docs/finn/source_code/finn.custom_op.fpgadataflow.streamingfclayer_batch.rst @@ -0,0 +1,7 @@ +finn.custom\_op.fpgadataflow.streamingfclayer\_batch module +=========================================================== + +.. automodule:: finn.custom_op.fpgadataflow.streamingfclayer_batch + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.rst b/docs/finn/source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.rst new file mode 100644 index 0000000000000000000000000000000000000000..5bf7f666a42188a8a0e6ae2369d94fe2881694e9 --- /dev/null +++ b/docs/finn/source_code/finn.custom_op.fpgadataflow.streamingmaxpool_batch.rst @@ -0,0 +1,7 @@ +finn.custom\_op.fpgadataflow.streamingmaxpool\_batch module +=========================================================== + +.. automodule:: finn.custom_op.fpgadataflow.streamingmaxpool_batch + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.custom_op.fpgadataflow.templates.rst b/docs/finn/source_code/finn.custom_op.fpgadataflow.templates.rst new file mode 100644 index 0000000000000000000000000000000000000000..a630867a416a59c0d9b789289b48a930c6aca253 --- /dev/null +++ b/docs/finn/source_code/finn.custom_op.fpgadataflow.templates.rst @@ -0,0 +1,7 @@ +finn.custom\_op.fpgadataflow.templates module +============================================= + +.. automodule:: finn.custom_op.fpgadataflow.templates + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.custom_op.fpgadataflow.tlastmarker.rst b/docs/finn/source_code/finn.custom_op.fpgadataflow.tlastmarker.rst new file mode 100644 index 0000000000000000000000000000000000000000..8a087851c655080c70b434028fdae4315bd69f57 --- /dev/null +++ b/docs/finn/source_code/finn.custom_op.fpgadataflow.tlastmarker.rst @@ -0,0 +1,7 @@ +finn.custom\_op.fpgadataflow.tlastmarker module +=============================================== + +.. automodule:: finn.custom_op.fpgadataflow.tlastmarker + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.custom_op.multithreshold.rst b/docs/finn/source_code/finn.custom_op.multithreshold.rst new file mode 100644 index 0000000000000000000000000000000000000000..3cdf3cee7259a98c3e9bc95d2b1833a03fcfad98 --- /dev/null +++ b/docs/finn/source_code/finn.custom_op.multithreshold.rst @@ -0,0 +1,7 @@ +finn.custom\_op.multithreshold module +===================================== + +.. automodule:: finn.custom_op.multithreshold + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.custom_op.registry.rst b/docs/finn/source_code/finn.custom_op.registry.rst new file mode 100644 index 0000000000000000000000000000000000000000..7805e833b8d19b4a99de2466ce164e81911c179c --- /dev/null +++ b/docs/finn/source_code/finn.custom_op.registry.rst @@ -0,0 +1,7 @@ +finn.custom\_op.registry module +=============================== + +.. automodule:: finn.custom_op.registry + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.custom_op.rst b/docs/finn/source_code/finn.custom_op.rst index a984822aee2962c945a66deb50a3fd1233d5d2d0..fd2f070f2add73b0e28fc030ec2e2cab14d2c112 100644 --- a/docs/finn/source_code/finn.custom_op.rst +++ b/docs/finn/source_code/finn.custom_op.rst @@ -11,38 +11,12 @@ Subpackages 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: +.. toctree:: + finn.custom_op.multithreshold + finn.custom_op.registry + finn.custom_op.streamingdataflowpartition + finn.custom_op.xnorpopcount Module contents --------------- diff --git a/docs/finn/source_code/finn.custom_op.streamingdataflowpartition.rst b/docs/finn/source_code/finn.custom_op.streamingdataflowpartition.rst new file mode 100644 index 0000000000000000000000000000000000000000..1d07f01ce187842777676949195765bd7f841e6e --- /dev/null +++ b/docs/finn/source_code/finn.custom_op.streamingdataflowpartition.rst @@ -0,0 +1,7 @@ +finn.custom\_op.streamingdataflowpartition module +================================================= + +.. automodule:: finn.custom_op.streamingdataflowpartition + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.custom_op.xnorpopcount.rst b/docs/finn/source_code/finn.custom_op.xnorpopcount.rst new file mode 100644 index 0000000000000000000000000000000000000000..d916082782081f7ef2fb3fe02070abf4baf8e03f --- /dev/null +++ b/docs/finn/source_code/finn.custom_op.xnorpopcount.rst @@ -0,0 +1,7 @@ +finn.custom\_op.xnorpopcount module +=================================== + +.. automodule:: finn.custom_op.xnorpopcount + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.batchnorm_to_affine.rst b/docs/finn/source_code/finn.transformation.batchnorm_to_affine.rst new file mode 100644 index 0000000000000000000000000000000000000000..8d0ecfb75c7c6af460ff7d96a1dd45d008bc50ef --- /dev/null +++ b/docs/finn/source_code/finn.transformation.batchnorm_to_affine.rst @@ -0,0 +1,7 @@ +finn.transformation.batchnorm\_to\_affine module +================================================ + +.. automodule:: finn.transformation.batchnorm_to_affine + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.bipolar_to_xnor.rst b/docs/finn/source_code/finn.transformation.bipolar_to_xnor.rst new file mode 100644 index 0000000000000000000000000000000000000000..dc34f4def8d87339c3dc6d6a69ea97238f449ecd --- /dev/null +++ b/docs/finn/source_code/finn.transformation.bipolar_to_xnor.rst @@ -0,0 +1,7 @@ +finn.transformation.bipolar\_to\_xnor module +============================================ + +.. automodule:: finn.transformation.bipolar_to_xnor + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.fold_constants.rst b/docs/finn/source_code/finn.transformation.fold_constants.rst new file mode 100644 index 0000000000000000000000000000000000000000..792f8bfe03d04735c9571a8016ecc941a88ffd25 --- /dev/null +++ b/docs/finn/source_code/finn.transformation.fold_constants.rst @@ -0,0 +1,7 @@ +finn.transformation.fold\_constants module +========================================== + +.. automodule:: finn.transformation.fold_constants + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.fpgadataflow.cleanup.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.cleanup.rst new file mode 100644 index 0000000000000000000000000000000000000000..38cc49897e6d52dfdc8e4c4694458ff3df81e6f1 --- /dev/null +++ b/docs/finn/source_code/finn.transformation.fpgadataflow.cleanup.rst @@ -0,0 +1,7 @@ +finn.transformation.fpgadataflow.cleanup module +=============================================== + +.. automodule:: finn.transformation.fpgadataflow.cleanup + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.fpgadataflow.codegen_ipgen.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.codegen_ipgen.rst new file mode 100644 index 0000000000000000000000000000000000000000..158ad7602cfa17fe3c6c1e0232b46d6a0c1743ce --- /dev/null +++ b/docs/finn/source_code/finn.transformation.fpgadataflow.codegen_ipgen.rst @@ -0,0 +1,7 @@ +finn.transformation.fpgadataflow.codegen\_ipgen module +====================================================== + +.. automodule:: finn.transformation.fpgadataflow.codegen_ipgen + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.fpgadataflow.codegen_ipstitch.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.codegen_ipstitch.rst new file mode 100644 index 0000000000000000000000000000000000000000..d3f7434e3b02759206119ee08591a7494e7307ad --- /dev/null +++ b/docs/finn/source_code/finn.transformation.fpgadataflow.codegen_ipstitch.rst @@ -0,0 +1,7 @@ +finn.transformation.fpgadataflow.codegen\_ipstitch module +========================================================= + +.. automodule:: finn.transformation.fpgadataflow.codegen_ipstitch + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.fpgadataflow.codegen_npysim.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.codegen_npysim.rst new file mode 100644 index 0000000000000000000000000000000000000000..28796da29a9f01ba47d2c5236db01f639f653d3b --- /dev/null +++ b/docs/finn/source_code/finn.transformation.fpgadataflow.codegen_npysim.rst @@ -0,0 +1,7 @@ +finn.transformation.fpgadataflow.codegen\_npysim module +======================================================= + +.. automodule:: finn.transformation.fpgadataflow.codegen_npysim + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.fpgadataflow.compile.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.compile.rst new file mode 100644 index 0000000000000000000000000000000000000000..3d36a046be002093b813b0b97539b869f115ba77 --- /dev/null +++ b/docs/finn/source_code/finn.transformation.fpgadataflow.compile.rst @@ -0,0 +1,7 @@ +finn.transformation.fpgadataflow.compile module +=============================================== + +.. automodule:: finn.transformation.fpgadataflow.compile + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.rst new file mode 100644 index 0000000000000000000000000000000000000000..0ae11a41bf3e3720fa97dfda2406af9ce67327a8 --- /dev/null +++ b/docs/finn/source_code/finn.transformation.fpgadataflow.convert_to_hls_layers.rst @@ -0,0 +1,7 @@ +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/source_code/finn.transformation.fpgadataflow.create_dataflow_partition.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.create_dataflow_partition.rst new file mode 100644 index 0000000000000000000000000000000000000000..4827fd5b2cc335fba321835f472da6dfd1e821af --- /dev/null +++ b/docs/finn/source_code/finn.transformation.fpgadataflow.create_dataflow_partition.rst @@ -0,0 +1,7 @@ +finn.transformation.fpgadataflow.create\_dataflow\_partition module +=================================================================== + +.. automodule:: finn.transformation.fpgadataflow.create_dataflow_partition + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.rst new file mode 100644 index 0000000000000000000000000000000000000000..47af9049f0f77e66343868d877ab43d6a03ef299 --- /dev/null +++ b/docs/finn/source_code/finn.transformation.fpgadataflow.hlssynth_ipgen.rst @@ -0,0 +1,7 @@ +finn.transformation.fpgadataflow.hlssynth\_ipgen module +======================================================= + +.. automodule:: finn.transformation.fpgadataflow.hlssynth_ipgen + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.fpgadataflow.insert_tlastmarker.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.insert_tlastmarker.rst new file mode 100644 index 0000000000000000000000000000000000000000..d4bd00b8c3e3467df421f0efb9fd993851d5e44d --- /dev/null +++ b/docs/finn/source_code/finn.transformation.fpgadataflow.insert_tlastmarker.rst @@ -0,0 +1,7 @@ +finn.transformation.fpgadataflow.insert\_tlastmarker module +=========================================================== + +.. automodule:: finn.transformation.fpgadataflow.insert_tlastmarker + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.fpgadataflow.make_deployment.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.make_deployment.rst new file mode 100644 index 0000000000000000000000000000000000000000..130c91989090a9b1d73d12e413227c8008161930 --- /dev/null +++ b/docs/finn/source_code/finn.transformation.fpgadataflow.make_deployment.rst @@ -0,0 +1,7 @@ +finn.transformation.fpgadataflow.make\_deployment module +======================================================== + +.. automodule:: finn.transformation.fpgadataflow.make_deployment + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.fpgadataflow.make_pynq_driver.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.make_pynq_driver.rst new file mode 100644 index 0000000000000000000000000000000000000000..5238f08460a4ff9580273891461e2a3409605834 --- /dev/null +++ b/docs/finn/source_code/finn.transformation.fpgadataflow.make_pynq_driver.rst @@ -0,0 +1,7 @@ +finn.transformation.fpgadataflow.make\_pynq\_driver module +========================================================== + +.. automodule:: finn.transformation.fpgadataflow.make_pynq_driver + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.fpgadataflow.make_pynq_proj.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.make_pynq_proj.rst new file mode 100644 index 0000000000000000000000000000000000000000..1d040887f9a2ab2d33bf4ff9ea69ac835cbba8a7 --- /dev/null +++ b/docs/finn/source_code/finn.transformation.fpgadataflow.make_pynq_proj.rst @@ -0,0 +1,7 @@ +finn.transformation.fpgadataflow.make\_pynq\_proj module +======================================================== + +.. automodule:: finn.transformation.fpgadataflow.make_pynq_proj + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.fpgadataflow.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.rst index 435eacf2c4684a3fc9a855f4eee153cb52ea7772..f99673391cc42d9724eb5e584f910b9aa36721c3 100644 --- a/docs/finn/source_code/finn.transformation.fpgadataflow.rst +++ b/docs/finn/source_code/finn.transformation.fpgadataflow.rst @@ -4,126 +4,23 @@ 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\_exec\_mode module -------------------------------------------------------- - -.. automodule:: finn.transformation.fpgadataflow.set_exec_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: - +.. toctree:: + + finn.transformation.fpgadataflow.cleanup + finn.transformation.fpgadataflow.codegen_ipgen + finn.transformation.fpgadataflow.codegen_ipstitch + finn.transformation.fpgadataflow.codegen_npysim + finn.transformation.fpgadataflow.compile + finn.transformation.fpgadataflow.convert_to_hls_layers + finn.transformation.fpgadataflow.create_dataflow_partition + finn.transformation.fpgadataflow.hlssynth_ipgen + finn.transformation.fpgadataflow.insert_tlastmarker + finn.transformation.fpgadataflow.make_deployment + finn.transformation.fpgadataflow.make_pynq_driver + finn.transformation.fpgadataflow.make_pynq_proj + finn.transformation.fpgadataflow.set_exec_mode + finn.transformation.fpgadataflow.synth_pynq_proj + finn.transformation.fpgadataflow.templates Module contents --------------- diff --git a/docs/finn/source_code/finn.transformation.fpgadataflow.set_exec_mode.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.set_exec_mode.rst new file mode 100644 index 0000000000000000000000000000000000000000..7affa78b43e253b781deffce3044d9ca46319b96 --- /dev/null +++ b/docs/finn/source_code/finn.transformation.fpgadataflow.set_exec_mode.rst @@ -0,0 +1,7 @@ +finn.transformation.fpgadataflow.set\_exec\_mode module +======================================================= + +.. automodule:: finn.transformation.fpgadataflow.set_exec_mode + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.fpgadataflow.synth_pynq_proj.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.synth_pynq_proj.rst new file mode 100644 index 0000000000000000000000000000000000000000..e902991a6920a7bf4617814df95ced28a7cd268c --- /dev/null +++ b/docs/finn/source_code/finn.transformation.fpgadataflow.synth_pynq_proj.rst @@ -0,0 +1,7 @@ +finn.transformation.fpgadataflow.synth\_pynq\_proj module +========================================================= + +.. automodule:: finn.transformation.fpgadataflow.synth_pynq_proj + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.fpgadataflow.templates.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.templates.rst new file mode 100644 index 0000000000000000000000000000000000000000..a62f377830c8661f9a7f106e19d3c203a8019d81 --- /dev/null +++ b/docs/finn/source_code/finn.transformation.fpgadataflow.templates.rst @@ -0,0 +1,7 @@ +finn.transformation.fpgadataflow.templates module +================================================= + +.. automodule:: finn.transformation.fpgadataflow.templates + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.general.rst b/docs/finn/source_code/finn.transformation.general.rst new file mode 100644 index 0000000000000000000000000000000000000000..bfae28100b9e91d5b1d0b728d410a6ec472bc4d4 --- /dev/null +++ b/docs/finn/source_code/finn.transformation.general.rst @@ -0,0 +1,7 @@ +finn.transformation.general module +================================== + +.. automodule:: finn.transformation.general + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.infer_datatypes.rst b/docs/finn/source_code/finn.transformation.infer_datatypes.rst new file mode 100644 index 0000000000000000000000000000000000000000..939d1552157f21b451f4b583ade611b3ae41ab5d --- /dev/null +++ b/docs/finn/source_code/finn.transformation.infer_datatypes.rst @@ -0,0 +1,7 @@ +finn.transformation.infer\_datatypes module +=========================================== + +.. automodule:: finn.transformation.infer_datatypes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.infer_shapes.rst b/docs/finn/source_code/finn.transformation.infer_shapes.rst new file mode 100644 index 0000000000000000000000000000000000000000..9469557061e450ba356c96f615a1f438be878047 --- /dev/null +++ b/docs/finn/source_code/finn.transformation.infer_shapes.rst @@ -0,0 +1,7 @@ +finn.transformation.infer\_shapes module +======================================== + +.. automodule:: finn.transformation.infer_shapes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.rst b/docs/finn/source_code/finn.transformation.rst index 172f6e300f3894dba3b13355120bcb4e23d737e1..da9618ed64e7dbe73ecb376ae9c3faa5992f4f31 100644 --- a/docs/finn/source_code/finn.transformation.rst +++ b/docs/finn/source_code/finn.transformation.rst @@ -12,54 +12,14 @@ Subpackages 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: +.. toctree:: + finn.transformation.batchnorm_to_affine + finn.transformation.bipolar_to_xnor + finn.transformation.fold_constants + finn.transformation.general + finn.transformation.infer_datatypes + finn.transformation.infer_shapes Module contents --------------- diff --git a/docs/finn/source_code/finn.transformation.streamline.absorb.rst b/docs/finn/source_code/finn.transformation.streamline.absorb.rst new file mode 100644 index 0000000000000000000000000000000000000000..597a98944b984b1c51b978f8986e300369b533cd --- /dev/null +++ b/docs/finn/source_code/finn.transformation.streamline.absorb.rst @@ -0,0 +1,7 @@ +finn.transformation.streamline.absorb module +============================================ + +.. automodule:: finn.transformation.streamline.absorb + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.streamline.collapse_repeated.rst b/docs/finn/source_code/finn.transformation.streamline.collapse_repeated.rst new file mode 100644 index 0000000000000000000000000000000000000000..a15f72aea74e99f5beef9109f06e2afa38de6619 --- /dev/null +++ b/docs/finn/source_code/finn.transformation.streamline.collapse_repeated.rst @@ -0,0 +1,7 @@ +finn.transformation.streamline.collapse\_repeated module +======================================================== + +.. automodule:: finn.transformation.streamline.collapse_repeated + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.streamline.reorder.rst b/docs/finn/source_code/finn.transformation.streamline.reorder.rst new file mode 100644 index 0000000000000000000000000000000000000000..ac969e1329f444f48df00f7101b5cd1e3da5c363 --- /dev/null +++ b/docs/finn/source_code/finn.transformation.streamline.reorder.rst @@ -0,0 +1,7 @@ +finn.transformation.streamline.reorder module +============================================= + +.. automodule:: finn.transformation.streamline.reorder + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.streamline.round_thresholds.rst b/docs/finn/source_code/finn.transformation.streamline.round_thresholds.rst new file mode 100644 index 0000000000000000000000000000000000000000..031c65d077f63a3f120211e2ab122c291c5a96e1 --- /dev/null +++ b/docs/finn/source_code/finn.transformation.streamline.round_thresholds.rst @@ -0,0 +1,7 @@ +finn.transformation.streamline.round\_thresholds module +======================================================= + +.. automodule:: finn.transformation.streamline.round_thresholds + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.transformation.streamline.rst b/docs/finn/source_code/finn.transformation.streamline.rst index 33e5930952e01881dfb7e1b19eae11ebc25ac4e0..5b3a88384a38950fb6aa4084093181650319bd27 100644 --- a/docs/finn/source_code/finn.transformation.streamline.rst +++ b/docs/finn/source_code/finn.transformation.streamline.rst @@ -4,46 +4,13 @@ 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: +.. toctree:: + finn.transformation.streamline.absorb + finn.transformation.streamline.collapse_repeated + finn.transformation.streamline.reorder + finn.transformation.streamline.round_thresholds + finn.transformation.streamline.sign_to_thres Module contents --------------- diff --git a/docs/finn/source_code/finn.transformation.streamline.sign_to_thres.rst b/docs/finn/source_code/finn.transformation.streamline.sign_to_thres.rst new file mode 100644 index 0000000000000000000000000000000000000000..166717eb352ed0044ad817dc36409a1860f3789c --- /dev/null +++ b/docs/finn/source_code/finn.transformation.streamline.sign_to_thres.rst @@ -0,0 +1,7 @@ +finn.transformation.streamline.sign\_to\_thres module +===================================================== + +.. automodule:: finn.transformation.streamline.sign_to_thres + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.util.basic.rst b/docs/finn/source_code/finn.util.basic.rst new file mode 100644 index 0000000000000000000000000000000000000000..10e8e1ac1c9e9f7f449ce8f3a413424c529b3fa1 --- /dev/null +++ b/docs/finn/source_code/finn.util.basic.rst @@ -0,0 +1,7 @@ +finn.util.basic module +====================== + +.. automodule:: finn.util.basic + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.util.data_packing.rst b/docs/finn/source_code/finn.util.data_packing.rst new file mode 100644 index 0000000000000000000000000000000000000000..6a39cc14b157646fc5305674a18b250d4a0b0946 --- /dev/null +++ b/docs/finn/source_code/finn.util.data_packing.rst @@ -0,0 +1,7 @@ +finn.util.data\_packing module +============================== + +.. automodule:: finn.util.data_packing + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.util.fpgadataflow.rst b/docs/finn/source_code/finn.util.fpgadataflow.rst new file mode 100644 index 0000000000000000000000000000000000000000..3472ed477b9680baa99a91ce70850bedc79daf6b --- /dev/null +++ b/docs/finn/source_code/finn.util.fpgadataflow.rst @@ -0,0 +1,7 @@ +finn.util.fpgadataflow module +============================= + +.. automodule:: finn.util.fpgadataflow + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.util.onnx.rst b/docs/finn/source_code/finn.util.onnx.rst new file mode 100644 index 0000000000000000000000000000000000000000..057cb07cadcaf5819b21bb61878b0964eecbdace --- /dev/null +++ b/docs/finn/source_code/finn.util.onnx.rst @@ -0,0 +1,7 @@ +finn.util.onnx module +===================== + +.. automodule:: finn.util.onnx + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/finn/source_code/finn.util.rst b/docs/finn/source_code/finn.util.rst index 1c85bcd44b63343ecab12ee12ba82c83d4fc984d..c66d189b3ae0c79b9890cf9b4885916a06f4768c 100644 --- a/docs/finn/source_code/finn.util.rst +++ b/docs/finn/source_code/finn.util.rst @@ -4,46 +4,13 @@ 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: +.. toctree:: + finn.util.basic + finn.util.data_packing + finn.util.fpgadataflow + finn.util.onnx + finn.util.test Module contents --------------- diff --git a/docs/finn/source_code/finn.util.test.rst b/docs/finn/source_code/finn.util.test.rst new file mode 100644 index 0000000000000000000000000000000000000000..3fe1bc15e529a36546a589b0b43f26dee58b4511 --- /dev/null +++ b/docs/finn/source_code/finn.util.test.rst @@ -0,0 +1,7 @@ +finn.util.test module +===================== + +.. automodule:: finn.util.test + :members: + :undoc-members: + :show-inheritance: