Add MCRTensor (#174)

* Add MCRTensor * Add MCRTensor header to doc files * Simplify the implementation of bundle
hyperdimensional-computing · Oct 8, 2024 · 54b6465 · 54b6465
1 parent 132ee17
commit 54b6465
Show file tree

Hide file tree

Showing 14 changed files with 570 additions and 110 deletions.
diff --git a/docs/torchhd.rst b/docs/torchhd.rst
@@ -87,6 +87,7 @@ VSA Models
     HRRTensor
     FHRRTensor
     BSBCTensor
+    MCRTensor
     VTBTensor
 
 

diff --git a/torchhd/__init__.py b/torchhd/__init__.py
@@ -37,6 +37,7 @@
 from torchhd.tensors.fhrr import FHRRTensor
 from torchhd.tensors.bsbc import BSBCTensor
 from torchhd.tensors.vtb import VTBTensor
+from torchhd.tensors.mcr import MCRTensor
 
 from torchhd.functional import (
     ensure_vsa_tensor,
@@ -90,6 +91,7 @@
     "FHRRTensor",
     "BSBCTensor",
     "VTBTensor",
+    "MCRTensor",
     "functional",
     "embeddings",
     "structures",

diff --git a/torchhd/functional.py b/torchhd/functional.py
@@ -35,6 +35,7 @@
 from torchhd.tensors.fhrr import FHRRTensor
 from torchhd.tensors.bsbc import BSBCTensor
 from torchhd.tensors.vtb import VTBTensor
+from torchhd.tensors.mcr import MCRTensor
 from torchhd.types import VSAOptions
 
 
@@ -90,6 +91,8 @@ def get_vsa_tensor_class(vsa: VSAOptions) -> Type[VSATensor]:
         return BSBCTensor
     elif vsa == "VTB":
         return VTBTensor
+    elif vsa == "MCR":
+        return MCRTensor
 
     raise ValueError(f"Provided VSA model is not supported, specified: {vsa}")
 
@@ -358,7 +361,7 @@ def level(
         device=span_hv.device,
     ).as_subclass(vsa_tensor)
 
-    if vsa == "BSBC":
+    if vsa == "BSBC" or vsa == "MCR":
         hv.block_size = span_hv.block_size
 
     for i in range(num_vectors):
@@ -585,7 +588,7 @@ def circular(
         device=span_hv.device,
     ).as_subclass(vsa_tensor)
 
-    if vsa == "BSBC":
+    if vsa == "BSBC" or vsa == "MCR":
         hv.block_size = span_hv.block_size
 
     mutation_history = deque()