Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update stages.rst and add description for SearchUnusedMemoryStage and RemoveUnsedMemoryStage #28

Merged
merged 1 commit into from
Oct 23, 2023
Merged

update stages.rst and add description for SearchUnusedMemoryStage and RemoveUnsedMemoryStage #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/source/stages.rst
View file
Open in desktop
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
Loading