Device and configuration presets

CHANGELOG.md

@@ -33,6 +33,16 @@ The format is based on [Keep a Changelog], and this project adheres to
 * Option to automatically scale the digital weights into the full range of the
   simluated crossbar by applying a fixed output global factor in
   digital. (\#129)
+* Added a library of device presets that are calibrated to real
+  hardware data, namely `ReRamESPresetDevice`, `ReRamSBPresetDevice`,
+  `ECRamPresetDevice`, `CapacitorPresetDevice`, and device presets
+  that are based on models in the literatur,
+  e.g. `GokmenVlasovPresetDevice` and `IdealizedPresetDevice`. They
+  can be used defining the device field in the `RPUConfig`. (\#144)
+* Added a library of config presets, such as `ReRamESPreset`,
+  `Capacitor2Preset`, `TikiTakaReRamESPreset`, and many more. These can
+  be used for tile configration (``rpu_config``). They specify a
+  particular device and optimizer choice. (\#144)
 
 #### Fixed
 

src/aihwkit/simulator/presets/__init__.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+
+# (C) Copyright 2020, 2021 IBM. All Rights Reserved.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""Configurations presets for resistive processing units."""
+
+from .configs import (
+    # Single device configs.
+    ReRamESPreset, ReRamSBPreset, CapacitorPreset, EcRamPreset, IdealizedPreset,
+    # 2-device configs.
+    ReRamES2Preset, ReRamSB2Preset, Capacitor2Preset, EcRam2Preset, Idealized2Preset,
+    # 4-device configs.
+    ReRamES4Preset, ReRamSB4Preset, Capacitor4Preset, EcRam4Preset, Idealized4Preset,
+    # Tiki-taka configs.
+    TikiTakaReRamESPreset, TikiTakaReRamSBPreset, TikiTakaCapacitorPreset,
+    TikiTakaEcRamPreset, TikiTakaIdealizedPreset
+)