Skip to content

Commit

Permalink
update stage.rst description
Browse files Browse the repository at this point in the history
  • Loading branch information
JiacongSun committed Oct 23, 2023
1 parent c65c138 commit fe3f889
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/source/stages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,11 @@ Cost model stages
-----------------
* `CostModelStage <https://github.com/KULeuven-MICAS/zigzag/tree/master/zigzag/classes/stages/CostModelStage.py#L15>`_: Pipeline stage that calls a cost model to evaluate a (temporal and spatial) mapping on a HW config.
Hardware modification stages
-----------------
* `SearchUnusedMemoryStage <https://github.com/KULeuven-MICAS/zigzag/blob/master/zigzag/classes/stages/SearchUnusedMemoryStage.py#L74>`_: Class that iterates through the memory instances and return the lowest allowed memory level for each operand for the usage of the next layer. The class must be placed before the WorkloadStage. The parameter `workload_data_always_from_top_mem <https://github.com/KULeuven-MICAS/zigzag/blob/master/zigzag/classes/stages/SearchUnusedMemoryStage.py#L164>`_ is False by default, which means the initial input and final output of the entire workload can be from a memory level lower than the highest memory level. You can set it to True if the initial input data and final output of the entire workload must travel from/to the highest memory level.
* `RemoveUnusedMemoryStage <https://github.com/KULeuven-MICAS/zigzag/blob/master/zigzag/classes/stages/RemoveUnusedMemoryStage.py#L34>`_: Class that remove the unused memory instances according to the result of SearchUnusedMemoryStage. Each memory instance with a level higher than the level returned from SearchUnusedMemoryStage will be considered as an unused memory and will be removed. This stage must be placed after the WorkloadStage.
Creating your custom stage
==========================
Expand Down

0 comments on commit fe3f889

Please sign in to comment.