提交 d2611b94 authored 作者: carriepl's avatar carriepl

Add section on accessing Scan's inputs by type

上级 7036ea80
......@@ -192,3 +192,25 @@ Optimizations
Helper classes and functions
============================
Because of the complexity involved in dealing with Scan, a large number of
helper classes and functions have been developped over time to implement
operations commonly needed when dealing with the Scan op. The Scan op
itself defines a large number of them and others can be found in the file
`scan_utils.py`. This sections aims to point out the most useful ones and
organize them according to their uses.
Accessing/manipulating Scan's inputs and outputs by type
--------------------------------------------------------
Declared in `scan_utils.py`, the class `scan_args` handles the parsing
of the inputs and outputs (both inner and outer) to a format that is easier to
analyse and manipulate. Without this class, analysing scan's inputs and
outputs often required convoluted logic which make for code that is hard to
read and to maintain. Because of this, you should favor using `scan_args` when
it is practical and appropriate to do so.
The Scan op also defines a few helper functions for this purpose, such as
`inner_nitsot_outs()` or `mitmot_out_taps()`, but they are often poorly
documented and easy to misuse. These should be used with great care.
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论