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

add in README to sam/sim/src that describes statistics #64

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

add in README to sam/sim/src that describes statistics #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4d080b9
add in README to sam/sim/src that describes statisticswq
weiya711 Oct 20, 2022
dfc18a1
Updated README to include active branches
weiya711 May 3, 2023
2b04749
Merge branch 'master' of github.com:weiya711/sam into documentation
weiya711 May 3, 2023
3b67d99
Update README table
weiya711 May 4, 2023
1ddf89a
Move active branches to wiki
weiya711 May 4, 2023
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
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,5 +115,6 @@ sim
## SAM Binding to Onyx
See the `README` in `sam/sam/onyx`


## License
All files in this project (code, scripts, documentaiton) are released under the [MIT License](LICENSE)
17 changes: 17 additions & 0 deletions sam/sim/src/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Statistics Information

## Level Scanner (Read Scanner)
Uncompressed Coordinate Level Scanner: None

Compressed Coordinate Level Scanner:
| Statistic Name | Description |
| ----------- | ----------- |
| total\_size | Length of coordinate array |
| outputs\_by\_block | Total number of NON-CONTROL tokens output to `ref` and `crd` |
| unique\_refs | Number of unique `ref` INPUT to the read scanner |
| total\_elements\_skipped | Number of elements (one skip can skip multiple elements) skipped |
| total\_skips\_encountered | Number of skips that are actually processed (and not ignored) |
| intersection\_behind\_rd | Count of skip coordinates that are ignored for being behind (too small) |
| intersection\_behind\_fiber | Count of how many times the skip stream is ignored for fiber(s) behind the input `ref` |
| stop\_tokens | Total number of stop tokens emitted |
| stop\_tkn\_cnt | Number of stop tokens input by the skip stream |