InfiniTensor/README.md

# InfiniTensor

## Compilation on Lotus
``` bash
# Enter the root of InfiniTensor
source test/script/env_lotus.sh 
mkdir build && cd build
cmake -DUSE_CUDA=ON .. && make -j 12
```

## Contributor Guide
InfiniTensor development is based on the pull request on Github. Before requesting for merging, a PR should satisfy the following requirements
1. Pass all tests. 
    1. Currently, CI on Github only checks code format. Script `test/script/clang_format_inplace.sh` is for formatting all code. 
    2. Contributors should run `ctest` manually and copy its output to the PR. Use fenced code blocks (triple backquotes, i.e., `` ``` ``) to avoid referencing in Github. Otherwise, `#` in the output is interpreted as a Github reference. Do not directly paste the ctest output in commit messages either for the same reason.  
2. Receive at least one approval from reviewers. 
3. PR title should be concise since it is going to be the commit message in the main branch after merging and squashing.
Add CUDA runtime (#6) * Fix: add warm-up and repetition in timing * Add: CUDA runtime and float support * Refactor: Cuda and Cpu runtimes inherit Runtime * Add: environment script for Lotus * Add: Lotus build instructions * Update README.md Co-authored-by: Liyan Zheng <liyan-zheng@outlook.com> 2022-08-22 15:01:03 +08:00			`# InfiniTensor`

			`## Compilation on Lotus`
			``` bash
			`# Enter the root of InfiniTensor`
			`source test/script/env_lotus.sh`
			`mkdir build && cd build`
Update README.md 2022-09-22 17:38:15 +08:00			`cmake -DUSE_CUDA=ON .. && make -j 12`
Add CUDA runtime (#6) * Fix: add warm-up and repetition in timing * Add: CUDA runtime and float support * Refactor: Cuda and Cpu runtimes inherit Runtime * Add: environment script for Lotus * Add: Lotus build instructions * Update README.md Co-authored-by: Liyan Zheng <liyan-zheng@outlook.com> 2022-08-22 15:01:03 +08:00			```
Add contributor guide 2022-09-13 14:19:07 +08:00
			`## Contributor Guide`
			`InfiniTensor development is based on the pull request on Github. Before requesting for merging, a PR should satisfy the following requirements`
			`1. Pass all tests.`
			1. Currently, CI on Github only checks code format. Script `test/script/clang_format_inplace.sh` is for formatting all code.
			2. Contributors should run `ctest` manually and copy its output to the PR. Use fenced code blocks (triple backquotes, i.e., `` ``` ``) to avoid referencing in Github. Otherwise, `#` in the output is interpreted as a Github reference. Do not directly paste the ctest output in commit messages either for the same reason.
			`2. Receive at least one approval from reviewers.`
			`3. PR title should be concise since it is going to be the commit message in the main branch after merging and squashing.`