rabbitllm 1.0.0__tar.gz

rabbitllm-1.0.0/.dockerignore

@@ -0,0 +1,33 @@
+# Git and IDE
+.git
+.gitignore
+.cursor
+*.md
+!README.md
+
+# Python
+__pycache__
+*.py[cod]
+*$py.class
+*.so
+.venv
+venv
+env
+.pytest_cache
+.mypy_cache
+.ruff_cache
+*.egg-info
+.eggs
+
+# Cache and local data
+.cache
+*.lock
+uv.lock
+
+# Docs/plans (optional; uncomment to keep in image)
+# .cursor/plans
+# docs
+# PLAN.md
+
+# Tests (keep if you want to run tests in container)
+# src/tests

rabbitllm-1.0.0/.github/FUNDING.yml

@@ -0,0 +1 @@
+buy_me_a_coffee: l5gr4mn

rabbitllm-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI
+
+on:
+  push:
+    branches: [master, main]
+  pull_request:
+    branches: [master, main]
+
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set Python
+        uses: astral-sh/setup-uv@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Lint (ruff check)
+        run: uv run ruff check src/ tests/
+
+      - name: Format check (ruff format)
+        run: uv run ruff format --check src/ tests/
+
+      - name: Tests
+        run: uv run pytest tests/ -v

rabbitllm-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,42 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          python-version: "3.12"
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload dist artefacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # required for OIDC trusted publishing
+    steps:
+      - name: Download dist artefacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

rabbitllm-1.0.0/.gitignore

@@ -0,0 +1,53 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Environments
+.env
+.venv
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Type checker / linter caches
+.mypy_cache/
+.ruff_cache/
+
+# IDE specific files
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Local model cache (downloads and split layers) — do not commit
+models/
+.models/

rabbitllm-1.0.0/.python-version

@@ -0,0 +1 @@
+3.12

rabbitllm-1.0.0/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to RabbitLLM are documented here.
+
+## [1.0.0] — 2026-02-21
+
+Initial release of **RabbitLLM** — a complete rewrite and rebrand of the layer-streaming inference engine.
+
+### Added
+- Layer-streaming inference engine: runs 70B+ models on 4GB VRAM without quantization
+- `AutoModel.from_pretrained()` — auto-detects architecture from HuggingFace config
+- Optional 4-bit/8-bit block-wise compression via bitsandbytes (up to 3× speed-up)
+- Async CPU→GPU transfer pipeline to overlap layer loading with compute
+- KV cache support (`DynamicCache`) for incremental decoding
+- Flash Attention 2 auto-detection (`attn_implementation="auto"`)
+- macOS / Apple Silicon support via MLX (`RabbitLLMLlamaMlx`)
+- Supported architectures: Llama 2/3/3.1/3.2, Qwen v1/2/2.5/3, Mistral, Mixtral, ChatGLM, Baichuan, InternLM, Gemma 2/3, DeepSeek V2/V3, Phi 2/3/4
+- `src/` layout with `pyproject.toml`, `uv` packaging, `ruff`, `mypy`, `pytest`
+- GitHub Actions CI across Python 3.10 / 3.11 / 3.12
+- Technical documentation: `ARCHITECTURE.md`, `COMPATIBILITY.md`, `TROUBLESHOOTING.md`
+- `scripts/`: inference examples, benchmark, attention checker, profiling
+
+### Notes
+- Requires Python ≥ 3.10, PyTorch ≥ 2.5, transformers 5.0–5.2
+- For Qwen2/Qwen2.5, use transformers 5.0.x; 5.1+ has a known RoPE head_dim issue (see `docs/COMPATIBILITY.md`)

rabbitllm-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,151 @@
+# Contributing to RabbitLLM
+
+Thank you for your interest in contributing. This document explains how to set up
+the development environment, run tests, and add support for new models.
+
+## Development setup
+
+RabbitLLM uses [uv](https://docs.astral.sh/uv/) as the package manager.
+
+```bash
+# Install uv (if not already installed)
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Clone the repository
+git clone https://github.com/manuelslemos/rabbitllm
+cd rabbitllm
+
+# Install all dependencies including dev tools
+uv sync --extra dev
+# or: make install
+```
+
+This creates a virtual environment at `.venv/` with ruff, mypy, pytest, and pytest-cov.
+
+## Running tests
+
+```bash
+# All tests (skips GPU-only compression test)
+make test
+# or: uv run pytest tests/
+
+# With coverage report
+make test-cov
+# or: uv run pytest tests/ --cov=rabbitllm --cov-report=term-missing
+
+# Single test module
+uv run python -m unittest tests.test_model_registry
+
+# GPU tests (requires CUDA)
+uv run pytest tests/test_compression.py
+```
+
+Most tests run without a GPU. The compression test (`test_compression.py`) requires CUDA
+and is skipped automatically in CI.
+
+## Code style
+
+RabbitLLM uses [ruff](https://docs.astral.sh/ruff/) for linting and formatting.
+
+```bash
+make lint      # ruff check
+make format    # ruff format
+make typecheck # mypy
+```
+
+Line length is 100 characters. Imports are sorted (isort via ruff). Type hints are
+required on all public APIs.
+
+## Project structure
+
+```
+src/rabbitllm/
+├── engine/          # Core layer-streaming engine
+│   ├── base.py          # RabbitLLMBaseModel — the main class
+│   ├── attention.py     # Attention implementation resolution
+│   ├── model_init.py    # Model skeleton creation
+│   ├── layer_loading.py # Layer I/O and async transfer
+│   ├── forward_utils.py # Attention mask, position ids, KV extraction
+│   └── mlx_engine.py    # macOS/MLX implementation
+├── models/          # Architecture-specific subclasses
+│   ├── registry.py      # AutoModel factory
+│   ├── llama.py         # Llama2/3, Gemma, Phi, DeepSeek
+│   ├── qwen.py          # Qwen v1
+│   ├── qwen2.py         # Qwen2/2.5/3
+│   ├── mistral.py       # Mistral
+│   ├── mixtral.py       # Mixtral
+│   ├── chatglm.py       # ChatGLM
+│   ├── baichuan.py      # Baichuan
+│   └── internlm.py      # InternLM
+├── persist/         # Layer serialization (safetensors / mlx)
+├── utils/           # Splitting, compression, memory, platform
+├── compat/          # Tokenizer compatibility shims
+└── profiler.py      # Per-layer timing
+```
+
+## Adding a new model
+
+1. **Check if the existing Llama-based class works.** Many Llama-like architectures
+   (Gemma, Phi, DeepSeek) share the same layer naming convention and work without a
+   dedicated subclass. Try `AutoModel.from_pretrained("your/model")` first.
+
+2. **Create a subclass** if the architecture uses different layer names:
+
+   ```python
+   # src/rabbitllm/models/mymodel.py
+   from ..engine.base import RabbitLLMBaseModel
+
+   class RabbitLLMMyModel(RabbitLLMBaseModel):
+       def set_layer_names_dict(self) -> None:
+           self.layer_names_dict = {
+               "embed": "transformer.wte",      # embedding layer
+               "layer_prefix": "transformer.h", # decoder layers
+               "norm": "transformer.ln_f",      # final norm
+               "lm_head": "lm_head",            # language model head
+           }
+   ```
+
+3. **Register the architecture** in `src/rabbitllm/models/registry.py`:
+
+   ```python
+   if "MyModelForCausalLM" in arch:
+       return "rabbitllm.models.mymodel", "RabbitLLMMyModel"
+   ```
+
+   Check the model's `config.json` on HuggingFace to find the exact `architectures` value.
+
+4. **Export the class** in `src/rabbitllm/__init__.py`:
+
+   ```python
+   from .models.mymodel import RabbitLLMMyModel
+   ```
+
+5. **Add a test** in `tests/test_model_registry.py`:
+
+   ```python
+   "org/my-model": "RabbitLLMMyModel",
+   ```
+
+6. **Verify with a small model** (e.g. 1B–7B parameter variant):
+
+   ```python
+   from rabbitllm import AutoModel
+   model = AutoModel.from_pretrained("org/my-model-7b")
+   out = model.generate(model.tokenizer(["Hello"], return_tensors="pt")["input_ids"].cuda(), max_new_tokens=10)
+   print(model.tokenizer.decode(out.sequences[0]))
+   ```
+
+## Submitting a pull request
+
+- Open an issue first for large changes to discuss the approach.
+- Include tests for any new functionality.
+- Run `make lint && make test` before opening the PR.
+- Keep PRs focused; one feature or fix per PR.
+
+## Reporting issues
+
+Please include:
+- Python version, PyTorch version, transformers version
+- GPU model and VRAM (if applicable)
+- The model repo ID being used
+- Full traceback

rabbitllm-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 [yyyy] [name of copyright owner]
+
+   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.

rabbitllm-1.0.0/Makefile

@@ -0,0 +1,27 @@
+.PHONY: install dev lint format test test-cov typecheck clean bash
+
+install:
+	uv sync
+
+dev: install
+
+lint:
+	uv run ruff check src/ tests/
+
+format:
+	uv run ruff format src/ tests/
+
+test:
+	uv run pytest tests/
+
+test-cov:
+	uv run pytest tests/ --cov=rabbitllm --cov-report=term-missing
+
+typecheck:
+	uv run mypy src/rabbitllm/ --ignore-missing-imports
+
+clean:
+	rm -rf build/ dist/ *.egg-info .pytest_cache .ruff_cache .mypy_cache htmlcov/ .coverage .coverage.*
+
+bash:
+	docker run --gpus all --rm -it -v $(PWD):/app -w /app python:3.12 bash