pymaxim 0.2.1__tar.gz

pymaxim-0.2.1/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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 the 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 any 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
+
+   Copyright 2025 Denny Schaedig
+
+   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.

pymaxim-0.2.1/PKG-INFO

@@ -0,0 +1,232 @@
+Metadata-Version: 2.4
+Name: pymaxim
+Version: 0.2.1
+Summary: Bio-inspired cognitive architecture with adaptive planning, biological memory systems, and local LLM inference. Works headless, with simulation, or connected to robots.
+Author: Denny Schaedig
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/dennys246/Maxim
+Project-URL: Repository, https://github.com/dennys246/Maxim.git
+Project-URL: Issues, https://github.com/dennys246/Maxim/issues
+Keywords: cognitive-architecture,llm,agentic,planning,embodied-ai,robotics,memory,simulation,bio-inspired
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+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: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<3.0,>=1.26
+Requires-Dist: scipy<2.0,>=1.11
+Requires-Dist: pyyaml<7.0,>=6.0
+Requires-Dist: json-repair<1.0,>=0.30
+Requires-Dist: rich<14.0,>=13.0.0
+Provides-Extra: vision
+Requires-Dist: opencv-python<5.0,>=4.12; extra == "vision"
+Requires-Dist: onnxruntime<2.0,>=1.20; extra == "vision"
+Provides-Extra: audio
+Requires-Dist: faster-whisper>=1.1.1; extra == "audio"
+Requires-Dist: ctranslate2>=4.6.0; extra == "audio"
+Requires-Dist: av>=14.0.0; extra == "audio"
+Provides-Extra: reachy
+Requires-Dist: reachy-mini[gstreamer]<1.3,>=1.2.6; extra == "reachy"
+Provides-Extra: search
+Requires-Dist: ddgs>=6.0.0; extra == "search"
+Provides-Extra: training
+Requires-Dist: tensorflow<3.0,>=2.20; extra == "training"
+Requires-Dist: keras<4.0,>=3.13; extra == "training"
+Provides-Extra: llm-llama
+Requires-Dist: llama-cpp-python>=0.3.8; extra == "llm-llama"
+Provides-Extra: llm-server
+Requires-Dist: llama-cpp-python>=0.3.8; extra == "llm-server"
+Requires-Dist: sse-starlette>=1.6.0; extra == "llm-server"
+Requires-Dist: uvicorn>=0.22.0; extra == "llm-server"
+Requires-Dist: fastapi>=0.100.0; extra == "llm-server"
+Requires-Dist: pydantic-settings>=2.0.0; extra == "llm-server"
+Requires-Dist: starlette-context>=0.3.6; extra == "llm-server"
+Requires-Dist: openai>=1.0.0; extra == "llm-server"
+Requires-Dist: tiktoken>=0.7.0; extra == "llm-server"
+Provides-Extra: llm-torch
+Requires-Dist: torch>=2.7; extra == "llm-torch"
+Requires-Dist: transformers>=4.40.0; extra == "llm-torch"
+Requires-Dist: accelerate>=0.27.0; extra == "llm-torch"
+Requires-Dist: bitsandbytes>=0.43.0; extra == "llm-torch"
+Requires-Dist: sentencepiece>=0.2.0; extra == "llm-torch"
+Requires-Dist: huggingface-hub>=0.24.0; extra == "llm-torch"
+Provides-Extra: llm-anthropic
+Requires-Dist: anthropic>=0.40.0; extra == "llm-anthropic"
+Provides-Extra: llm-openai
+Requires-Dist: openai>=1.0.0; extra == "llm-openai"
+Requires-Dist: tiktoken>=0.7.0; extra == "llm-openai"
+Provides-Extra: tts
+Requires-Dist: piper-tts>=1.2.0; extra == "tts"
+Provides-Extra: yolo
+Requires-Dist: ultralytics<9.0,>=8.3.248; extra == "yolo"
+Requires-Dist: lap<1.0,>=0.5.12; extra == "yolo"
+Provides-Extra: comms
+Requires-Dist: twilio>=9.0.0; extra == "comms"
+Requires-Dist: fastapi>=0.100.0; extra == "comms"
+Requires-Dist: uvicorn>=0.24.0; extra == "comms"
+Provides-Extra: semantic
+Requires-Dist: sentence-transformers>=2.2.0; extra == "semantic"
+Requires-Dist: torch>=2.1; extra == "semantic"
+Provides-Extra: temporal
+Requires-Dist: dateparser>=1.2.0; extra == "temporal"
+Provides-Extra: database
+Requires-Dist: psycopg[binary]>=3.1; extra == "database"
+Requires-Dist: pgvector>=0.3; extra == "database"
+Provides-Extra: all
+Requires-Dist: pymaxim[audio,comms,database,llm-anthropic,llm-llama,llm-openai,llm-server,reachy,search,temporal,training,tts,vision]; extra == "all"
+Provides-Extra: test
+Requires-Dist: pytest>=8.0.0; extra == "test"
+Requires-Dist: pytest-cov>=4.1.0; extra == "test"
+Requires-Dist: pytest-xdist>=3.5.0; extra == "test"
+Dynamic: license-file
+
+# Maxim
+
+A bio-inspired cognitive architecture for AI agents. Combines a 5-agent pipeline with biological memory systems (Hippocampus, NAc, ATL, SCN, Angular Gyrus) and a reactive Default Network. Works headless, in simulation, or connected to a robot.
+
+## Quickstart
+
+```bash
+# With Claude (fastest way to start)
+pip install pymaxim[llm-anthropic]
+export ANTHROPIC_API_KEY=sk-...
+maxim --sim "test memory recall under interference"
+
+# Or with a local model (no API key needed)
+pip install pymaxim[llm-llama]
+maxim --list-models                        # see available models
+maxim --sim "test memory recall" --llm mistral-7b   # auto-downloads on first run
+```
+
+Check your setup with `maxim doctor`, and find session results in `~/.maxim/sessions/`.
+
+## What You Can Do
+
+- **Simulate cognitive scenarios** -- test memory, safety, causal learning with LLM-driven narrative arcs
+- **Run DM campaigns** -- multi-encounter branching stories with SEM-embodied entities
+- **Benchmark models** -- compare local and cloud LLMs across cognitive task suites
+- **Connect robots** -- hardware-agnostic runtime; Reachy Mini ships in-tree, third-party robots plug in via the `maxim.robots` entry-point group (Atlas, Spot, custom drones — see [robot-setup.md](docs/user/robot-setup.md#adding-a-new-robot)). Or run headless.
+- **Use the Python API** -- 17 verb-based functions for programmatic access
+
+## Installation
+
+```bash
+pip install pymaxim
+```
+
+### Optional Extras
+
+| Extra | What it adds |
+|-------|-------------|
+| `llm-llama` | Local LLM inference via llama.cpp |
+| `llm-torch` | PyTorch/Transformers backend |
+| `llm-anthropic` | Claude backend |
+| `llm-openai` | OpenAI backend |
+| `vision` | Camera + object detection |
+| `audio` | Microphone + Whisper transcription |
+| `reachy` | Reachy Mini robot SDK |
+| `comms` | Twilio SMS/Voice |
+| `semantic` | Sentence-transformer embeddings |
+| `tts` | Text-to-speech via Piper |
+| `database` | PostgreSQL + pgvector memory stores |
+
+See [getting-started.md](docs/user/getting-started.md) for the full list of 16 extras.
+
+```bash
+# Local LLM + vision
+pip install pymaxim[llm-llama,vision]
+
+# Everything for development
+pip install -e '.[llm-llama,llm-anthropic,llm-openai,vision,audio]'
+```
+
+## Python API
+
+```python
+import maxim
+
+# Run a simulation
+result = maxim.imagine(goal="test safety boundaries", persona="adversarial")
+
+# Inspect bio-subsystems
+state = maxim.observe("memory")
+
+# Diagnose environment
+report = maxim.diagnose()
+
+# Start the agentic loop
+maxim.run(model="mistral-7b")
+
+# Manage models
+models = maxim.list_models()
+maxim.download_model("qwen2.5-14b-instruct")
+```
+
+See [docs/user/python-api.md](docs/user/python-api.md) for the full API reference.
+
+## CLI Quick Reference
+
+```bash
+# Agent runtime with local LLM
+maxim --llm mistral-7b
+
+# Agent runtime with Claude
+maxim --llm claude-sonnet
+
+# Generative campaign
+maxim --sim "test memory recall" --persona adversarial
+
+# YAML scenario (direct injection)
+maxim --sim scenarios/experiments/hippocampal_recall_short.yaml
+
+# DM campaign
+maxim --sim scenarios/campaigns/heist_v1.yaml
+
+# Multi-model benchmark
+maxim --sim benchmark --models mistral-7b,qwen2.5-14b
+
+# Environment diagnostics
+maxim doctor
+
+# Model management
+maxim --list-models
+maxim --delete-model llama-2-13b-chat
+```
+
+See [docs/user/cli-reference.md](docs/user/cli-reference.md) for all flags.
+
+## Operating Modes
+
+Two independent dimensions control behavior:
+
+- **ProcessingState**: `awake` or `sleep` (sleep is a tool the agent calls; wakes on user input)
+- **OperationalMode**: `planning` (propose + approve), `supervised` (act within bounds), `autonomous` (full self-direction)
+
+See [docs/user/modes-guide.md](docs/user/modes-guide.md) for details.
+
+## Documentation
+
+| Guide | Description |
+|-------|-------------|
+| [Getting Started](docs/user/getting-started.md) | First-run walkthrough |
+| [CLI Reference](docs/user/cli-reference.md) | All command-line flags |
+| [Python API](docs/user/python-api.md) | Programmatic usage |
+| [Simulation](docs/user/simulation.md) | Campaigns, scenarios, benchmarks |
+| [Modes](docs/user/modes-guide.md) | Operating modes and autonomy |
+| [LLM Setup](docs/user/llm-setup.md) | Model download and configuration |
+| [Peer Setup](docs/user/peer-setup.md) | Multi-machine / tunnel setup |
+| [Architecture](docs/reference.md) | Module map, bio-system glossary, planning system |
+
+## Contributing
+
+Issues and PRs welcome at [github.com/dennys246/Maxim](https://github.com/dennys246/Maxim).
+
+## License
+
+See [LICENSE](LICENSE) for details.

pymaxim-0.2.1/README.md

@@ -0,0 +1,144 @@
+# Maxim
+
+A bio-inspired cognitive architecture for AI agents. Combines a 5-agent pipeline with biological memory systems (Hippocampus, NAc, ATL, SCN, Angular Gyrus) and a reactive Default Network. Works headless, in simulation, or connected to a robot.
+
+## Quickstart
+
+```bash
+# With Claude (fastest way to start)
+pip install pymaxim[llm-anthropic]
+export ANTHROPIC_API_KEY=sk-...
+maxim --sim "test memory recall under interference"
+
+# Or with a local model (no API key needed)
+pip install pymaxim[llm-llama]
+maxim --list-models                        # see available models
+maxim --sim "test memory recall" --llm mistral-7b   # auto-downloads on first run
+```
+
+Check your setup with `maxim doctor`, and find session results in `~/.maxim/sessions/`.
+
+## What You Can Do
+
+- **Simulate cognitive scenarios** -- test memory, safety, causal learning with LLM-driven narrative arcs
+- **Run DM campaigns** -- multi-encounter branching stories with SEM-embodied entities
+- **Benchmark models** -- compare local and cloud LLMs across cognitive task suites
+- **Connect robots** -- hardware-agnostic runtime; Reachy Mini ships in-tree, third-party robots plug in via the `maxim.robots` entry-point group (Atlas, Spot, custom drones — see [robot-setup.md](docs/user/robot-setup.md#adding-a-new-robot)). Or run headless.
+- **Use the Python API** -- 17 verb-based functions for programmatic access
+
+## Installation
+
+```bash
+pip install pymaxim
+```
+
+### Optional Extras
+
+| Extra | What it adds |
+|-------|-------------|
+| `llm-llama` | Local LLM inference via llama.cpp |
+| `llm-torch` | PyTorch/Transformers backend |
+| `llm-anthropic` | Claude backend |
+| `llm-openai` | OpenAI backend |
+| `vision` | Camera + object detection |
+| `audio` | Microphone + Whisper transcription |
+| `reachy` | Reachy Mini robot SDK |
+| `comms` | Twilio SMS/Voice |
+| `semantic` | Sentence-transformer embeddings |
+| `tts` | Text-to-speech via Piper |
+| `database` | PostgreSQL + pgvector memory stores |
+
+See [getting-started.md](docs/user/getting-started.md) for the full list of 16 extras.
+
+```bash
+# Local LLM + vision
+pip install pymaxim[llm-llama,vision]
+
+# Everything for development
+pip install -e '.[llm-llama,llm-anthropic,llm-openai,vision,audio]'
+```
+
+## Python API
+
+```python
+import maxim
+
+# Run a simulation
+result = maxim.imagine(goal="test safety boundaries", persona="adversarial")
+
+# Inspect bio-subsystems
+state = maxim.observe("memory")
+
+# Diagnose environment
+report = maxim.diagnose()
+
+# Start the agentic loop
+maxim.run(model="mistral-7b")
+
+# Manage models
+models = maxim.list_models()
+maxim.download_model("qwen2.5-14b-instruct")
+```
+
+See [docs/user/python-api.md](docs/user/python-api.md) for the full API reference.
+
+## CLI Quick Reference
+
+```bash
+# Agent runtime with local LLM
+maxim --llm mistral-7b
+
+# Agent runtime with Claude
+maxim --llm claude-sonnet
+
+# Generative campaign
+maxim --sim "test memory recall" --persona adversarial
+
+# YAML scenario (direct injection)
+maxim --sim scenarios/experiments/hippocampal_recall_short.yaml
+
+# DM campaign
+maxim --sim scenarios/campaigns/heist_v1.yaml
+
+# Multi-model benchmark
+maxim --sim benchmark --models mistral-7b,qwen2.5-14b
+
+# Environment diagnostics
+maxim doctor
+
+# Model management
+maxim --list-models
+maxim --delete-model llama-2-13b-chat
+```
+
+See [docs/user/cli-reference.md](docs/user/cli-reference.md) for all flags.
+
+## Operating Modes
+
+Two independent dimensions control behavior:
+
+- **ProcessingState**: `awake` or `sleep` (sleep is a tool the agent calls; wakes on user input)
+- **OperationalMode**: `planning` (propose + approve), `supervised` (act within bounds), `autonomous` (full self-direction)
+
+See [docs/user/modes-guide.md](docs/user/modes-guide.md) for details.
+
+## Documentation
+
+| Guide | Description |
+|-------|-------------|
+| [Getting Started](docs/user/getting-started.md) | First-run walkthrough |
+| [CLI Reference](docs/user/cli-reference.md) | All command-line flags |
+| [Python API](docs/user/python-api.md) | Programmatic usage |
+| [Simulation](docs/user/simulation.md) | Campaigns, scenarios, benchmarks |
+| [Modes](docs/user/modes-guide.md) | Operating modes and autonomy |
+| [LLM Setup](docs/user/llm-setup.md) | Model download and configuration |
+| [Peer Setup](docs/user/peer-setup.md) | Multi-machine / tunnel setup |
+| [Architecture](docs/reference.md) | Module map, bio-system glossary, planning system |
+
+## Contributing
+
+Issues and PRs welcome at [github.com/dennys246/Maxim](https://github.com/dennys246/Maxim).
+
+## License
+
+See [LICENSE](LICENSE) for details.