Update component naming

Author: tanner-andrulis

hwcomponents_library/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '1.0.29'
+__version_tuple__ = version_tuple = (1, 0, 29)
+
+__commit_id__ = commit_id = 'gbe4a7373c'

hwcomponents_library/base.py

@@ -3,6 +3,8 @@
 
 
 class LibraryEstimatorClassBase(EnergyAreaModel):
+    priority: float = 0.8
+
     @actionDynamicEnergy
     def write(self) -> float:
         return 0

hwcomponents_library/library/aladdin.py

@@ -39,9 +39,6 @@ class AladdinAdder(LibraryEstimatorClassBase):
         The width of the adder in bits. This is the number of bits of the input values.
     """
 
-    component_name = ["adder", "intadder", "aladdin_adder"]
-    priority = 0.9
-
     def __init__(self, tech_node: float, width: int = 32):
         super().__init__(leak_power=2.40e-6, area=278.0e-12)
         self.tech_node: float = self.scale(
@@ -79,6 +76,14 @@ def read(self) -> float:
         return 0.21e-12
 
 
+class Adder(AladdinAdder):
+    pass
+
+
+class IntAdder(AladdinAdder):
+    pass
+
+
 # Original CSV contents:
 # tech_node,global_cycle_period,width|datawidth,dynamic energy(pJ),area(um^2),action
 # 40nm,1e-9,1,0.009,5.98E+00,read
@@ -95,8 +100,6 @@ class AladdinRegister(LibraryEstimatorClassBase):
     width : int, optional
         The width of the register in bits.
     """
-    component_name = ["register", "aladdin_register"]
-    priority = 0.9
 
     def __init__(
         self,
@@ -154,6 +157,10 @@ def write(self) -> float:
         return 0.009e-12
 
 
+class Register(AladdinRegister):
+    pass
+
+
 # Original CSV contents:
 # tech_node,global_cycle_period,width|datawidth,energy(pJ),area(um^2),action
 # 40nm,1e-9,32,0.02947,71,compare|read
@@ -171,8 +178,6 @@ class AladdinComparator(LibraryEstimatorClassBase):
     width : int, optional
         The width of the comparator in bits.
     """
-    component_name = ["comparator", "aladdin_comparator"]
-    priority = 0.9
 
     def __init__(self, tech_node: float, width: int = 32):
         super().__init__(leak_power=2.51e-8, area=71.0e-12)
@@ -211,6 +216,10 @@ def read(self) -> float:
         return 0.02947e-12
 
 
+class Comparator(AladdinComparator):
+    pass
+
+
 # Original CSV contents:
 # tech_node,global_cycle_period,width|datawidth,width_a|datawidth_a,width_b|datawidth_b,energy(pJ),area(um^2),action
 # 40nm,1e-9,32,32,32,12.68,6350,multiply|read
@@ -232,8 +241,6 @@ class AladdinMultiplier(LibraryEstimatorClassBase):
     width_b : int, optional
         The width of the second input value in bits.
     """
-    component_name = ["intmultiplier", "multiplier", "aladdin_multiplier"]
-    priority = 0.9
 
     def __init__(
         self,
@@ -263,7 +270,9 @@ def __init__(
                 "width and width_b cannot both be set. Either set width of both inputs "
                 "or width_a and width_b separately."
             )
-        self.width: int = self.scale("width", width, 32, quadratic, quadratic, quadratic)
+        self.width: int = self.scale(
+            "width", width, 32, quadratic, quadratic, quadratic
+        )
         self.width_a: int = self.scale("width_a", width_a, 32, linear, linear, linear)
         self.width_b: int = self.scale("width_b", width_b, 32, linear, linear, linear)
 
@@ -292,6 +301,14 @@ def read(self) -> float:
         return 12.68e-12
 
 
+class IntMultiplier(AladdinMultiplier):
+    pass
+
+
+class Multiplier(AladdinMultiplier):
+    pass
+
+
 # Original CSV contents:
 # tech_node,global_cycle_period,width|datawidth,energy(pJ),area(um^2),action
 # 40nm,1e-9,32,0.25074,495.5,count|read
@@ -308,8 +325,6 @@ class AladdinCounter(LibraryEstimatorClassBase):
     width : int, optional
         The width of the counter in bits.
     """
-    component_name = ["counter", "aladdin_counter"]
-    priority = 0.9
 
     def __init__(self, tech_node: float, width: int = 32):
         super().__init__(leak_power=3.21e-7, area=495.5e-12)
@@ -347,6 +362,11 @@ def read(self) -> float:
         """
         return 0.25074e-12
 
+
+class Counter(AladdinCounter):
+    pass
+
+
 class AladdinIntMAC(LibraryEstimatorClassBase):
     """
     A integer multiply-accumulate unit from the Aladdin paper. Multiplies two values
@@ -361,10 +381,12 @@ class AladdinIntMAC(LibraryEstimatorClassBase):
     multiplier_width : int, optional
         The width of the multiplier in bits.
     """
+
     component_name = ["intmac", "aladdin_intmac"]
-    priority = 0.9
 
-    def __init__(self, tech_node: float, adder_width: int = 16, multiplier_width: int = 8):
+    def __init__(
+        self, tech_node: float, adder_width: int = 16, multiplier_width: int = 8
+    ):
         self.adder = AladdinAdder(tech_node, adder_width)
         self.multiplier = AladdinMultiplier(tech_node, multiplier_width)
         super().__init__(

hwcomponents_library/library/atomlayer.py

@@ -45,9 +45,6 @@ class AtomlayerRegisterLadder(LibraryEstimatorClassBase):
         = width * depth.
     """
 
-    component_name = "atomlayer_register_ladder"
-    priority = 0.9
-
     def __init__(self, tech_node: float, width: int = 16, depth: int = 128):
         super().__init__(leak_power=0.0, area=1620.0e-12)
         self.tech_node: float = self.scale(
@@ -127,9 +124,6 @@ class AtomlayerInputBufferTransfers(LibraryEstimatorClassBase):
         width * depth.
     """
 
-    component_name = "atomlayer_input_buffer_transfers"
-    priority = 0.9
-
     def __init__(self, tech_node: float, width: int = 16, depth: int = 128):
         super().__init__(leak_power=0.0, area=2100.0e-12)
         self.tech_node: float = self.scale(

hwcomponents_library/library/brahms.py

@@ -42,9 +42,6 @@ class BrahmsDAC(LibraryEstimatorClassBase):
         Resolution of the DAC in bits
     """
 
-    component_name = "brahms_dac"
-    priority = 0.9
-
     def __init__(self, tech_node: float, resolution: int = 8):
         super().__init__(leak_power=0.0, area=438.0e-12)
         self.tech_node: float = self.scale(
@@ -71,7 +68,6 @@ def read(self) -> float:
         """
         return 0.291e-12
 
-
     @actionDynamicEnergy
     def convert(self) -> float:
         """

hwcomponents_library/library/dummy.py

@@ -15,8 +15,6 @@ class DummyStorage(LibraryEstimatorClassBase):
     tech_node: float, optional
         Technology node in meters. This is not used.
     """
-    component_name = "dummy_storage"
-    priority = 0.9
 
     def __init__(self, tech_node: float | None = None):
         super().__init__(leak_power=0.0, area=0.0)
@@ -59,8 +57,6 @@ class DummyCompute(LibraryEstimatorClassBase):
     tech_node: float, optional
         Technology node in meters. This is not used.
     """
-    component_name = "dummy_compute"
-    priority = 0.9
 
     def __init__(self, tech_node: float | None = None):
         super().__init__(leak_power=0.0, area=0.0)
@@ -100,8 +96,6 @@ class DummyMemory(LibraryEstimatorClassBase):
     tech_node: float
         Technology node in meters. This is not used.
     """
-    component_name = "dummy_memory"
-    priority = 0.9
 
     def __init__(self, tech_node: float | None = None):
         super().__init__(leak_power=0.0, area=0.0)
@@ -131,6 +125,7 @@ def write(self) -> float:
         """
         return 0.0
 
+
 class DummyNetwork(LibraryEstimatorClassBase):
     """
     A dummy network component. Has zero area, zero energy, and zero leakage power.
@@ -140,8 +135,6 @@ class DummyNetwork(LibraryEstimatorClassBase):
     tech_node: float
         Technology node in meters. This is not used.
     """
-    component_name = "dummy_network"
-    priority = 0.9
 
     def __init__(self, tech_node: float | None = None):
         super().__init__(leak_power=0.0, area=0.0)

hwcomponents_library/library/forms.py

@@ -34,8 +34,6 @@ class FormsADC(LibraryEstimatorClassBase):
     resolution: int
         Resolution of the ADC in bits.
     """
-    component_name = "forms_adc"
-    priority = 0.9
 
     def __init__(self, tech_node: float, resolution: int = 4):
         super().__init__(leak_power=0.0, area=284.375e-12)

hwcomponents_library/library/isaac.py

@@ -39,8 +39,6 @@ class IsaacEDRAM(LibraryEstimatorClassBase):
         Depth of the eDRAM in bits. This is the number of entries in the eDRAM, each
         with `width` bits. Total size = width * depth.
     """
-    component_name = "isaac_eDRAM"
-    priority = 0.9
 
     def __init__(self, tech_node: float, width: int = 256, depth: int = 2048):
         super().__init__(leak_power=0.0, area=83000.0e-12)
@@ -97,8 +95,6 @@ class IsaacChip2ChipLink(LibraryEstimatorClassBase):
     width: int
         Width of the link in bits. This is the width of a read/write port.
     """
-    component_name = "isaac_chip2chip_link"
-    priority = 0.9
 
     def __init__(self, tech_node: float, width: int = 128):
         super().__init__(leak_power=0.0, area=23000000.0e-12)
@@ -155,9 +151,6 @@ class IsaacRouterSharedByFour(LibraryEstimatorClassBase):
     so this area is divided by four to match the paper.
     """
 
-    component_name = "isaac_router_shared_by_four"
-    priority = 0.9
-
     def __init__(self, tech_node: float, width: int = 256):
         super().__init__(leak_power=0.0, area=37500.0e-12)
         self.tech_node: float = self.scale(
@@ -255,8 +248,6 @@ class IsaacADC(LibraryEstimatorClassBase):
     resolution: int
         Resolution of the ADC in bits.
     """
-    component_name = "isaac_adc"
-    priority = 0.9
 
     def __init__(self, tech_node: float, resolution: int = 8):
         super().__init__(leak_power=0.0, area=1200.0e-12)
@@ -321,8 +312,6 @@ class IsaacRouter(LibraryEstimatorClassBase):
     width: int
         Width of the router in bits. This is the width of a read/write port.
     """
-    component_name = "isaac_router"
-    priority = 0.9
 
     def __init__(self, tech_node: float, width: int = 256):
         super().__init__(leak_power=0.0, area=150000.0e-12)
@@ -360,7 +349,6 @@ def write(self) -> float:
         """
         return 0
 
-
     @actionDynamicEnergy(bits_per_action="width")
     def transfer(self) -> float:
         """
@@ -398,8 +386,6 @@ class IsaacShiftAdd(LibraryEstimatorClassBase):
         Width of the shift-and-add unit in bits. This is the number of bits of each
         input value that is added to the register.
     """
-    component_name = "isaac_shift_add"
-    priority = 0.9
 
     def __init__(self, tech_node: float, width: int = 16):
         super().__init__(leak_power=0.0, area=60.0e-12)
@@ -473,8 +459,6 @@ class IsaacEDRAMBus(LibraryEstimatorClassBase):
     width: int
         Width of the eDRAM bus in bits. This is the width of a read/write port.
     """
-    component_name = "isaac_eDRAM_bus"
-    priority = 0.9
 
     def __init__(self, tech_node: float, width: int = 1):
         super().__init__(leak_power=0.0, area=29.296875e-12)
@@ -559,8 +543,6 @@ class IsaacDAC(LibraryEstimatorClassBase):
     resolution: int
         Resolution of the DAC in bits.
     """
-    component_name = "isaac_dac"
-    priority = 0.9
 
     def __init__(self, tech_node: float, resolution: int = 1, rows: int = 1):
         super().__init__(leak_power=0.0, area=0.166015625e-12)

hwcomponents_library/library/jia.py

@@ -37,9 +37,6 @@ class JiaShiftAdd(LibraryEstimatorClassBase):
         Voltage of the shift-and-add unit in volts.
     """
 
-    component_name = "jia_shift_add"
-    priority = 0.9
-
     def __init__(self, tech_node: float, resolution: int = 8, voltage: float = 1.2):
         super().__init__(leak_power=2.22e-6, area=5000.0e-12)
         self.tech_node: float = self.scale(
@@ -116,9 +113,6 @@ class JiaZeroGate(LibraryEstimatorClassBase):
         Voltage of the zero gating unit in volts.
     """
 
-    component_name = "jia_zero_gate"
-    priority = 0.9
-
     def __init__(
         self, tech_node: float, rows: int = 1, resolution: int = 8, voltage: float = 1.2
     ):
@@ -190,9 +184,6 @@ class JiaDatapath(LibraryEstimatorClassBase):
 
     """
 
-    component_name = "jia_datapath"
-    priority = 0.9
-
     def __init__(self, tech_node: float, voltage: float = 1.2):
         super().__init__(leak_power=4.44e-6, area=10535.0e-12)
         self.tech_node: float = self.scale(