Skip to content

Commit c5c2b75

Browse files
authored
Add in citation
1 parent ac1ed1d commit c5c2b75

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
For example, you can run this command `rm -rf /tmp/torch_extensions/quant_cuda /tmp/torch_extensions/quant_cpu` if
1717
you are using the default directory for pytorch extensions.
1818

19-
19+
# Overview
2020
QPyTorch is a low-precision arithmetic simulation package in
2121
PyTorch. It is designed to support researches on low-precision machine
2222
learning, especially for researches in low-precision training.
@@ -32,6 +32,8 @@ example replication of [WAGE](https://arxiv.org/abs/1802.04680) in a downstream
3232
repo [WAGE](https://github.com/Tiiiger/QPyTorch/blob/master/examples/WAGE). We also provide a list
3333
of working examples under [Examples](#examples).
3434

35+
A more comprehensive write-up can be found [here](https://arxiv.org/abs/1910.04540)
36+
3537
*Note*: QPyTorch relies on PyTorch functions for the underlying computation,
3638
such as matrix multiplication. This means that the actual computation is done in
3739
single precision. Therefore, QPyTorch is not intended to be used to study the
@@ -41,6 +43,18 @@ numerical behavior of different **accumulation** strategies.
4143
PyTorch does round-to-nearest-even. This will create a discrepancy between the PyTorch half-precision tensor
4244
and QPyTorch's simulation of half-precision numbers.
4345

46+
if you find this repo useful please cite
47+
```
48+
@misc{zhang2019qpytorch,
49+
title={QPyTorch: A Low-Precision Arithmetic Simulation Framework},
50+
author={Tianyi Zhang and Zhiqiu Lin and Guandao Yang and Christopher De Sa},
51+
year={2019},
52+
eprint={1910.04540},
53+
archivePrefix={arXiv},
54+
primaryClass={cs.LG}
55+
}
56+
```
57+
4458
## Installation
4559

4660
requirements:

0 commit comments

Comments
 (0)