canns 0.12.6__py3-none-any.whl → 0.13.0__py3-none-any.whl

canns/trainer/__init__.py

@@ -1,9 +1,12 @@
-"""
-Training utilities for CANNs models.
+"""Training utilities for CANNs models.
+
+This namespace exposes the abstract ``Trainer`` base class and concrete
+implementations of classic brain-inspired learning algorithms such as
+``HebbianTrainer`` and ``OjaTrainer``.
 
-The module exposes the abstract ``Trainer`` base class and concrete implementations
-of classic brain-inspired learning algorithms: ``HebbianTrainer``, ``AntiHebbianTrainer``,
-``OjaTrainer``, ``BCMTrainer``, ``SangerTrainer``, and ``STDPTrainer``.
+Examples:
+    >>> from canns import trainer
+    >>> print(trainer.Trainer)
 """
 
 from ._base import Trainer

canns/utils/__init__.py

@@ -1,8 +1,16 @@
-"""
-General utilities for CANNs.
+"""General utilities for CANNs.
+
+This namespace provides small helpers that don't fit into a specific domain,
+such as benchmarking utilities.
 
-This module provides general-purpose utilities that don't fit into specific
-domain modules, such as benchmarking and performance measurement tools.
+Examples:
+    >>> from canns.utils import benchmark
+    >>>
+    >>> @benchmark(runs=3)
+    ... def add():
+    ...     return 1 + 1
+    >>>
+    >>> add()
 """
 
 from .benchmark import benchmark

{canns-0.12.6.dist-info → canns-0.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: canns
-Version: 0.12.6
+Version: 0.13.0
 Summary: A Python Library for Continuous Attractor Neural Networks
 Project-URL: Repository, https://github.com/routhleck/canns
 Author-email: Sichao He <sichaohe@outlook.com>
@@ -18,6 +18,7 @@ Classifier: Typing :: Typed
 Requires-Python: <4.0,>=3.11
 Requires-Dist: brainpy[cpu]
 Requires-Dist: canns-lib>=0.6.2
+Requires-Dist: climage>=0.2.2
 Requires-Dist: furo>=2025.7.19
 Requires-Dist: imageio[ffmpeg]>=2.37.0
 Requires-Dist: notebook>=7.4.4
@@ -25,6 +26,7 @@ Requires-Dist: numba>=0.56.0
 Requires-Dist: numpy<2.3,>=1.24
 Requires-Dist: scipy>=1.9.0
 Requires-Dist: seaborn>=0.13.2
+Requires-Dist: textual>=7.3.0
 Requires-Dist: tqdm
 Provides-Extra: cpu
 Requires-Dist: brainpy[cpu]; extra == 'cpu'
@@ -65,7 +67,7 @@ CANNs is a Python library built on top of brainpy with performance‑critical mo
 - **Task-first API** – `canns.task.tracking` and `canns.task.open_loop_navigation` generate smooth tracking inputs, population coding stimuli, or import experimental trajectories.
 - **Rich analysis suite** – `canns.analyzer` covers energy landscapes, tuning curves, spike embeddings, UMAP/TDA helpers, and theta-sweep animations.
 - **Unified training** – `canns.trainer.HebbianTrainer` implements generic Hebbian learning and prediction, layered on the abstract `Trainer` base.
-- **Pipelines out of the box** – `canns.pipeline.ThetaSweepPipeline` orchestrates navigation tasks, direction/grid-cell networks, and visualisation in a single call.
+- **Pipeline workspace** – the ASA TUI (Attractor Structure Analyzer) provides an end-to-end analysis workflow (TDA → decode → CohoMap/CohoSpace/FR/FRM) for interactive runs.
 - **Extensible foundations** – base classes (`BasicModel`, `Task`, `Trainer`, `Pipeline`) keep custom components consistent with the built-in ecosystem.
 
 ## Visual Gallery
@@ -115,6 +117,7 @@ pip install canns
 # Optional accelerators (Linux only)
 pip install canns[cuda12]
 pip install canns[tpu]
+
 ```
 
 ## Quick Start
@@ -150,7 +153,7 @@ us, inputs = bm.for_loop(
 )
 ```
 
-For an end-to-end theta sweep workflow, see `examples/pipeline/theta_sweep_from_external_data.py` or the `ThetaSweepPipeline` notebook in the docs.
+For the ASA pipeline, run the TUI via `python -m canns.pipeline.asa` (or the `canns-tui` entrypoint) and point it at your ASA `.npz` inputs.
 
 ## Documentation & Notebooks
 

canns-0.13.0.dist-info/RECORD

@@ -0,0 +1,91 @@
+canns/__init__.py,sha256=ZK4buN-csoLKXaKtoDrOoZbNGCoLCNuF2XS96X8LbH8,1523
+canns/_version.py,sha256=zIvJPOGBFvo4VV6f586rlO_bvhuFp1fsxjf6xhsqkJY,1547
+canns/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+canns/analyzer/__init__.py,sha256=EQ02fYHkpMADp-ojpVCVtapuSPkl6j5WVfdPy0mOTs4,506
+canns/analyzer/data/__init__.py,sha256=5LJ8Q4SyDpi6CAzyW3lSpra3I0BgG20kmQMceONw7A4,158
+canns/analyzer/data/asa/__init__.py,sha256=MNsWjFFWFbnDbYPgvF43Kj4Tv8pPpqmdJnlNbK2_fbI,1670
+canns/analyzer/data/asa/cohospace.py,sha256=n6DfPWUH_k67KrPbNMt1EUdxMuRFFmXCaqh4gcuXngM,27847
+canns/analyzer/data/asa/config.py,sha256=zVs-snLkD93hGc97GEX9CkcjTtUqORvMCs3khHhqd64,6288
+canns/analyzer/data/asa/decode.py,sha256=5haC6WclPIDQgPtnDfjKoWFbDwJVyaBzTEiRbdPnbyU,16579
+canns/analyzer/data/asa/embedding.py,sha256=rT3hOHk6BzHF1X5YznIFxE_dDveklbT0fx9GtA2w3z0,9550
+canns/analyzer/data/asa/filters.py,sha256=D-1mDVn4hBEAphKUgx1gQEUfgbghKcNQhZmr4xEExQA,7146
+canns/analyzer/data/asa/fr.py,sha256=VRvruZl5NBfK7QEsRLsqHSftelHFXghzJfBU1nov-YQ,13593
+canns/analyzer/data/asa/path.py,sha256=p3r8EGcJi8NewNFutr3kdO-ekdU_5Icpy6nAoELzSq4,12233
+canns/analyzer/data/asa/plotting.py,sha256=7EfVSUERju6lggXyZ8U_BkJznaoTgwY2w3aVfyoy5rs,40325
+canns/analyzer/data/asa/tda.py,sha256=Hn110SBN4wKgHmcwPRkxHdbQ5DFW2xLdSv26J37_Zxc,30342
+canns/analyzer/data/legacy/__init__.py,sha256=JNFKxWBlT2p4Nf70Ddby67-4UYNaVS7lQFAy5wXEE-8,92
+canns/analyzer/data/legacy/cann1d.py,sha256=QN4vbYXrfcxAVbPhaYiXGoP5QzTc6hWJJGo5ETP_RSU,35793
+canns/analyzer/data/legacy/cann2d.py,sha256=RaibP0byPKK9qGefQme0-uZLwqTKOFGBL3VfmbRZOjk,86659
+canns/analyzer/metrics/__init__.py,sha256=WaTCJE2WhqPtZXYTtMilF_f0LZUfz2h9a25HzwmCwP8,132
+canns/analyzer/metrics/spatial_metrics.py,sha256=ZdS7tGH3lMgNlSYoHlH8IPsCw4XL0KtEnGALg_WHRX8,8965
+canns/analyzer/metrics/systematic_ratemap.py,sha256=MzXfa6_fGgrxD5xEd4hfrZR_fyUmhXQCxnPE3hUonE8,14004
+canns/analyzer/metrics/utils.py,sha256=Ft6lagKdTRJIz6hj9Zmy0i-IU--_Kdrrfzh6xVOQb8g,7402
+canns/analyzer/model_specific/__init__.py,sha256=UCw_MwJJh2AQtnfVeJSzvTVTdVN1ev5oGGoyZtSt1PU,80
+canns/analyzer/model_specific/hopfield.py,sha256=zNPChxX_GuCgc5-KP1KMwHyUDVUh_5EMQzZygOGtIW0,7741
+canns/analyzer/slow_points/__init__.py,sha256=teH7uaVLCXeZGirfez8i3VkbR49pd4isedEtSzweHQs,532
+canns/analyzer/slow_points/checkpoint.py,sha256=s4_-5HZJvmnyFqpK1O9WWYkhAhZj1i5jn9SH6XTGwoY,2980
+canns/analyzer/slow_points/finder.py,sha256=y-YKg-LI7lRM4JMghfcb5NGSYhIM2VPRA37YSCkVK_4,25437
+canns/analyzer/slow_points/fixed_points.py,sha256=Qp-iezwydWWUTchb2hGXJv0QKJqIm9gSG6hh0H9Eb6E,10099
+canns/analyzer/slow_points/visualization.py,sha256=sRmmxs900OSB680MTp0PNIGLpS5i5AmJ58ek20vmrSE,10610
+canns/analyzer/visualization/__init__.py,sha256=pNIokzS8y3ydzEMmVm1FNrOMRALDeuOHbcwZicPUm90,2131
+canns/analyzer/visualization/energy_plots.py,sha256=u0TOLzd7AWEfs-tRYZg1UBwsGYGPF_eWsMip1ZG9jPA,35671
+canns/analyzer/visualization/spatial_plots.py,sha256=30m02xhYkZfEETCtvBSwLix9SEOPcLZTg0AGGFvPc2w,34605
+canns/analyzer/visualization/spike_plots.py,sha256=wOm4gh_3obJy6gwo31maoaiZ7O8rsoYeFdhseoVmX78,12280
+canns/analyzer/visualization/theta_sweep_plots.py,sha256=2kiP7-IizqGm0q-ohQ4HhDZpm3sqs_lgn3GErHEZzbI,62262
+canns/analyzer/visualization/tuning_plots.py,sha256=9JOeC4dlulVzpHQWDVy3dlJnxcBZiOPeapPdVFR-7Zk,5178
+canns/analyzer/visualization/core/__init__.py,sha256=Vngm2A05cTu9ZVEYepTF7lVpuwQvMRjXs9XPLfZzedI,1928
+canns/analyzer/visualization/core/animation.py,sha256=qfBYMd81_GwWEw4MHOu3GrVXJtHS9W1xxtmOx-J5ZyM,7664
+canns/analyzer/visualization/core/backend.py,sha256=Nbk-ARL_xeWlb3nl5SUPrFQNns2wq5BeHU3Q_tAbd_c,9539
+canns/analyzer/visualization/core/config.py,sha256=9_n5hrvJXZgv32OlE_PuNh4JaPgw3dRAp_8LRzYnt_w,24131
+canns/analyzer/visualization/core/jupyter_utils.py,sha256=JD56VeeWb7w9t5DJ8TpgnxRWkUK46ArbbPSTlFdIM10,6034
+canns/analyzer/visualization/core/rendering.py,sha256=YCbiXu8MOAqE9FVb_id5JKr5g9O64sCh-dOs0EK4gnU,18291
+canns/analyzer/visualization/core/writers.py,sha256=HLsP953hgsv140ZX2XPzHfCUTqenjmjbLNrbknKam_s,15607
+canns/data/__init__.py,sha256=BjQWgDYxh4jqtcKzcEZbdTech92AUzt_1KsDU1S88kM,864
+canns/data/datasets.py,sha256=TRHxQGlMPoboiTPKhjTv1AMGbMnIt9T472Juyz4PYS0,13480
+canns/data/loaders.py,sha256=S2JFUN83MsXCN0FBRIrxpJvW_EyXGGptis4QXvS3FSI,13622
+canns/models/__init__.py,sha256=2j5josUkwQQq8Of_gLjecYry65DuC96J8X-RlRqskYs,305
+canns/models/basic/__init__.py,sha256=mNqyGz_z29YNMC345b_VyuVI9hQQ9NFe9mIU9f5KGVU,329
+canns/models/basic/_base.py,sha256=L7oECkO5-5j9r1faaz6RDIqQKHy6DEflHRGHyaW9ARg,3800
+canns/models/basic/cann.py,sha256=uR7j5u71b4qLFK_0xS5pXTZoLyEOa0tvsmT3D0O-CMQ,24588
+canns/models/basic/grid_cell.py,sha256=8nGXgXAh8UDNx3j3taqwBOsgOBVxjIk9u45v9zFSvrE,31955
+canns/models/basic/hierarchical_model.py,sha256=V2QRuTVirT3_7quFC6sJb1JyNIMbo5WlAo7BybV6QKE,53847
+canns/models/basic/theta_sweep_model.py,sha256=GGd3_X81eNzPoguXbleVWO_ID253FzQOqdxEPA5VJUo,34075
+canns/models/brain_inspired/__init__.py,sha256=MuG-adTkIIhOxs63u0f0b0oO6srilGQzR_Gta8qXeXY,620
+canns/models/brain_inspired/_base.py,sha256=YyzgmCh-YzUsK22NbSAapUWHk03jwJ49b1kRCfMWbQk,3820
+canns/models/brain_inspired/hopfield.py,sha256=KQmXWBvUTdQ17t9VG-8Sy_uJznEt4eunONYJsiN5GvY,6903
+canns/models/brain_inspired/linear.py,sha256=oRjJnTqrheAADA5unYBu83RSm4UoUH-BK2Mt_liwDtw,6141
+canns/models/brain_inspired/spiking.py,sha256=hr2w7c6Eobxwp2z6vkV9Yivpv1964-cno-XOfMSh3RU,5557
+canns/models/hybrid/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+canns/pipeline/__init__.py,sha256=OgFh5UXId99j_W4MkcpTaYD9qpQVXt-v9xN8cCY8sSc,371
+canns/pipeline/_base.py,sha256=bYCmvXQ_0vGF-MEVpi0sUljrqmW6Ax8csQ5fcnX7nAE,1869
+canns/pipeline/asa/__init__.py,sha256=JR4T0onfmkKMOrUq-k0San1RTSb1om6cd27tWovBp0c,466
+canns/pipeline/asa/__main__.py,sha256=_KgAeuGQ2-SXmuZhvZCkRx9luFf7VgKUCuszNlUswyA,197
+canns/pipeline/asa/app.py,sha256=L5al6PrGoEzRNosZlHbn-VaTxXCoVyfKFn0f1e-0FUI,49906
+canns/pipeline/asa/runner.py,sha256=PfHXlI-m3m-IYVFcFRhSODfPoRlCrloDOqEftvAfasg,42723
+canns/pipeline/asa/screens.py,sha256=DbqidxmoKe4KzSLuxuriVv1PIVFn5Z-PfScVfjrIiEA,5954
+canns/pipeline/asa/state.py,sha256=XukidfcFIOmm9ttT226FOTYR5hv2VAY8_DZt7V1Ml2g,6955
+canns/pipeline/asa/styles.tcss,sha256=eaXI3rQeWdBYmWdLJMMiSO6acHtreLRVKKoIHb2-dBk,3349
+canns/pipeline/asa/widgets.py,sha256=9pO6fJ13sQUm4vxETdSpYDXDA7z0mi3yFZO_RDakxpY,8087
+canns/pipeline/gallery/__init__.py,sha256=PPOvxmTRzEnj33jHlsFlaWuEfhrcNe39pMPQkTisjlo,187
+canns/task/__init__.py,sha256=sfo8TBBVAqkx73Nu5lVv77UCwZjKqjt042ezW4Wv2Ec,350
+canns/task/_base.py,sha256=rdRy4mr6x53z4aJv04UJcpqCyv78AxB1k1DhxnriLpg,4401
+canns/task/closed_loop_navigation.py,sha256=QxxLdAg4Zd8763bS001jFqfts3A6_r6hpTTfrh1LdW8,10204
+canns/task/navigation_base.py,sha256=s7mgXKhJyxIEUnSY8zXL3k9kH26MMQDv2xptzObu7Fc,40692
+canns/task/open_loop_navigation.py,sha256=jD77GVIGLaBVm0zKmOfghKk_Vj_9pjkjK8_a40907bU,45402
+canns/task/tracking.py,sha256=KNJ7QkecRimxDa4lLC9JnzTvQGB-c0_lvU-InlmcLOY,31866
+canns/trainer/__init__.py,sha256=ouHRuCuLuwFyrsOWbaotGxHIs5BdiYBtMhqE2k7HcKI,660
+canns/trainer/_base.py,sha256=EQIXnvRvhCo0veTItGQumNeGuerHzsqipxyGZGIt2QI,1536
+canns/trainer/bcm.py,sha256=-KjncsWsVGZVpmcIJIA9BvQf9AFw0M_4PcavAFIwkvA,6349
+canns/trainer/hebbian.py,sha256=b6HcLrYPgcoBJUN6nZSoFILFMFaKYn-cz3FZ9SVOppI,23740
+canns/trainer/oja.py,sha256=I6oCXmZj4wb30_cBVaNrye8YTxPRYLL2cdwULNaaops,5617
+canns/trainer/sanger.py,sha256=cvBB7v9EA-69semVjJu_Pg9AQffZZ5sj0KGnw63CJAo,6638
+canns/trainer/stdp.py,sha256=kH0FYkHbluPhczkTf7TxZrlFME65Y4fRY6b-jqPl10c,8670
+canns/trainer/utils.py,sha256=ZdoLiRqFLfKXsWi0KX3wGUp0OqFikwiou8dPf3xvFhE,2847
+canns/typing/__init__.py,sha256=mXySdfmD8fA56WqZTb1Nj-ZovcejwLzNjuk6PRfTwmA,156
+canns/utils/__init__.py,sha256=OMyZ5jqZAIUS2Jr0qcnvvrx6YM-BZ1EJy5uZYeA3HC0,366
+canns/utils/benchmark.py,sha256=oJ7nvbvnQMh4_MZh7z160NPLp-197X0rEnmnLHYlev4,1361
+canns-0.13.0.dist-info/METADATA,sha256=E-6ivcs7Yrp4Hffey9nfIQttDe6dzWwAbg-sT09auAg,8827
+canns-0.13.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+canns-0.13.0.dist-info/entry_points.txt,sha256=HDzYp0e9E1wfKYRkYtnUgVKK_u33_7eIn9exgm7t-wg,75
+canns-0.13.0.dist-info/licenses/LICENSE,sha256=u6NJ1N-QSnf5yTwSk5UvFAdU2yKD0jxG0Xa91n1cPO4,11306
+canns-0.13.0.dist-info/RECORD,,

{canns-0.12.6.dist-info → canns-0.13.0.dist-info}/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
 canns = canns:master
+canns-tui = canns.pipeline.asa:main