mscclpp

mirror of https://github.com/microsoft/mscclpp.git synced 2026-05-12 01:10:22 +00:00

Files

Binyang Li f1b2c9df12 Fix performance downgrade issue & update doc (#229 )

For push function, we only need to make sure the instruction `st.global`
will be executed after the while loop. Since there is a Write-After-Read
hazard for `trigger.fst` (Check `this->triggers[curFifoHead % size].fst
!= 0` first then write value to `triggers[curFifoHead % size]`), we can
expect the compiler and hardware can handle this situation correctly.
Remove the `release.sys` there.

BTW, `st.global.release.sys.v2.u64` will cause perf regression issue.
Previous we use `st.global.release.cta.v2.u64`, but seems not necessary.

2023-12-04 10:20:10 -08:00

figs

Update documentation (#217 )

2023-11-22 12:58:04 -08:00

.gitignore

Update documentation (#217 )

2023-11-22 12:58:04 -08:00

conf.py

Update documentation (#217 )

2023-11-22 12:58:04 -08:00

Doxyfile

Update documentation (#217 )

2023-11-22 12:58:04 -08:00

index.rst

Update documentation (#217 )

2023-11-22 12:58:04 -08:00

make.bat

Update documentation (#217 )

2023-11-22 12:58:04 -08:00

Makefile

Update documentation (#217 )

2023-11-22 12:58:04 -08:00

performance-ndmv4.md

Update documentation (#217 )

2023-11-22 12:58:04 -08:00

quickstart.md

Fix performance downgrade issue & update doc (#229 )

2023-12-04 10:20:10 -08:00

README.md

Update documentation (#217 )

2023-11-22 12:58:04 -08:00

README.md

How to build docs

Install doxygen.
```
$ sudo apt-get install doxygen
```
Install Python packages below. If you install them on the user's local, you need to include ~/.local/bin to $PATH (to use sphinx-build).
```
$ sudo python3 -m pip install sphinx sphinx_rtd_theme breathe
```
Create Doxygen documents.
```
$ doxygen
```

Create Sphinx documents.

$ sphinx-build -b html -Dbreathe_projects.mscclpp=$PWD/doxygen/xml $PWD $PWD/sphinx

Done. The HTML files will be on sphinx/ directory.