Merge pull request #4 from FujitsuResearch/feature/pypi

v1.0.1: Move matplotlib to visualize extra and lazy import

Author: FKKimura

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change log
 
+## [v1.0.1] 2026-03-31
+
+### Packaging
+
+- Moved `matplotlib` from `dev` extra to new `visualize` extra in `pyproject.toml`
+- Made `visualize_bit_assignment` import lazy in `onecomp/quantizer/autobit/__init__.py` to avoid requiring matplotlib at import time
+- Updated installation instructions in `README.md` and `docs/getting-started/installation.md` to reflect the new `visualize` extra
+- Updated `uv.lock`
+
 ## [v1.0.0] 2026-03-31
 
 ### PyPI Publishing Setup

README.md

@@ -89,9 +89,9 @@ With its Rust-based dependency resolver and the `uv.lock` lockfile, uv provides
 # install uv (for macOS or Linux)
 curl -LsSf https://astral.sh/uv/install.sh | sh
 
-git clone <git repository URL>
+git clone https://github.com/FujitsuResearch/OneCompression.git
 cd OneCompression
-uv sync --extra cu128 --extra dev
+uv sync --extra cu128 --extra dev --extra visualize
 ```
 
 The `uv sync` command creates a Python virtual environment and installs all dependent libraries.
@@ -100,12 +100,13 @@ The `--extra cu128` option installs the CUDA-enabled version of PyTorch (along w
 Replace `cu128` with the appropriate variant for your environment: `cpu`, `cu118`, `cu121`, `cu124`, `cu126`, or `cu128`.
 PyTorch will be automatically downloaded by `uv`, so you do not need to install it beforehand.
 
-Adding `--extra dev` installs additional packages for development.
+Adding `--extra dev` installs development tools (black, pytest, pylint).
+Adding `--extra visualize` installs matplotlib for visualization features.
 
 To use vLLM for serving quantized models, add `--extra vllm`:
 
 ```bash
-uv sync --extra cu128 --extra dev --extra vllm
+uv sync --extra cu128 --extra dev --extra visualize --extra vllm
 ```
 
 > **Note:** `--extra vllm` may take a long time on the first run if a pre-built `xformers` wheel is not available for your Python/CUDA combination (e.g. Python 3.13). Using Python 3.12 typically avoids this.

docs/getting-started/installation.md

@@ -67,7 +67,13 @@ print(torch.cuda.is_available())
 ### Step 2: Install OneComp
 
 ```bash
-pip install git+https://github.com/FujitsuResearch/OneCompression.git
+pip install onecomp
+```
+
+To enable visualization features (matplotlib), install with the `visualize` extra:
+
+```bash
+pip install onecomp[visualize]
 ```
 
 ## For Developers (uv -- recommended)
@@ -82,18 +88,19 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
 # Clone and set up
 git clone https://github.com/FujitsuResearch/OneCompression.git
 cd OneCompression
-uv sync --extra cu128 --extra dev
+uv sync --extra cu128 --extra dev --extra visualize
 ```
 
 The `uv sync` command creates a virtual environment and installs all dependencies (including `torchvision` from the same CUDA index as PyTorch).
 Replace `cu128` with the appropriate CUDA variant for your system: `cpu`, `cu118`, `cu121`, `cu124`, `cu126`, or `cu128`.
 
-Adding `--extra dev` installs development tools (black, pytest, pylint, matplotlib).
+Adding `--extra dev` installs development tools (black, pytest, pylint).
+Adding `--extra visualize` installs matplotlib for visualization features.
 
 To use vLLM for serving quantized models, add `--extra vllm`:
 
 ```bash
-uv sync --extra cu128 --extra dev --extra vllm
+uv sync --extra cu128 --extra dev --extra visualize --extra vllm
 ```
 
 !!! warning

onecomp/__version__.py

@@ -6,4 +6,4 @@
 
 """
 
-__version__ = "1.0.0"
+__version__ = "1.0.1"

onecomp/quantizer/autobit/__init__.py

@@ -7,7 +7,6 @@
 """
 
 from ._autobit import AutoBitQuantizer, AssignmentStrategy
-from .visualize import visualize_bit_assignment
 from .ilp import assign_by_ilp
 from .manual import assign_manually
 from .dbf_fallback import inject_dbf

pyproject.toml

@@ -54,10 +54,12 @@ cu126 = ["torch", "torchvision"]
 cu128 = ["torch", "torchvision"]
 dev = [
     "black",
-    "matplotlib>=3.10.8",
     "pylint",
     "pytest",
 ]
+visualize = [
+    "matplotlib>=3.10.8",
+]
 vllm = ["vllm"]
 docs = [
     "mkdocs-material",