bitsandbytes-cpu-fork 0.50.2.dev0__tar.gz → 0.50.2.dev4__tar.gz

{bitsandbytes_cpu_fork-0.50.2.dev0 → bitsandbytes_cpu_fork-0.50.2.dev4}/MANIFEST.in

@@ -17,6 +17,17 @@ graft csrc
 graft build_manual
 graft docs_cpu
 graft examples
+# tools/ holds gen_api_reference.py and verify_help_examples.py, which regenerate and
+# check docs_cpu/API_REFERENCE*.md from the tables in bitsandbytes_cpu_cli.py. The
+# generated documents ARE shipped, so leaving the generators out would hand users the
+# output of scripts they cannot run.
+graft tools
+# ...but not the Windows binaries inside it. `graft tools` takes the whole directory,
+# and the four sector_*.exe disaster-recovery tools were 0.65 MB of a 1.36 MB sdist --
+# nearly half its weight, on every platform, for binaries that cannot run on two of the
+# three. Their .c sources stay in the sdist and in the repository.
+global-exclude *.exe
+global-exclude *.exe.manifest
 include build_linux.sh
 include build_termux.sh
 include selftest_cpu.c

{bitsandbytes_cpu_fork-0.50.2.dev0 → bitsandbytes_cpu_fork-0.50.2.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bitsandbytes-cpu-fork
-Version: 0.50.2.dev0
+Version: 0.50.2.dev4
 Summary: bitsandbytes with a pure-CPU training backend (AVX2 / NEON): 8-bit optimizers, fused GDN, gemm_8bit, disk balancer. No GPU required.
 License-Expression: MIT
 Project-URL: repository, https://github.com/Ganyvnanoaa09-0906/bitsandbytes-CPU
@@ -22,14 +22,100 @@ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: torch<3,>=2.4
 Requires-Dist: numpy>=1.17
 Requires-Dist: packaging>=20.9
+Requires-Dist: psutil>=5.9
 Provides-Extra: test
 Requires-Dist: pytest~=8.3; extra == "test"
-Requires-Dist: psutil>=5.9; extra == "test"
 Dynamic: license-file
 
+> **This is the CPU fork** — `bitsandbytes-cpu-fork`, not upstream `bitsandbytes`.
+> It replaces the CUDA kernels with a pure-CPU backend (AVX2 on x86-64, NEON on ARM64):
+> 8-bit optimizers, fused Gated DeltaNet, `gemm_8bit`, block-wise 4/8-bit quantisation.
+> No GPU, no CUDA toolkit, no NVIDIA driver. Full guide:
+> [`docs_cpu/QUICKSTART.md`](docs_cpu/QUICKSTART.md) (中文) ·
+> [`docs_cpu/QUICKSTART_EN.md`](docs_cpu/QUICKSTART_EN.md).
+
+## Install
+
+**`torch` is deliberately not a dependency.** On PyPI the name `torch` resolves to the
+CUDA build, so declaring it made this CPU-only library download roughly 2.5 GB of
+`nvidia-*` wheels — cublas, cudnn, nccl, nvshmem and thirteen more — onto machines with
+no NVIDIA device at all. Measured on a clean Ubuntu install. `install_requires` cannot
+express "the CPU build", because that lives on a different index, so install it first:
+
+```bash
+pip install torch --index-url https://download.pytorch.org/whl/cpu
+pip install bitsandbytes-cpu-fork
+```
+
+**Linux wheels.** This release ships two Linux x86_64 wheels: a native one
+(`manylinux_2_39`) with the OpenMP-parallel kernels, and a portable one
+(`manylinux_2_17`, single-threaded) for older distributions. pip picks the best one
+for the host automatically. If neither matches your glibc, install from the sdist
+(it compiles `csrc` with the local toolchain via `build_linux.sh`).
+
+
+### Windows
+
+A wheel is published with the CPU library already built in, so no compiler and no
+Visual C++ Redistributable are needed:
+
+```bat
+pip install bitsandbytes-cpu-fork
+```
+
+### Linux
+
+Only the source distribution is published. `pip` builds it, and `setup.py` runs
+`build_linux.sh` for you, so the library is compiled against your own glibc rather than
+shipped prebuilt. That needs a C++ compiler with OpenMP:
+
+```bash
+sudo apt install g++ libomp-dev        # Debian / Ubuntu
+sudo dnf install gcc-c++ libomp-devel  # Fedora / RHEL
+sudo pacman -S gcc openmp              # Arch
+```
+
+If the toolchain is missing the build **stops and names that command**, rather than
+producing a wheel that installs cleanly and then fails at `import bitsandbytes`.
+
+To build by hand instead, or to check the kernels without torch:
+
+```bash
+bash build_linux.sh --selftest
+```
+
+### Verify the install
+
+```bash
+python -m bitsandbytes
+```
+
+### Then ask it what it can do
+
+`pip` installs a `bitsandbytes-cpu` command (also available as `bnb-cpu`). It is the
+reference for this fork: what the hardware is, whether the kernels load, and **how to
+call every feature it adds** — each entry carries the exact call, and every Python
+example in it is executed before release.
+
+```bash
+bitsandbytes-cpu detect          # CPU model, cores, SIMD, RAM, recommended thread count
+bitsandbytes-cpu selftest        # runs a 4-bit layer, an 8-bit optimizer step, the GDN kernel
+bitsandbytes-cpu help            # the whole reference
+bitsandbytes-cpu help 8bitopt    # one section: the 8-bit optimizer
+bitsandbytes-cpu help 4bit       # one section: 4-bit layers on a CPU
+bitsandbytes-cpu help kernels    # one section: the fused kernels, called directly
+bitsandbytes-cpu doctor          # which .dll/.so will load, and which symbols it has
+```
+
+Section keys: `intro start 4bit qlora 8bitopt kernels toolkit threads memory gdn disks
+layers optim functional notes`. The same tables are published as
+[`docs_cpu/API_REFERENCE.md`](docs_cpu/API_REFERENCE.md)
+([English](docs_cpu/API_REFERENCE_EN.md)).
+
+---
+
 <p align="center"><img src="https://avatars.githubusercontent.com/u/175231607?s=200&v=4" alt=""></p>
 <h1 align="center">bitsandbytes</h1>
 <p align="center">
@@ -103,7 +189,7 @@ bitsandbytes has the following minimum requirements for all platforms:
       <td>🟥 AMD GPU <br><code>cuda</code></td>
       <td>
         CDNA: gfx908, gfx90a, gfx942, gfx950, gfx1250<br>
-        RDNA: gfx103X, gfx110X, gfx115X, gfx120X
+        RDNA: gfx101X, gfx103X, gfx110X, gfx115X, gfx120X
       </td>
       <td>✅</td>
       <td>✅</td>
@@ -168,7 +254,8 @@ bitsandbytes has the following minimum requirements for all platforms:
       <td></td>
       <td>🟥 AMD GPU <br><code>cuda</code></td>
       <td>
-        RDNA: gfx103X, gfx110X, gfx115X, gfx120X
+        CDNA: gfx908, gfx90a<br>
+        RDNA: gfx101X, gfx103X, gfx110X, gfx115X, gfx120X
       </td>
       <td>✅</td>
       <td>✅</td>
@@ -238,20 +325,18 @@ extensions make pure-CPU LoRA / quantization / diffusion training practical.
 
 ### Install (Windows, no compiler needed)
 
-The wheel bundles the prebuilt CPU kernel and its OpenMP runtime, so nothing has to
-be built after installing:
-
 ```bash
-pip install https://github.com/Ganyvnanoaa09-0906/bitsandbytes-CPU/releases/download/v0.50.2.dev0-cpu/bitsandbytes_cpu_fork-0.50.2.dev0-py3-none-win_amd64.whl
+pip install bitsandbytes-cpu-fork
 ```
 
-One wheel covers every Python 3 version on 64-bit Windows. `pip` pulls `torch` and
-`numpy` itself. The import name is unchanged, so existing code and the
-Transformers / PEFT / Diffusers integrations keep working as-is:
+The wheel bundles the prebuilt CPU kernel and its OpenMP runtime, so nothing has to
+be built after installing; `pip` pulls `torch` and `numpy` itself. One wheel covers
+every Python 3 version on 64-bit Windows. The import name is unchanged, so existing
+code and the Transformers / PEFT / Diffusers integrations keep working as-is:
 
 ```python
 import bitsandbytes as bnb          # the fork, not upstream
-print(bnb.__version__)              # 0.50.2.dev0
+print(bnb.__version__)              # 0.50.2.dev4
 ```
 
 Building from source instead (any platform) is described in