hypercube-hopfield1984 1.0.0__tar.gz

hypercube_hopfield1984-1.0.0/CMakeLists.txt

@@ -0,0 +1,75 @@
+cmake_minimum_required(VERSION 3.20)
+project(HypercubeHopfield1984Python LANGUAGES CXX)
+
+set(CMAKE_CXX_STANDARD 23)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+
+# ── pybind11 ──
+find_package(pybind11 CONFIG REQUIRED)
+
+# ── Optimization flags (match the main project / sibling python builds) ──
+# HYPERCUBE_ARCH controls -march. Defaults to "native" for local dev builds.
+# cibuildwheel overrides to "x86-64-v2" (x86_64) or "none" (ARM, MSVC).
+set(HYPERCUBE_ARCH "native" CACHE STRING "Target architecture for -march (native, x86-64-v2, none)")
+
+if(MSVC)
+    add_compile_options(/O2 /fp:fast)
+else()
+    add_compile_options(-O3 -ffast-math)
+    if(NOT HYPERCUBE_ARCH STREQUAL "none")
+        if(HYPERCUBE_ARCH STREQUAL "native")
+            add_compile_options(-march=native -mtune=native)
+        else()
+            add_compile_options(-march=${HYPERCUBE_ARCH} -mtune=generic)
+        endif()
+    endif()
+    add_compile_options(-Wall -Wextra -Wno-unknown-pragmas)
+endif()
+
+# ── Core source compiled directly into the module (PIC required) ──
+set(CORE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/..")
+set(CORE_SOURCES
+    ${CORE_DIR}/Hopfield.cpp
+)
+
+# ── Package version (single source: hypercube_hopfield1984/_version.py) ──
+set(_HH84_VERSION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/hypercube_hopfield1984/_version.py")
+set(HYPERCUBE_HOPFIELD1984_VERSION "")
+file(STRINGS "${_HH84_VERSION_FILE}" _HH84_VERSION_LINES)
+foreach(_line IN LISTS _HH84_VERSION_LINES)
+    # Strip CR (Windows) and match: __version__ = "x.y.z"
+    string(REPLACE "\r" "" _line "${_line}")
+    if(_line MATCHES "^__version__[ \t]*=[ \t]*\"([^\"]+)\"")
+        set(HYPERCUBE_HOPFIELD1984_VERSION "${CMAKE_MATCH_1}")
+        break()
+    endif()
+endforeach()
+if(HYPERCUBE_HOPFIELD1984_VERSION STREQUAL "")
+    message(FATAL_ERROR
+        "Could not parse __version__ from hypercube_hopfield1984/_version.py")
+endif()
+message(STATUS "hypercube_hopfield1984 version: ${HYPERCUBE_HOPFIELD1984_VERSION}")
+
+# ── Build the Python extension module ──
+pybind11_add_module(_core bindings.cpp ${CORE_SOURCES})
+target_include_directories(_core PRIVATE ${CORE_DIR})
+target_compile_definitions(_core PRIVATE
+    "HYPERCUBE_HOPFIELD1984_VERSION=\"${HYPERCUBE_HOPFIELD1984_VERSION}\"")
+
+# ── Linking ──
+if(MINGW)
+    # Static libgcc/libstdc++ keep the .pyd free of those DLLs. Do NOT static-link
+    # winpthread: mingw-w64 15.2.0's libwinpthread.a references __intrinsic_setjmpex
+    # and fails at link (same constraint as the sibling python builds).
+    # Posix-model MinGW still needs libwinpthread-1.dll at runtime — ship the DLL
+    # from THIS toolchain (stale copies miss symbols like nanosleep64).
+    target_link_options(_core PRIVATE -static-libgcc -static-libstdc++)
+    find_file(WINPTHREAD_DLL libwinpthread-1.dll PATHS ENV PATH NO_DEFAULT_PATH)
+    if(WINPTHREAD_DLL)
+        install(FILES ${WINPTHREAD_DLL} DESTINATION hypercube_hopfield1984)
+    endif()
+endif()
+
+# ── Install into the hypercube_hopfield1984 package directory ──
+install(TARGETS _core DESTINATION hypercube_hopfield1984)

hypercube_hopfield1984-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 David Charles Liptak
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

hypercube_hopfield1984-1.0.0/PKG-INFO

@@ -0,0 +1,306 @@
+Metadata-Version: 2.4
+Name: hypercube-hopfield1984
+Version: 1.0.0
+Summary: Python bindings for HypercubeHopfield1984: Hopfield's 1984 graded associative memory on a Boolean hypercube
+License-Expression: Apache-2.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: C++
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Project-URL: Homepage, https://github.com/dliptak001/HypercubeHopfield1984
+Project-URL: Documentation, https://github.com/dliptak001/HypercubeHopfield1984/blob/master/docs/Python_SDK.md
+Project-URL: Repository, https://github.com/dliptak001/HypercubeHopfield1984
+Requires-Python: >=3.10
+Requires-Dist: numpy>=1.21
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Description-Content-Type: text/markdown
+
+# Hypercube Hopfield 1984
+
+[![Build wheels](https://github.com/dliptak001/HypercubeHopfield1984/actions/workflows/wheels.yml/badge.svg)](https://github.com/dliptak001/HypercubeHopfield1984/actions/workflows/wheels.yml)
+[![PyPI](https://img.shields.io/pypi/v/hypercube-hopfield1984)](https://pypi.org/project/hypercube-hopfield1984/)
+[![Python](https://img.shields.io/pypi/pyversions/hypercube-hopfield1984)](https://pypi.org/project/hypercube-hopfield1984/)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/dliptak001/HypercubeHopfield1984/blob/master/LICENSE)
+[![C++23](https://img.shields.io/badge/C%2B%2B-23-blue.svg)](https://en.cppreference.com/w/cpp/23)
+
+This package is the **Python** surface for HypercubeHopfield1984
+(`import hypercube_hopfield1984`).
+Full API reference: **[docs/Python_SDK.md](https://github.com/dliptak001/HypercubeHopfield1984/blob/master/docs/Python_SDK.md)**.
+C++ integration guide: **[docs/CPP_SDK.md](https://github.com/dliptak001/HypercubeHopfield1984/blob/master/docs/CPP_SDK.md)**.
+Project home: **[github.com/dliptak001/HypercubeHopfield1984](https://github.com/dliptak001/HypercubeHopfield1984)**.
+
+HypercubeHopfield1984 is Hopfield's **graded associative memory**, the
+model of J. J. Hopfield's 1984 paper, "Neurons with graded response have
+collective computational properties like those of two-state neurons"
+(Proc. Natl. Acad. Sci. USA 81, 3088–3092), built on a Boolean hypercube.
+Every vertex holds a floating-point state and every edge a floating-point
+weight, both in [−1, 1]. The caller shows the network a pattern. In
+training mode the network adjusts its weights so the pattern becomes a
+low point of its energy. In latch mode the pattern plays two roles at
+once: it is the starting state of the cube, and it also stays applied to
+every vertex for the whole settle as a steady push, Hopfield's input
+current. The weights pull the cube toward what they have stored while the
+pattern keeps pulling it back toward itself, and the network returns the
+state where those two pulls balance.
+
+That balance is the point of this network. Because the pattern never
+stops pulling, the output is never a stored pattern looked up from a
+fragment; it is the input, pulled part of the way toward what the memory
+has seen. **It is a shaper, not a recall.** A stored pattern comes back
+nearly as it went in. A damaged one comes back repaired toward its stored
+form. An unknown one comes back moved toward the nearest thing the memory
+knows, by an amount that says how familiar it is. If you want a clean
+retrieval from a cue, use a modern Hopfield network; if you want a signal
+bent by experience and passed on, use this one.
+
+There is one class, `Hopfield`, and it stays a float network throughout:
+nothing is ever rounded to ±1. It stands beside
+[HypercubeHopfield](https://github.com/dliptak001/HypercubeHopfield), the
+modern (dense, softmax-over-patterns) Hopfield network in the same family,
+which does the retrieval this one does not.
+
+---
+
+<p align="center">
+  <strong>HypercubeAI ecosystem</strong><br/>
+</p>
+
+<p align="center">
+  <a href="https://github.com/dliptak001/HypercubeCascade"><strong>HypercubeCascade</strong></a>
+  &nbsp;·&nbsp;
+  <a href="https://github.com/dliptak001/HypercubeCNN"><strong>HypercubeCNN</strong></a>
+  &nbsp;·&nbsp;
+  <a href="https://github.com/dliptak001/HypercubeESN"><strong>HypercubeESN</strong></a>
+  &nbsp;·&nbsp;
+  <a href="https://github.com/dliptak001/HypercubeEtalon"><strong>HypercubeEtalon</strong></a>
+  &nbsp;·&nbsp;
+  <a href="https://github.com/dliptak001/HypercubeHopfield"><strong>HypercubeHopfield</strong></a>
+  &nbsp;·&nbsp;
+  <a href="https://github.com/dliptak001/HypercubeHopfield1984"><strong>HypercubeHopfield1984</strong></a>
+  &nbsp;·&nbsp;
+  <a href="https://github.com/dliptak001/HypercubeLCN"><strong>HypercubeLCN</strong></a>
+  &nbsp;·&nbsp;
+  <a href="https://github.com/dliptak001/HypercubeWorldModel"><strong>HypercubeWorldModel</strong></a>
+  &nbsp;·&nbsp;
+  <a href="https://github.com/dliptak001/HypercubeWTF"><strong>HypercubeWTF</strong></a>
+</p>
+
+<p align="center">
+  📄 Foundational paper:
+  <a href="https://github.com/dliptak001/HypercubeHopfield1984/blob/master/docs/Boolean_hypercubes_as_a_neural_substrate.pdf"><em>Boolean Hypercubes as a Neural Substrate</em></a>
+  (D.&nbsp;C.&nbsp;Liptak, 2026)
+</p>
+
+HypercubeHopfield1984 is an experiment in the **HypercubeAI** project,
+our quest to systematically re-implement classical neural architectures
+on a Boolean hypercube topology instead of Euclidean grids or random
+graphs. The central thesis is "topology-native intelligence": the
+hypercube's algebraic structure (vertex-transitive symmetry, Hamming
+geometry, bitwise addressing) can serve as a first-class computational
+substrate.
+
+- **A topology you don't store**: connectivity is implicit in the vertex
+  indices, and the neighborhood is programmable. Two vertices are joined
+  when their indices differ in exactly `distance` bits, so stepping to a
+  neighbor is one XOR with a `distance`-bit mask. The dimension and that
+  one number fix the whole graph, from the hypercube at distance 1 to the
+  middle shell at dim/2.
+- **Perfect homogeneity**: every vertex has the same degree and the same
+  local world, so the dynamics mean the same thing everywhere.
+- **Cheap navigation**: each neighbor is a few bit operations on the
+  vertex index, not a pointer chase through a stored edge list.
+
+Each product in the family is a different architecture on that same
+foundation.
+
+---
+
+## The network
+
+A vertex is an integer from 0 to 2ᵈⁱᵐ − 1. Its neighbors are the vertices
+whose index differs from it in exactly `distance` bits, so at distance 1
+the graph is the hypercube itself and at larger distances every vertex has
+C(dim, distance) neighbors. Each edge carries one weight, read from both
+ends.
+
+A settle rewrites each vertex to tanh(gain · hᵥ), where the local field hᵥ
+is the weighted sum of its neighbors' states plus the input current, the
+input gain times the pattern's value at that vertex. The vertices are
+rewritten one popcount class at a time, in place, so every rewrite is a
+descent on Hopfield's energy and the settle stops at a stationary point of
+it. Training adds η · eᵥ · eᵤ to every edge and clamps it to [−1, 1].
+The full description, with the energy, the sweep, and the measured
+operating points, is in
+[docs/hopfield.md](https://github.com/dliptak001/HypercubeHopfield1984/blob/master/docs/hopfield.md).
+
+---
+
+## Installation
+
+**Preferred:** install a pre-built wheel from PyPI (no compiler).
+
+```bash
+pip install hypercube-hopfield1984
+```
+
+```python
+import hypercube_hopfield1984 as hh
+print(hh.__version__)
+```
+
+Package name on PyPI: **`hypercube-hopfield1984`**. Import name:
+**`hypercube_hopfield1984`**. Main type: **`hh.Hopfield`**.
+
+Wheels target Python 3.10 through 3.14 on common Windows, Linux, and macOS
+machines. Runtime dependency: NumPy only.
+
+### From source (full repository)
+
+To compile the extension yourself, clone this **entire** repository (not a
+minimal source-only download of the `python/` folder alone; the C++ core
+lives next to `python/`). You need Python 3.10+, a C++23 compiler, and
+CMake ≥ 3.20.
+
+```bash
+git clone https://github.com/dliptak001/HypercubeHopfield1984.git
+cd HypercubeHopfield1984/python
+pip install .
+```
+
+On Windows with CLion's MinGW, put that compiler's `bin` folder (and Ninja)
+on your `PATH`, then:
+
+```bash
+pip install . --no-build-isolation --force-reinstall --no-deps
+```
+
+(Exact CLion paths change with the version.)
+
+---
+
+## Quick start
+
+You bring each pattern as an array of 2ᵏ floats, k ≤ dim. How you get there
+(pad an image, reshape a spectrum, invent a layout) is up to you. A shorter
+pattern repeats onto every copy of the low-k cube.
+
+```python
+import numpy as np
+import hypercube_hopfield1984 as hh
+
+net = hh.Hopfield(dim=10, gain=0.03, sweep_budget=64, rest_tolerance=0.01,
+                  eta=0.003, input_gain=20.0, distance=5)
+N = net.N                                   # 1024
+
+rng = np.random.default_rng(0)
+patterns = rng.uniform(-1, 1, (50, N)).astype(np.float32)
+for _ in range(50):
+    for p in patterns:
+        net.train(p)                        # deepen each pattern's well
+
+latch = net.latch(patterns[0])              # (N,) float32: the settled cube
+print(net.sweep_count, net.at_rest)
+print(net)
+
+net.save("memory.pkl")
+loaded = hh.Hopfield.load("memory.pkl")
+```
+
+The operating point above (dim 10, distance 5, gain 0.03, input gain 20,
+η 0.003) is the measured one: a stored pattern comes back with cosine
+0.987 to itself and a pattern with a quarter of its sites randomized is
+repaired from cosine 0.75 to 0.85. The rows for dim 11 and 12 are one
+rule, gain = 7.56 / degree and input gain = degree / 12.6.
+
+---
+
+## Features
+
+- **One class**: `hypercube_hopfield1984.Hopfield` is the whole product surface
+- **`train` / `latch` / `energy`**: exposed one-to-one with the C++ API
+- **dim 1 through 31**: N = 2ᵈⁱᵐ vertices; `distance` picks the degree, the capacity lever
+- **Graded throughout**: states and weights are floats in [−1, 1]; nothing is rounded to ±1
+- **Short exposures tile**: a 2ᵏ pattern repeats onto every copy of the low-k cube
+- **Latch record**: `sweep_count` and `at_rest` say how the last settle ended
+- **Weights as NumPy**: `net.weights` (settable), row-major N × degree
+- **Save / load**: `save` / `load` (pickle: config + weights)
+- **NumPy float32**: arrays converted for you; prefer contiguous float32
+- **GIL released** during `latch`, `train`, `energy`, and a weights load
+
+---
+
+## Examples
+
+For a first try, paste the [Quick start](#quick-start) after
+`pip install hypercube-hopfield1984`. That is self-contained.
+
+The demo script on GitHub under
+[`python/examples/`](https://github.com/dliptak001/HypercubeHopfield1984/tree/master/python/examples)
+is there to open or download; it is not added to your machine by pip.
+
+| Script | What it is for |
+|--------|----------------|
+| [shaper.py](https://github.com/dliptak001/HypercubeHopfield1984/blob/master/python/examples/shaper.py) | Store the fifty bundled exemplars, then latch a stored, a damaged, and a novel pattern; the latch energy tells them apart |
+
+```bash
+# from a clone of HypercubeHopfield1984, after: pip install hypercube-hopfield1984
+python python/examples/shaper.py
+```
+
+---
+
+## Documentation
+
+| Doc | Role |
+|-----|------|
+| **[docs/Python_SDK.md](https://github.com/dliptak001/HypercubeHopfield1984/blob/master/docs/Python_SDK.md)** | Canonical Python API: every method, layout, pickle, limits |
+| [docs/CPP_SDK.md](https://github.com/dliptak001/HypercubeHopfield1984/blob/master/docs/CPP_SDK.md) | Native library guide (same product, C++) |
+| [Project README](https://github.com/dliptak001/HypercubeHopfield1984#readme) | Product story and the C++ programs from the repo root |
+| [docs/hopfield.md](https://github.com/dliptak001/HypercubeHopfield1984/blob/master/docs/hopfield.md) | The network, the energy, the sweep, and the measured operating points |
+
+---
+
+## Ecosystem
+
+- **[HypercubeCascade](https://github.com/dliptak001/HypercubeCascade)**: both frozen stages in series + thin readout.
+- **[HypercubeCNN](https://github.com/dliptak001/HypercubeCNN)**: cube-native conv stack with shared kernels.
+- **[HypercubeESN](https://github.com/dliptak001/HypercubeESN)**: echo-state / reservoir computing on streams.
+- **[HypercubeEtalon](https://github.com/dliptak001/HypercubeEtalon)**: frozen etalon transit + thin readout.
+- **[HypercubeHopfield](https://github.com/dliptak001/HypercubeHopfield)**: the modern Hopfield network; clean retrieval from a cue.
+- **[HypercubeHopfield1984](https://github.com/dliptak001/HypercubeHopfield1984)**: Hopfield's 1984 graded memory; a shaper, not a recall.
+- **[HypercubeLCN](https://github.com/dliptak001/HypercubeLCN)**: the locally connected net, every weight trained.
+- **[HypercubeWorldModel](https://github.com/dliptak001/HypercubeWorldModel)**: frozen WTF encoder + trained LCN predictor and decoder.
+- **[HypercubeWTF](https://github.com/dliptak001/HypercubeWTF)**: frozen reservoir orbit + thin readout.
+
+---
+
+## License
+
+Apache 2.0.
+
+## Definitions
+
+| Symbol / term | Meaning |
+|---------------|---------|
+| Hopfield | The Python class: train, latch, energy, weights, persistence. |
+| dim | Hypercube dimension, 1 through 31. |
+| N | Vertex count, N = 2ᵈⁱᵐ. The length of a cube. |
+| distance | Hamming distance between neighbors, 1 through max(1, dim // 2). |
+| degree | Neighbors per vertex, C(dim, distance). |
+| exposure | The caller's pattern: 2ᵏ finite floats, k ≤ dim. |
+| latch | The settled cube `latch` returns: the exposure pulled toward what the memory has stored. |
+| sweep | One in-place rewrite of every even-popcount vertex in index order, then every odd-popcount vertex. |
+| settle | Sweeps repeated until one moves every vertex by at most rest_tolerance, or sweep_budget is spent. |
+| rest_tolerance | The largest move at one vertex that still counts as rest. Finite, 0 or more; default 0, bit-for-bit equality. Reaching it ends the settle with `at_rest` True. |
+| sweep_budget | The most sweeps one settle will run, 1 or more. A cube still moving when the budget is spent stops there, with `at_rest` False. |
+| weights | N · degree float32: row v holds v's weights in mask order, each edge in both endpoints' rows. |