Skip to content

Commit 132ee17

Browse files
committed
Reformat README
1 parent 8cf6125 commit 132ee17

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
<a href="https://github.com/hyperdimensional-computing/torchhd/blob/main/LICENSE"><img alt="GitHub license" src="https://img.shields.io/badge/license-MIT-orange.svg?style=flat" /></a>
33
<a href="https://pypi.org/project/torch-hd/"><img alt="pypi version" src="https://img.shields.io/pypi/v/torch-hd.svg?style=flat&color=orange" /></a>
44
<a href="https://anaconda.org/torchhd/torchhd"><img alt="conda version" src="https://img.shields.io/conda/v/torchhd/torchhd?label=conda&style=flat&color=orange" /></a>
5-
<a href="https://github.com/hyperdimensional-computing/torchhd/actions/workflows/test.yml?query=branch%3Amain"><img alt="tests status" src="https://img.shields.io/github/actions/workflow/status/hyperdimensional-computing/torchhd/test.yml?branch=main&label=tests&style=flat" />
6-
</a><img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" />
5+
<a href="https://github.com/hyperdimensional-computing/torchhd/actions/workflows/test.yml?query=branch%3Amain"><img alt="tests status" src="https://img.shields.io/github/actions/workflow/status/hyperdimensional-computing/torchhd/test.yml?branch=main&label=tests&style=flat" /></a>
6+
<img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" />
77
</p>
88

99
<div align="center">
@@ -14,10 +14,10 @@
1414

1515
# Torchhd
1616

17-
Torchhd is a Python library for *Hyperdimensional Computing* (also known as *Vector Symbolic Architectures*).
17+
Torchhd is a Python library for _Hyperdimensional Computing_ (also known as _Vector Symbolic Architectures_).
1818

19-
* **Easy-to-use:** Torchhd makes it painless to develop a wide range of Hyperdimensional Computing (HDC) applications and algorithms. For someone new to the field, we provide Pythonic abstractions and examples to get you started fast. For the experienced researchers, we made the library modular by design, giving you endless flexibility to prototype new ideas in no-time.
20-
* **Performant:** The library is build on top of the high-performance [PyTorch](https://pytorch.org/) library, giving you optimized tensor execution without the headaches. Moreover, PyTorch makes it effortless to accelerate your code on a GPU.
19+
- **Easy-to-use:** Torchhd makes it painless to develop a wide range of Hyperdimensional Computing (HDC) applications and algorithms. For someone new to the field, we provide Pythonic abstractions and examples to get you started fast. For the experienced researchers, we made the library modular by design, giving you endless flexibility to prototype new ideas in no-time.
20+
- **Performant:** The library is build on top of the high-performance [PyTorch](https://pytorch.org/) library, giving you optimized tensor execution without the headaches. Moreover, PyTorch makes it effortless to accelerate your code on a GPU.
2121

2222
## Installation
2323

@@ -87,6 +87,7 @@ torchhd.cosine_similarity(usd_of_mex, memory)
8787
This example is from the paper [What We Mean When We Say "What's the Dollar of Mexico?": Prototypes and Mapping in Concept Space](https://redwood.berkeley.edu/wp-content/uploads/2020/05/kanerva2010what.pdf) by Kanerva. It first creates hypervectors for all the symbols that are used in the computation, i.e., the variables for `country`, `capital`, and `currency` and their values for both countries. These hypervectors are then combined to make a single hypervector for each country using a hash table structure. A hash table encodes key-value pairs as: `k1 * v1 + k2 * v2 + ... + kn * vn`. The hash tables are then bound together to form their combined representation which is finally queried by binding with the Dollar hypervector to obtain the approximate Mexican Peso hypervector. The similarity output shows that the Mexican Peso hypervector is indeed the most similar one.
8888

8989
## Supported HDC/VSA models
90+
9091
Currently, the library supports the following HDC/VSA models:
9192

9293
- [Multiply-Add-Permute (MAP)](https://torchhd.readthedocs.io/en/stable/generated/torchhd.MAPTensor.html)
@@ -109,8 +110,9 @@ We are always looking for people that want to contribute to the library. If you
109110
### Documentation
110111

111112
To build the documentation locally do the following:
112-
1. Use `pip install -r docs/requirements.txt` to install the required packages.
113-
2. Use `sphinx-build -b html docs build` to generate the html documentation in the `/build` directory.
113+
114+
1. Use `pip install -r docs/requirements.txt` to install the required packages.
115+
2. Use `sphinx-build -b html docs build` to generate the html documentation in the `/build` directory.
114116

115117
To create a clean build, remove the `/build` and `/docs/generated` directories.
116118

@@ -123,6 +125,7 @@ To create a clean build, remove the `/build` and `/docs/generated` directories.
123125
### Running tests
124126

125127
To run the unit tests located in [`torchhd/tests`](https://github.com/hyperdimensional-computing/torchhd/tree/main/torchhd/tests) do the following:
128+
126129
1. Use `pip install -r dev-requirements.txt` to install the required development packages.
127130
2. Then run the tests using just `pytest`.
128131

@@ -134,7 +137,6 @@ This library is [MIT licensed](https://github.com/hyperdimensional-computing/tor
134137

135138
To add the license to all source files, first install [`licenseheaders`](https://github.com/johann-petrak/licenseheaders) and then use `licenseheaders -t ./LICENSE -d ./torchhd`.
136139

137-
138140
## Cite
139141

140142
Consider citing [our paper](https://jmlr.org/papers/v24/23-0300.html) published in the Journal of Machine Learning Research (JMLR) if you use Torchhd in your work:

0 commit comments

Comments
 (0)