hwcomponents-library 0.1__tar.gz

hwcomponents_library-0.1/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: hwcomponents_library
+Version: 0.1
+Summary: A library of hardware components for energy estimation.
+Author-email: Tanner Andrulis <Andrulis@Mit.edu>
+License-Expression: MIT
+Keywords: hardware,components,energy,estimation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# HWComponents-Library
+HWComponents-Library contains a library of components from published works. It is
+intended to be used to rapidly model prior works and to provide a common set of
+components for comparison.
+
+## Installation
+Clone the repository and install with pip:
+```bash
+git clone https://github.com/Accelergy-Project/hwcomponents-library.git
+cd hwcomponents-library
+pip3 install .
+
+# Check that the installation is successful
+hwc --list | grep adder
+```
+
+## Contributing: Adding or Updating Numbers from Your Work 
+We would be happy to update these models given a pull request. Please see
+"Creating Library Entries" and format your entries to match the existing
+entries. If you have any questions, we would be happy to help.
+
+Note that we will only accept entries that are published or backed by public
+data. Citations are required for all entries.
+
+## Citation
+
+If you use this library in your work, please cite the following:
+
+```bibtex
+@misc{andrulis2024modelinganalogdigitalconverterenergyarea,
+      title={Modeling Analog-Digital-Converter Energy and Area for Compute-In-Memory Accelerator Design}, 
+      author={Tanner Andrulis and Ruicong Chen and Hae-Seung Lee and Joel S. Emer and Vivienne Sze},
+      year={2024},
+      eprint={2404.06553},
+      archivePrefix={arXiv},
+      primaryClass={cs.AR},
+      url={https://arxiv.org/abs/2404.06553}, 
+}
+```

hwcomponents_library-0.1/README.md

@@ -0,0 +1,39 @@
+# HWComponents-Library
+HWComponents-Library contains a library of components from published works. It is
+intended to be used to rapidly model prior works and to provide a common set of
+components for comparison.
+
+## Installation
+Clone the repository and install with pip:
+```bash
+git clone https://github.com/Accelergy-Project/hwcomponents-library.git
+cd hwcomponents-library
+pip3 install .
+
+# Check that the installation is successful
+hwc --list | grep adder
+```
+
+## Contributing: Adding or Updating Numbers from Your Work 
+We would be happy to update these models given a pull request. Please see
+"Creating Library Entries" and format your entries to match the existing
+entries. If you have any questions, we would be happy to help.
+
+Note that we will only accept entries that are published or backed by public
+data. Citations are required for all entries.
+
+## Citation
+
+If you use this library in your work, please cite the following:
+
+```bibtex
+@misc{andrulis2024modelinganalogdigitalconverterenergyarea,
+      title={Modeling Analog-Digital-Converter Energy and Area for Compute-In-Memory Accelerator Design}, 
+      author={Tanner Andrulis and Ruicong Chen and Hae-Seung Lee and Joel S. Emer and Vivienne Sze},
+      year={2024},
+      eprint={2404.06553},
+      archivePrefix={arXiv},
+      primaryClass={cs.AR},
+      url={https://arxiv.org/abs/2404.06553}, 
+}
+```

hwcomponents_library-0.1/hwcomponents_library/__init__.py

@@ -0,0 +1,12 @@
+from hwcomponents_library.library.aladdin import *
+from hwcomponents_library.library.atomlayer import *
+from hwcomponents_library.library.brahms import *
+from hwcomponents_library.library.dummy import *
+from hwcomponents_library.library.forms import *
+from hwcomponents_library.library.isaac import *
+from hwcomponents_library.library.jia import *
+from hwcomponents_library.library.misc import *
+from hwcomponents_library.library.newton import *
+from hwcomponents_library.library.raella import *
+from hwcomponents_library.library.timely import *
+from hwcomponents_library.library.wan import *

hwcomponents_library-0.1/hwcomponents_library/base.py

@@ -0,0 +1,12 @@
+from hwcomponents import EnergyAreaModel, actionDynamicEnergy
+from hwcomponents.scaling import *
+
+
+class LibraryEstimatorClassBase(EnergyAreaModel):
+    @actionDynamicEnergy
+    def write(self) -> float:
+        return 0
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        return 0

hwcomponents_library-0.1/hwcomponents_library/library/aladdin.py

@@ -0,0 +1,409 @@
+"""
+@INPROCEEDINGS{6853196,
+  author={Shao, Yakun Sophia and Reagen, Brandon and Wei, Gu-Yeon and Brooks, David},
+  booktitle={2014 ACM/IEEE 41st International Symposium on Computer Architecture (ISCA)},
+  title={Aladdin: A pre-RTL, power-performance accelerator simulator enabling large design space exploration of customized architectures},
+  year={2014},
+  volume={},
+  number={},
+  pages={97-108},
+  doi={10.1109/ISCA.2014.6853196}}
+"""
+
+from hwcomponents_library.base import LibraryEstimatorClassBase
+from hwcomponents.scaling import *
+from hwcomponents import actionDynamicEnergy
+
+
+# Original CSV contents:
+# tech_node,global_cycle_period,width|datawidth,energy,area,action
+# 40nm,1e-9,32,0.21,2.78E+02,add|read
+# 40nm,1e-9,32,0.0024,2.78E+02,leak
+# 40nm,1e-9,32,0,2.78E+02,update|write
+class AladdinAdder(LibraryEstimatorClassBase):
+    """
+    An adder from the Aladdin paper. Adds two values.
+
+    Parameters
+    ----------
+    tech_node : str
+        The technology node in meters.
+    width : int, optional
+        The width of the adder in bits. This is the number of bits of the input values.
+
+    Attributes
+    ----------
+    tech_node : str
+        The technology node in meters.
+    width : int
+        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(
+            "tech_node",
+            tech_node,
+            40e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+        self.width: int = self.scale("width", width, 32, linear, linear, linear)
+
+    @actionDynamicEnergy
+    def add(self) -> float:
+        """
+        Returns the energy for one addition operation in Joules.
+
+        Returns
+        -------
+        float
+            The energy for one addition operation in Joules.
+        """
+        return 0.21e-12
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy for one addition operation in Joules.
+
+        Returns
+        -------
+        float
+            The energy for one addition operation in Joules.
+        """
+        return 0.21e-12
+
+
+# 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
+# 40nm,1e-9,1,0,5.98E+00,write
+# 40nm,1e-9,1,0,5.98E+00,leak|update
+class AladdinRegister(LibraryEstimatorClassBase):
+    """
+    A register from the Aladdin paper. Stores a value.
+
+    Parameters
+    ----------
+    tech_node : str
+        The technology node in meters.
+    width : int, optional
+        The width of the register in bits.
+    """
+    component_name = ["register", "aladdin_register"]
+    priority = 0.9
+
+    def __init__(
+        self,
+        tech_node: float,
+        width: int = 1,
+        dynamic_energy: int = 1,
+        area: int = 5.98e00,
+    ):
+        super().__init__(leak_power=0.0, area=5.98e-12)
+        self.tech_node: float = self.scale(
+            "tech_node",
+            tech_node,
+            40e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+        self.width: int = self.scale("width", width, 1, linear, linear, linear)
+        self.dynamic_energy: int = self.scale(
+            "dynamic_energy", dynamic_energy, 1, linear, linear, linear
+        )
+
+    @actionDynamicEnergy(bits_per_action="width")
+    def read(self) -> float:
+        """
+        Returns the energy for one read operation in Joules.
+
+        Parameters
+        ----------
+        bits_per_action : int
+            The number of bits that are read.
+
+        Returns
+        -------
+        float
+            The energy for one read operation in Joules.
+        """
+        return 0.009e-12
+
+    @actionDynamicEnergy(bits_per_action="width")
+    def write(self) -> float:
+        """
+        Returns the energy for one write operation in Joules.
+
+        Parameters
+        ----------
+        bits_per_action : int
+            The number of bits that are written.
+
+        Returns
+        -------
+        float
+            The energy for one write operation in Joules.
+        """
+        return 0.009e-12
+
+
+# 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
+# 40nm,1e-9,32,2.51E-05,71,leak
+# 40nm,1e-9,32,0,71,update|write
+class AladdinComparator(LibraryEstimatorClassBase):
+    """
+    A comparator from the Aladdin paper. Tells whether one value is greater than
+    another.
+
+    Parameters
+    ----------
+    tech_node : str
+        The technology node in meters.
+    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)
+        self.tech_node: float = self.scale(
+            "tech_node",
+            tech_node,
+            40e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+        self.width: int = self.scale("width", width, 32, linear, linear, linear)
+
+    @actionDynamicEnergy
+    def compare(self) -> float:
+        """
+        Returns the energy for one comparison operation in Joules.
+
+        Returns
+        -------
+        float
+            The energy for one comparison operation in Joules.
+        """
+        return 0.02947e-12
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy for one comparison operation in Joules.
+
+        Returns
+        -------
+        float
+            The energy for one comparison operation in Joules.
+        """
+        return 0.02947e-12
+
+
+# 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
+# 40nm,1e-9,32,32,32,0.08,6350,leak
+# 40nm,1e-9,32,32,32,0,6350,update|write
+class AladdinMultiplier(LibraryEstimatorClassBase):
+    """
+    A integer multiplier from the Aladdin paper. Multiplies two values.
+
+    Parameters
+    ----------
+    tech_node : str
+        The technology node in meters.
+    width : int, optional
+        The width of the multiplier in bits. Can not be set if width_a and width_b are
+        set.
+    width_a : int, optional
+        The width of the first input value in bits.
+    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,
+        tech_node: float,
+        width: int = 32,
+        width_a: int = 32,
+        width_b: int = 32,
+        energy: int = 12.68,
+        area: int = 6350,
+    ):
+        super().__init__(leak_power=8.00e-5, area=6350.0e-12)
+        self.tech_node: float = self.scale(
+            "tech_node",
+            tech_node,
+            40e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+        if width_a != 32 and width != 32:
+            raise ValueError(
+                "width and width_a cannot both be set. Either set width of both inputs "
+                "or width_a and width_b separately."
+            )
+        if width != 32 and width_b != 32:
+            raise ValueError(
+                "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_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)
+
+    @actionDynamicEnergy
+    def multiply(self) -> float:
+        """
+        Returns the energy for one multiplication operation in Joules.
+
+        Returns
+        -------
+        float
+            The energy for one multiplication operation in Joules.
+        """
+        return 12.68e-12
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy for one read operation in Joules.
+
+        Returns
+        -------
+        float
+            The energy for one read operation in Joules.
+        """
+        return 12.68e-12
+
+
+# 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
+# 40nm,1e-9,32,0.0003213,495.5,leak
+# 40nm,1e-9,32,0,495.5,update|write
+class AladdinCounter(LibraryEstimatorClassBase):
+    """
+    A counter from the Aladdin paper. Increments a stored value.
+
+    Parameters
+    ----------
+    tech_node : str
+        The technology node in meters.
+    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)
+        self.tech_node: float = self.scale(
+            "tech_node",
+            tech_node,
+            40e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+        self.width: int = self.scale("width", width, 32, linear, linear, linear)
+
+    @actionDynamicEnergy
+    def count(self) -> float:
+        """
+        Returns the energy for one increment operation in Joules.
+
+        Returns
+        -------
+        float
+            The energy for one increment operation in Joules.
+        """
+        return 0.25074e-12
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy for one increment operation in Joules.
+
+        Returns
+        -------
+        float
+            The energy for one increment operation in Joules.
+        """
+        return 0.25074e-12
+
+class AladdinIntMAC(LibraryEstimatorClassBase):
+    """
+    A integer multiply-accumulate unit from the Aladdin paper. Multiplies two values
+    and adds the result to a stored value.
+
+    Parameters
+    ----------
+    tech_node : str
+        The technology node in meters.
+    adder_width : int, optional
+        The width of the adder in bits.
+    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):
+        self.adder = AladdinAdder(tech_node, adder_width)
+        self.multiplier = AladdinMultiplier(tech_node, multiplier_width)
+        super().__init__(
+            area=self.adder.area + self.multiplier.area,
+            leak_power=self.adder.leak_power + self.multiplier.leak_power,
+        )
+
+    @actionDynamicEnergy
+    def mac(self) -> float:
+        """
+        Returns the energy for one multiply-accumulate operation in Joules.
+
+        Returns
+        -------
+        float
+            The energy for one multiply-accumulate operation in Joules.
+        """
+        return self.adder.add() + self.multiplier.multiply()
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy for one multiply-accumulate operation in Joules.
+
+        Returns
+        -------
+        float
+            The energy for one multiply-accumulate operation in Joules.
+        """
+        return self.mac()
+
+    @actionDynamicEnergy
+    def compute(self) -> float:
+        """
+        Returns the energy for one multiply-accumulate operation in Joules.
+
+        Returns
+        -------
+        float
+            The energy for one multiply-accumulate operation in Joules.
+        """
+        return self.mac()