hwcomponents-library 1.1.0.dev21__py3-none-any.whl

hwcomponents_library/library/wan.py

@@ -0,0 +1,288 @@
+"""
+@article{wan2022compute,
+  title={A compute-in-memory chip based on resistive random-access memory},
+  author={Wan, Weier and Kubendran, Rajkumar and Schaefer, Clemens and Eryilmaz, Sukru Burc and Zhang, Wenqiang and Wu, Dabin and Deiss, Stephen and Raina, Priyanka and Qian, He and Gao, Bin and others},
+  journal={Nature},
+  volume={608},
+  number={7923},
+  pages={504--512},
+  year={2022},
+  publisher={Nature Publishing Group UK London}
+}
+"""
+
+from hwcomponents_library.base import LibraryEstimatorClassBase
+from hwcomponents.scaling import *
+from hwcomponents import actionDynamicEnergy
+
+
+# Original CSV contents:
+# tech_node,n_repeats,global_cycle_period,resolution, voltage,energy,area,  action
+# 130nm,     1,      1e-6,                8,          1.8,    0.1,   170,  read
+# 130nm,     1,      1e-6,                8,          1.8,    0.1,   170,  write|update
+# 130nm,     1,      1e-6,                8,          1.8,    0.1,   170,  leak
+class WanShiftAdd(LibraryEstimatorClassBase):
+    """
+    The shift-and-add unit from the Wan et al. Nature 2022 paper. This unit will sum and
+    accumulate values in a register, while also shifting the register contents to accept
+    various power-of-two scaling factors for the summed values.
+
+    Parameters
+    ----------
+    tech_node: float
+        Technology node in meters.
+    n_repeats: int
+        Number of times to repeat the shift-and-add operation.
+    resolution: int
+        Resolution of the shift-and-add unit in bits. This is the number of bits of each
+        input value that is added to the register.
+    voltage: float
+        Voltage of the shift-and-add unit in volts.
+    """
+
+    component_name = "wan_shift_add"
+    priority = 0.9
+
+    def __init__(
+        self,
+        tech_node: float,
+        n_repeats: int = 1,
+        resolution: int = 8,
+        voltage: float = 1.8,
+    ):
+        super().__init__(leak_power=1.00e-7, area=170.0e-12)
+        self.tech_node: float = self.scale(
+            "tech_node",
+            tech_node,
+            130e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+        self.n_repeats: int = self.scale(
+            "n_repeats", n_repeats, 1, linear, linear, linear
+        )
+        self.resolution: int = self.scale(
+            "resolution", resolution, 8, pow_base(2), pow_base(2), pow_base(2)
+        )
+        self.voltage: float = self.scale("voltage", voltage, 1.8, noscale, quadratic, 1)
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns zero Joules.
+
+        Returns
+        -------
+        float
+            Zero Joules.
+        """
+        return 0
+
+    @actionDynamicEnergy
+    def write(self) -> float:
+        """
+        Returns the energy used to perform a shift-and-add operation in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to perform a shift-and-add operation in Joules.
+        """
+        return self.shift_and_add()
+
+    @actionDynamicEnergy
+    def shift_and_add(self) -> float:
+        """
+        Returns the energy used to perform a shift-and-add operation in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to perform a shift-and-add operation in Joules.
+        """
+        return 0.1e-12
+
+
+# Original CSV contents:
+# tech_node,n_repeats,global_cycle_period,voltage,energy,area,  action
+# 130nm,     1,      1e-6,                1.8,    0.3,  400,   read
+# 130nm,     1,      1e-6,                1.8,    0,     400,   leak
+# 130nm,     1,      1e-6,                1.8,    0,     400,   write|update
+class WanVariablePrecisionADC(LibraryEstimatorClassBase):
+    """
+    The variable precision ADC from the Wan et al. Nature 2022 paper. This unit will
+    convert a voltage to a digital value.
+
+    Parameters
+    ----------
+    tech_node: float
+        Technology node in meters.
+    n_repeats: int
+        Number of times to repeat the ADC operation.
+    voltage: float
+        Voltage of the ADC unit in volts.
+    """
+
+    component_name = "wan_variable_precision_adc"
+    priority = 0.9
+
+    def __init__(self, tech_node: float, n_repeats: int = 1, voltage: float = 1.8):
+        super().__init__(leak_power=0.0, area=400.0e-12)
+        self.tech_node: float = self.scale(
+            "tech_node",
+            tech_node,
+            130e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+        self.n_repeats: int = self.scale(
+            "n_repeats", n_repeats, 1, linear, linear, linear
+        )
+        self.voltage: float = self.scale("voltage", voltage, 1.8, noscale, quadratic, 1)
+
+    @actionDynamicEnergy
+    def convert(self) -> float:
+        """
+        Returns the energy used to convert a voltage to a digital value in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to convert a voltage to a digital value in Joules.
+        """
+        return 0.3e-12
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy used to convert a voltage to a digital value in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to convert a voltage to a digital value in Joules.
+        """
+        return self.convert()
+
+
+# Original CSV contents:
+# tech_node,global_cycle_period,voltage,energy,area,  action
+# 130nm,     1e-6,                1.8,    1.2,   350,  read
+# 130nm,     1e-6,                1.8,    0,     350,  leak
+# 130nm,     1e-6,                1.8,    0,     350,  write|update
+class WanAnalogSample(LibraryEstimatorClassBase):
+    """
+    The analog sample unit from the Wan et al. Nature 2022 paper. This unit will sample
+    an analog charge and add it to an analog integrator.
+
+    Parameters
+    ----------
+    tech_node: float
+        Technology node in meters.
+    voltage: float
+        Voltage of the analog sample unit in volts.
+    """
+
+    component_name = "wan_analog_sample"
+    priority = 0.9
+
+    def __init__(self, tech_node: float, voltage: float = 1.8):
+        super().__init__(leak_power=0.0, area=350.0e-12)
+        self.tech_node: float = self.scale(
+            "tech_node",
+            tech_node,
+            130e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+        self.voltage: float = self.scale("voltage", voltage, 1.8, noscale, quadratic, 1)
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy used to sample an analog voltage in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to sample an analog voltage in Joules.
+        """
+        return self.sample()
+
+    @actionDynamicEnergy
+    def sample(self) -> float:
+        """
+        Returns the energy used to sample an analog voltage in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to sample an analog voltage in Joules.
+        """
+        return 1.2e-12
+
+
+# Original CSV contents:
+# tech_node,n_repeats,global_cycle_period,voltage,energy,area, action
+# 130nm,     1,      1e-6,                 1.8,   0.25,  350,  read
+# 130nm,     1,      1e-6,                1.8,    0,     350,  leak
+# 130nm,     1,      1e-6,                1.8,    0,     350,  write|update
+class WanAnalogIntegrator(LibraryEstimatorClassBase):
+    """
+    The analog integrator unit from the Wan et al. Nature 2022 paper. This unit will
+    integrate charge over multiple samples.
+
+    Parameters
+    ----------
+    tech_node: float
+        Technology node in meters.
+    n_repeats: int
+        Number of times to repeat the analog integration operation.
+    voltage: float
+        Voltage of the analog integrator unit in volts.
+    """
+
+    component_name = "wan_analog_integrator"
+    priority = 0.9
+
+    def __init__(self, tech_node: float, n_repeats: int = 1, voltage: float = 1.8):
+        super().__init__(leak_power=0.0, area=350.0e-12)
+        self.tech_node: float = self.scale(
+            "tech_node",
+            tech_node,
+            130e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+        self.n_repeats: int = self.scale(
+            "n_repeats", n_repeats, 1, linear, linear, linear
+        )
+        self.voltage: float = self.scale("voltage", voltage, 1.8, noscale, quadratic, 1)
+
+    @actionDynamicEnergy
+    def integrate(self) -> float:
+        """
+        Returns the energy used to integrate charge for a sample in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to integrate charge for a sample in Joules.
+        """
+        return 0.25e-12
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy used to integrate charge for a sample in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to integrate charge for a sample in Joules.
+        """
+        return self.integrate()

hwcomponents_library-1.1.0.dev21.dist-info/METADATA

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: hwcomponents_library
+Version: 1.1.0.dev21
+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
+Requires-Dist: hwcomponents
+Requires-Dist: hwcomponents-cacti
+
+# 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.
+
+These models are for use with the HWComponents package, found at
+https://accelergy-project.github.io/hwcomponents/.
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install hwcomponents-library
+
+# 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-1.1.0.dev21.dist-info/RECORD

@@ -0,0 +1,21 @@
+hwcomponents_library/__init__.py,sha256=u6UkOPO0DVX5BOhZRFE3V3GmG1iR38G_ARRx8PziRAs,593
+hwcomponents_library/_version.py,sha256=W7W7CpPjreycTcPcYldRm4gQscL8PkctLexBsfP2ICY,719
+hwcomponents_library/_version_scheme.py,sha256=xq7gKERwEfxj6gv8HwXde0V_vnst8fCQOVNhfEQhgpU,1365
+hwcomponents_library/base.py,sha256=ZdhNGsrAt2SsUMimgbvDm01VW2XnxuNfqGRb_MZmTDs,293
+hwcomponents_library/library/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hwcomponents_library/library/aladdin.py,sha256=plhnSUJApvHKZtAwCmbBmuxmPNmzRbqFTCUmWpZkMEw,11959
+hwcomponents_library/library/atomlayer.py,sha256=SuvGowY6biqNVKXJicDmcZKsbLtTs4kT_2nRqZdbc_w,5988
+hwcomponents_library/library/brahms.py,sha256=wdGmmJ0y-jOyk9ZUdVJqNJMWcXDuCWXTLfbg_ZHURIA,2585
+hwcomponents_library/library/dummy.py,sha256=FZS9fC3jyY0EQZcy9bB_gpXR98UWtQyyGX3G4-2pOSs,4428
+hwcomponents_library/library/forms.py,sha256=HFB4ssLPtkzUF7Pv_qasI6wTXXdx2Nrf1YOvwOf0OsU,2389
+hwcomponents_library/library/isaac.py,sha256=1NGZQ9S-qjWWCfUv-lkGZrLB9K2JRJ2eiIyE5JDYEtc,18594
+hwcomponents_library/library/jia.py,sha256=J2wAqJY6nPHesuQQfj4sezNu6pw-pIOaJJ3at6Hfa3M,7154
+hwcomponents_library/library/misc.py,sha256=qxsVPLLSls0pN3VU5rUdDvr4DQmQVrD6rBhobj3BR44,6658
+hwcomponents_library/library/newton.py,sha256=n4qtEPw_SZ0vy8G1FGB3GV_qXuVrAQRmXYpqIYBHMWw,3321
+hwcomponents_library/library/raella.py,sha256=LYQHKdKHOUXI1C6fWndPnGUfQtyXnU0hvnh9nO9slKY,4188
+hwcomponents_library/library/timely.py,sha256=3-jwuZ7Bl8kMa2-3naPOTvZ4R3bcBZk9-LtaaKcRG4I,12123
+hwcomponents_library/library/wan.py,sha256=xFVqN0L7NI6001__IgZeL_1lCnQL-FLimZ7W9DJPpnU,8981
+hwcomponents_library-1.1.0.dev21.dist-info/METADATA,sha256=8iopf0zDWzaZEoQcmpo5SfKrWvaQd-6WMBgFGaRYgVU,1944
+hwcomponents_library-1.1.0.dev21.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+hwcomponents_library-1.1.0.dev21.dist-info/top_level.txt,sha256=FtRd1D0A21SWFGssHxfLzv4-ZGWqcBRlWn6S9c6fCYM,21
+hwcomponents_library-1.1.0.dev21.dist-info/RECORD,,

hwcomponents_library-1.1.0.dev21.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

hwcomponents_library-1.1.0.dev21.dist-info/top_level.txt

@@ -0,0 +1 @@
+hwcomponents_library