Skip to content

Commit 3df0d6d

Browse files
committed
Add citation to README
1 parent 3a90c95 commit 3df0d6d

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,17 @@ conda install -c torchhd torchhd
3535

3636
You can find documentation for Torchhd [on the website](https://torchhd.readthedocs.io).
3737

38+
Check out the [Getting Started](https://torchhd.readthedocs.io/en/stable/getting_started.html) page for a quick overview.
39+
40+
The API documentation is divided into several sections:
41+
42+
- [`torchhd.functional`](https://torchhd.readthedocs.io/en/stable/functional.html)
43+
- [`torchhd.embeddings`](https://torchhd.readthedocs.io/en/stable/embeddings.html)
44+
- [`torchhd.structures`](https://torchhd.readthedocs.io/en/stable/structures.html)
45+
- [`torchhd.datasets`](https://torchhd.readthedocs.io/en/stable/datasets.html)
46+
47+
You can improve the documentation by sending pull requests to this repository.
48+
3849
## Examples
3950

4051
We have several examples [in the repository](https://github.com/hyperdimensional-computing/torchhd/tree/main/examples). Here is a simple one to get you started:
@@ -100,3 +111,17 @@ To build the documentation locally, use `pip install -r docs/requirements.txt` t
100111
### License
101112

102113
This library is [MIT licensed](https://github.com/hyperdimensional-computing/torchhd/blob/main/LICENSE).
114+
115+
116+
## Cite
117+
118+
Consider citing [our paper](https://arxiv.org/abs/2205.09208) if you use Torchhd in your work:
119+
120+
```
121+
@article{heddes2022torchhd,
122+
title={Torchhd: An Open-Source Python Library to Support Hyperdimensional Computing Research},
123+
author={Heddes, Mike and Nunes, Igor and Vergés, Pere and Desai, Dheyay and Givargis, Tony and Nicolau, Alexandru},
124+
journal={arXiv preprint arXiv:2205.09208},
125+
year={2022}
126+
}
127+
```

0 commit comments

Comments
 (0)