Skip to content

Commit dacb780

Browse files
committed
Add CGRTensor to docs
Include CGRTensor in the README and in the built docs.
1 parent 7e55632 commit dacb780

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ Currently, the library supports the following HDC/VSA models:
9595
- [Holographic Reduced Representations (HRR)](https://torchhd.readthedocs.io/en/stable/generated/torchhd.HRRTensor.html)
9696
- [Fourier Holographic Reduced Representations (FHRR)](https://torchhd.readthedocs.io/en/stable/generated/torchhd.FHRRTensor.html)
9797
- [Binary Sparse Block Codes (B-SBC)](https://torchhd.readthedocs.io/en/stable/generated/torchhd.BSBCTensor.html)
98+
- [Modular Composite Representation (CGR)](https://torchhd.readthedocs.io/en/stable/generated/torchhd.CGRTensor.html)
9899
- [Modular Composite Representation (MCR)](https://torchhd.readthedocs.io/en/stable/generated/torchhd.MCRTensor.html)
99100
- [Vector-Derived Transformation Binding (VTB)](https://torchhd.readthedocs.io/en/stable/generated/torchhd.VTBTensor.html)
100101

docs/torchhd.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This module consists of the basic hypervector generation functions and operation
1010
Basis-hypervector sets
1111
----------------------------------
1212

13-
.. autosummary::
13+
.. autosummary::
1414
:toctree: generated/
1515
:template: function.rst
1616

@@ -20,7 +20,7 @@ Basis-hypervector sets
2020
level
2121
thermometer
2222
circular
23-
23+
2424

2525
Operations
2626
--------------------
@@ -51,7 +51,7 @@ Similarities
5151
.. autosummary::
5252
:toctree: generated/
5353
:template: function.rst
54-
54+
5555
cosine_similarity
5656
dot_similarity
5757
hamming_similarity
@@ -87,6 +87,7 @@ VSA Models
8787
HRRTensor
8888
FHRRTensor
8989
BSBCTensor
90+
CGRTensor
9091
MCRTensor
9192
VTBTensor
9293

@@ -97,7 +98,7 @@ Utilities
9798
.. autosummary::
9899
:toctree: generated/
99100
:template: function.rst
100-
101+
101102
ensure_vsa_tensor
102103
map_range
103104
value_to_index

0 commit comments

Comments
 (0)