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

hwcomponents_library/library/atomlayer.py

@@ -0,0 +1,204 @@
+"""
+@INPROCEEDINGS{8465832,
+  author={Qiao, Ximing and Cao, Xiong and Yang, Huanrui and Song, Linghao and Li, Hai},
+  booktitle={2018 55th ACM/ESDA/IEEE Design Automation Conference (DAC)},
+  title={AtomLayer: A Universal ReRAM-Based CNN Accelerator with Atomic Layer Computation},
+  year={2018},
+  volume={},
+  number={},
+  pages={1-6},
+  doi={10.1109/DAC.2018.8465832}}
+"""
+
+from hwcomponents_library.base import LibraryEstimatorClassBase
+from hwcomponents.scaling import *
+from hwcomponents import actionDynamicEnergy
+from .isaac import IsaacADC
+from .isaac import IsaacDAC
+from .isaac import IsaacEDRAM
+from .isaac import IsaacEDRAMBus
+from .isaac import IsaacRouter
+from .isaac import IsaacShiftAdd
+
+
+# Original CSV contents:
+# tech_node,global_cycle_period,width|datawidth,depth,energy,area,action
+# 32nm,1e-9,16,128,0.083,1620,read|write,energy in pJ;  area in um^2;
+# 32nm,1e-9,16,128,0,1620,update|leak
+# # 1 read, 1 write per DAC activation
+# # Reported power = 0.39 / 4 x DAC
+# # 0.166015625 / 2 = 0.083
+class AtomlayerRegisterLadder(LibraryEstimatorClassBase):
+    """
+    A register ladder from the AtomLayer paper. Is a series of registers that shift
+    stored values along themselves.
+
+    Parameters
+    ----------
+    tech_node : str
+        The technology node in meters.
+    width : int, optional
+        The width of the register ladder in bits. This is the bits in each register.
+        Total size = width * depth.
+    depth : int, optional
+        The number of entries in the register ladder, each with `width` bits. Total size
+        = 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(
+            "tech_node",
+            tech_node,
+            32e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+        self.width: int = self.scale("width", width, 16, linear, linear, linear)
+        self.depth: int = self.scale(
+            "depth", depth, 128, linear, cacti_depth_energy, cacti_depth_energy
+        )
+
+    @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.083e-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.083e-12
+
+
+# Original CSV contents:
+# tech_node,global_cycle_period,width|datawidth,depth,energy,area,action
+# 32nm,1e-9,16,128,6.46,2100,read, energy in pJ;  area in um^2;
+# 32nm,1e-9,16,128,0,2100,write|update|leak
+# # Power calculation for input buffers:
+# # Power * Time / (Reads+Writes) = Energy per read/write
+# # (1.24e-3 W) power * (16 * 100e-9s time/MAC / 1.2) / (128+128 reads+writes)
+# # (1.24e-3) * (16 * 100e-9 / 1.2) / (128+128) * 1e12
+# # Now for the transfers calculation, we also mark write energy = 0 so we don't
+# # double charge for writes with the actual buffers. Only charge for reads when
+# # another
+# # buffer reads from the inter-buffer transfer network.
+class AtomlayerInputBufferTransfers(LibraryEstimatorClassBase):
+    """
+    This component measures transfer energy between input buffers in the AtomLayer
+    paper.
+
+    Parameters
+    ----------
+    tech_node : str
+        The technology node in meters.
+    width : int, optional
+        The width of the read/write port of each input buffer in bits. Total size =
+        width * depth.
+    depth : int, optional
+        The number of entries in each input buffer, each with `width` bits. Total size =
+        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(
+            "tech_node",
+            tech_node,
+            32e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+        self.width: int = self.scale("width", width, 16, linear, linear, linear)
+        self.depth: int = self.scale(
+            "depth", depth, 128, linear, cacti_depth_energy, cacti_depth_energy
+        )
+
+    @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 transferred.
+
+        Returns
+        -------
+        float
+            The energy for one transfer operation in Joules.
+        """
+        return 6.46e-12
+
+    @actionDynamicEnergy(bits_per_action="width")
+    def transfer(self) -> float:
+        """
+        Returns the energy for one transfer operation in Joules.
+
+        Parameters
+        ----------
+        bits_per_action : int
+            The number of bits that are transferred.
+
+        Returns
+        -------
+        float
+            The energy for one transfer operation in Joules.
+        """
+        return 6.46e-12
+
+
+class AtomlayerADC(IsaacADC):
+    pass
+
+
+class AtomlayerDAC(IsaacDAC):
+    pass
+
+
+class AtomlayerRouter(IsaacRouter):
+    pass
+
+
+class AtomlayerEDRAM(IsaacEDRAM):
+    pass
+
+
+class AtomlayerEDRAMBus(IsaacEDRAMBus):
+    pass
+
+
+class AtomlayerShiftAdd(IsaacShiftAdd):
+    pass

hwcomponents_library/library/brahms.py

@@ -0,0 +1,85 @@
+"""
+@INPROCEEDINGS{9586247,
+  author={Song, Tao and Chen, Xiaoming and Zhang, Xiaoyu and Han, Yinhe},
+  booktitle={2021 58th ACM/IEEE Design Automation Conference (DAC)},
+  title={BRAHMS: Beyond Conventional RRAM-based Neural Network Accelerators Using Hybrid Analog Memory System},
+  year={2021},
+  volume={},
+  number={},
+  pages={1033-1038},
+  doi={10.1109/DAC18074.2021.9586247}}
+"""
+
+from hwcomponents_library.base import LibraryEstimatorClassBase
+from hwcomponents.scaling import *
+from hwcomponents import actionDynamicEnergy
+
+
+# Original CSV contents:
+# tech_node,global_cycle_period,resolution,energy,area,action
+# 40nm,1e-9,8,0.291,438,read|convert
+# 40nm,1e-9,8,0,438,update|write|leak
+# # H. Chen,X. Zhot,F. Zhang and Q. Li,"A >3GHz ERBW 1.1GS/S 8B Two-Sten SAR ADC
+# # with,Q. Yu Recursive-Weight DAC," 2018 IEEE Symposium on VLSI Circuits,pp.
+# # 97-98,2018 doi: 10.1109/VLSIC.2018.8502370.
+# # Reported energy: 0.32mW @ 1.1GHz
+# # SAR ADC, so the DAC does 1 8b convert for every convert
+# # E/op: .32e-3 W * 1 / 1.1e9 seconds * 1e12pJ/J =
+# # .32e-3 / 1.1e9 * 1e12 = 0.291pJ/convert
+# # Area from chip picture:
+# # (Picture was scaled when I screencapped it)
+# # 1629px * 743px / (2805px * 1625px) * 75e-6m * 22e-6m
+# # = 1629 * 743 / (2805 * 1625) * 75 * 22 = 438um^2
+class BrahmsDAC(LibraryEstimatorClassBase):
+    """
+    Digital-analog converter (DAC) from the BRAHMS paper
+
+    Parameters
+    ----------
+    tech_node: float
+        Technology node in meters
+    resolution: int
+        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(
+            "tech_node",
+            tech_node,
+            40e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+        self.resolution: int = self.scale(
+            "resolution", resolution, 8, pow_base(2), pow_base(2), pow_base(2)
+        )
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy of one DAC conversion in Joules
+
+        Returns
+        -------
+        float
+            Energy of one DAC conversion in Joules
+        """
+        return 0.291e-12
+
+
+    @actionDynamicEnergy
+    def convert(self) -> float:
+        """
+        Returns the energy of one DAC conversion in Joules
+
+        Returns
+        -------
+        float
+            Energy of one DAC conversion in Joules
+        """
+        return 0.291e-12

hwcomponents_library/library/dummy.py

@@ -0,0 +1,172 @@
+from hwcomponents_library.base import LibraryEstimatorClassBase
+from hwcomponents.scaling import *
+from hwcomponents import actionDynamicEnergy
+
+
+# Original CSV contents:
+# global_cycle_period,energy,area,n_instances,action
+# 1e-9,0,0,1,read|update|leak|write|*
+class DummyStorage(LibraryEstimatorClassBase):
+    """
+    A dummy storage component. Has zero area, zero energy, and zero leakage power.
+
+    Parameters
+    ----------
+    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)
+        self.tech_node: float = tech_node
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy of one read operation in Joules. Energy is zero.
+
+        Returns
+        -------
+        float
+            Energy of one read operation in Joules
+        """
+        return 0.0
+
+    @actionDynamicEnergy
+    def write(self) -> float:
+        """
+        Returns the energy of one write operation in Joules. Energy is zero.
+
+        Returns
+        -------
+        float
+            Energy of one write operation in Joules
+        """
+        return 0.0
+
+
+# Original CSV contents:
+# global_cycle_period,energy,area,n_instances,action
+# 1e-9,0,0,1,read|update|leak|write|*
+class DummyCompute(LibraryEstimatorClassBase):
+    """
+    A dummy compute component. Has zero area, zero energy, and zero leakage power.
+
+    Parameters
+    ----------
+    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)
+        self.tech_node: float = tech_node
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy of one compute operation in Joules. Energy is zero.
+
+        Returns
+        -------
+        float
+            Energy of one compute operation in Joules
+        """
+        return 0.0
+
+    @actionDynamicEnergy
+    def compute(self) -> float:
+        """
+        Returns the energy of one compute operation in Joules. Energy is zero.
+
+        Returns
+        -------
+        float
+            Energy of one compute operation in Joules
+        """
+        return 0.0
+
+
+class DummyMemory(LibraryEstimatorClassBase):
+    """
+    A dummy memory component. Has zero area, zero energy, and zero leakage power.
+
+    Parameters
+    ----------
+    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)
+        self.tech_node: float = tech_node
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy of one read operation in Joules. Energy is zero.
+
+        Returns
+        -------
+        float
+            Energy of one read operation in Joules
+        """
+        return 0.0
+
+    @actionDynamicEnergy
+    def write(self) -> float:
+        """
+        Returns the energy of one write operation in Joules. Energy is zero.
+
+        Returns
+        -------
+        float
+            Energy of one write operation in Joules
+        """
+        return 0.0
+
+class DummyNetwork(LibraryEstimatorClassBase):
+    """
+    A dummy network component. Has zero area, zero energy, and zero leakage power.
+
+    Parameters
+    ----------
+    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)
+        self.tech_node: float = tech_node
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy of one read operation in Joules. Energy is zero.
+
+        Returns
+        -------
+        float
+            Energy of one read operation in Joules
+        """
+        return 0.0
+
+    @actionDynamicEnergy
+    def write(self) -> float:
+        """
+        Returns the energy of one write operation in Joules. Energy is zero.
+
+        Returns
+        -------
+        float
+            Energy of one write operation in Joules
+        """
+        return 0.0

hwcomponents_library/library/forms.py

@@ -0,0 +1,80 @@
+"""
+@INPROCEEDINGS{9499856,
+  author={Yuan, Geng and Behnam, Payman and Li, Zhengang and Shafiee, Ali and Lin, Sheng and Ma, Xiaolong and Liu, Hang and Qian, Xuehai and Bojnordi, Mahdi Nazm and Wang, Yanzhi and Ding, Caiwen},
+  booktitle={2021 ACM/IEEE 48th Annual International Symposium on Computer Architecture (ISCA)},
+  title={FORMS: Fine-grained Polarized ReRAM-based In-situ Computation for Mixed-signal DNN Accelerator},
+  year={2021},
+  volume={},
+  number={},
+  pages={265-278},
+  doi={10.1109/ISCA52012.2021.00029}}
+"""
+
+from hwcomponents_library.base import LibraryEstimatorClassBase
+from hwcomponents.scaling import *
+from hwcomponents import actionDynamicEnergy
+from .isaac import IsaacDAC
+
+
+# Original CSV contents:
+# tech_node,global_cycle_period,resolution,energy,area,n_instances,action
+# 32nm,1e-9,4,0.22619,284.375,1,convert|read
+# 32nm,1e-9,4,0,284.375,1,update|write|leak
+# # Energy: 15.2*10^-3 W / (2.1*32*10^9 ADC BW) * 10 ^ 12 J->pJ
+# # 15.2*10^-3 / (2.1*32*10^9) * 10 ^ 12
+# # Area: 9100um^2 / 32
+class FormsADC(LibraryEstimatorClassBase):
+    """
+    The analog-digital-converter (ADC) from the FORMS paper.
+
+    Parameters
+    ----------
+    tech_node: float
+        Technology node in meters.
+    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)
+        self.tech_node: float = self.scale(
+            "tech_node",
+            tech_node,
+            32e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+        self.resolution: int = self.scale(
+            "resolution", resolution, 4, pow_base(2), pow_base(2), pow_base(2)
+        )
+
+    @actionDynamicEnergy
+    def convert(self) -> float:
+        """
+        Returns the energy of one ADC conversion in Joules
+
+        Returns
+        -------
+        float
+            Energy of one ADC conversion in Joules
+        """
+        return 0.22619e-12
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy of one ADC conversion operation in Joules
+
+        Returns
+        -------
+        float
+            Energy of one ADC conversion operation in Joules
+        """
+        return 0.22619e-12
+
+
+class FormsDAC(IsaacDAC):
+    pass