tribunal-kit 9.2.3 → 9.2.5

package/.agent/skills/huggingface-vision-trainer/scripts/sam_segmentation_training.py

@@ -0,0 +1,382 @@
+# /// script
+# dependencies = [
+#     "transformers>=5.2.0",
+#     "accelerate>=1.1.0",
+#     "datasets>=4.0",
+#     "torchvision",
+#     "monai",
+#     "trackio",
+#     "huggingface_hub",
+# ]
+# ///
+
+"""Fine-tune SAM or SAM2 for segmentation using bounding-box or point prompts with the HF Trainer API."""
+
+import json
+import logging
+import math
+import os
+import sys
+from dataclasses import dataclass, field
+from typing import Any
+
+import numpy as np
+import torch
+import torch.nn.functional as F
+from datasets import load_dataset
+from torch.utils.data import Dataset
+
+import monai
+import trackio
+
+import transformers
+from transformers import (
+    HfArgumentParser,
+    Trainer,
+    TrainingArguments,
+)
+from transformers.utils import check_min_version
+
+logger = logging.getLogger(__name__)
+
+check_min_version("4.57.0.dev0")
+
+
+# ---------------------------------------------------------------------------
+# Dataset wrapper
+# ---------------------------------------------------------------------------
+
+class SAMSegmentationDataset(Dataset):
+    """Wraps a HF dataset into the format expected by SAM/SAM2 processors.
+
+    Each sample must contain an image, a binary mask, and a prompt (bbox or
+    point).  Prompts are read from a JSON-encoded ``prompt`` column or from
+    dedicated ``bbox`` / ``point`` columns.
+    """
+
+    def __init__(self, dataset, processor, prompt_type: str,
+                 image_col: str, mask_col: str, prompt_col: str | None,
+                 bbox_col: str | None, point_col: str | None):
+        self.dataset = dataset
+        self.processor = processor
+        self.prompt_type = prompt_type
+        self.image_col = image_col
+        self.mask_col = mask_col
+        self.prompt_col = prompt_col
+        self.bbox_col = bbox_col
+        self.point_col = point_col
+
+    def __len__(self):
+        return len(self.dataset)
+
+    def _extract_prompt(self, item):
+        if self.prompt_col and self.prompt_col in item:
+            raw = item[self.prompt_col]
+            parsed = json.loads(raw) if isinstance(raw, str) else raw
+            if self.prompt_type == "bbox":
+                return parsed.get("bbox") or parsed.get("box")
+            return parsed.get("point") or parsed.get("points")
+
+        if self.prompt_type == "bbox" and self.bbox_col:
+            return item[self.bbox_col]
+        if self.prompt_type == "point" and self.point_col:
+            return item[self.point_col]
+        raise ValueError("Could not extract prompt from sample")
+
+    def __getitem__(self, idx):
+        item = self.dataset[idx]
+        image = item[self.image_col]
+        prompt = self._extract_prompt(item)
+
+        if self.prompt_type == "bbox":
+            inputs = self.processor(image, input_boxes=[[prompt]], return_tensors="pt")
+        else:
+            if isinstance(prompt[0], (int, float)):
+                prompt = [prompt]
+            inputs = self.processor(image, input_points=[[prompt]], return_tensors="pt")
+
+        mask = np.array(item[self.mask_col])
+        if mask.ndim == 3:
+            mask = mask[:, :, 0]
+        inputs["labels"] = (mask > 0).astype(np.float32)
+        inputs["original_image_size"] = torch.tensor(image.size[::-1])
+        return inputs
+
+
+def collate_fn(batch):
+    pixel_values = torch.cat([item["pixel_values"] for item in batch], dim=0)
+    original_sizes = torch.stack([item["original_sizes"] for item in batch])
+    original_image_size = torch.stack([item["original_image_size"] for item in batch])
+
+    has_boxes = "input_boxes" in batch[0]
+    has_points = "input_points" in batch[0]
+
+    labels = torch.cat(
+        [
+            F.interpolate(
+                torch.as_tensor(x["labels"]).unsqueeze(0).unsqueeze(0).float(),
+                size=(256, 256),
+                mode="nearest",
+            )
+            for x in batch
+        ],
+        dim=0,
+    ).long()
+
+    result = {
+        "pixel_values": pixel_values,
+        "original_sizes": original_sizes,
+        "labels": labels,
+        "original_image_size": original_image_size,
+        "multimask_output": False,
+    }
+
+    if has_boxes:
+        result["input_boxes"] = torch.cat([item["input_boxes"] for item in batch], dim=0)
+    if has_points:
+        result["input_points"] = torch.cat([item["input_points"] for item in batch], dim=0)
+        if "input_labels" in batch[0]:
+            result["input_labels"] = torch.cat([item["input_labels"] for item in batch], dim=0)
+
+    return result
+
+
+# ---------------------------------------------------------------------------
+# Custom loss (SAM/SAM2 don't compute loss in forward())
+# ---------------------------------------------------------------------------
+
+seg_loss = monai.losses.DiceCELoss(sigmoid=True, squared_pred=True, reduction="mean")
+
+
+def compute_loss(outputs, labels, num_items_in_batch=None):
+    predicted_masks = outputs.pred_masks.squeeze(1)
+    return seg_loss(predicted_masks, labels.float())
+
+
+# ---------------------------------------------------------------------------
+# CLI arguments
+# ---------------------------------------------------------------------------
+
+@dataclass
+class DataTrainingArguments:
+    dataset_name: str = field(
+        default="merve/MicroMat-mini",
+        metadata={"help": "Hub dataset ID."},
+    )
+    dataset_config_name: str | None = field(
+        default=None,
+        metadata={"help": "Dataset config name."},
+    )
+    train_val_split: float | None = field(
+        default=0.1,
+        metadata={"help": "Fraction to split off for validation (used when no validation split exists)."},
+    )
+    max_train_samples: int | None = field(
+        default=None,
+        metadata={"help": "Truncate training set (for quick tests)."},
+    )
+    max_eval_samples: int | None = field(
+        default=None,
+        metadata={"help": "Truncate evaluation set."},
+    )
+    image_column_name: str = field(
+        default="image",
+        metadata={"help": "Column containing PIL images."},
+    )
+    mask_column_name: str = field(
+        default="mask",
+        metadata={"help": "Column containing ground-truth binary masks."},
+    )
+    prompt_column_name: str | None = field(
+        default="prompt",
+        metadata={"help": "Column with JSON-encoded prompt (bbox/point). Set to '' to disable."},
+    )
+    bbox_column_name: str | None = field(
+        default=None,
+        metadata={"help": "Column with bbox prompt ([x0,y0,x1,y1]). Used when prompt_column_name is unset."},
+    )
+    point_column_name: str | None = field(
+        default=None,
+        metadata={"help": "Column with point prompt ([x,y] or [[x,y],...]). Used when prompt_column_name is unset."},
+    )
+    prompt_type: str = field(
+        default="bbox",
+        metadata={"help": "Prompt type: 'bbox' or 'point'."},
+    )
+
+
+@dataclass
+class ModelArguments:
+    model_name_or_path: str = field(
+        default="facebook/sam2.1-hiera-small",
+        metadata={"help": "Pretrained SAM/SAM2 model identifier."},
+    )
+    cache_dir: str | None = field(default=None, metadata={"help": "Cache directory."})
+    model_revision: str = field(default="main", metadata={"help": "Model revision."})
+    token: str | None = field(default=None, metadata={"help": "Auth token."})
+    trust_remote_code: bool = field(default=False, metadata={"help": "Trust remote code."})
+    freeze_vision_encoder: bool = field(
+        default=True,
+        metadata={"help": "Freeze vision encoder weights."},
+    )
+    freeze_prompt_encoder: bool = field(
+        default=True,
+        metadata={"help": "Freeze prompt encoder weights."},
+    )
+
+
+# ---------------------------------------------------------------------------
+# Main
+# ---------------------------------------------------------------------------
+
+def main():
+    parser = HfArgumentParser((ModelArguments, DataTrainingArguments, TrainingArguments))
+    parser.set_defaults(per_device_train_batch_size=4, num_train_epochs=30)
+    if len(sys.argv) == 2 and sys.argv[1].endswith(".json"):
+        model_args, data_args, training_args = parser.parse_json_file(
+            json_file=os.path.abspath(sys.argv[1])
+        )
+    else:
+        model_args, data_args, training_args = parser.parse_args_into_dataclasses()
+
+    from huggingface_hub import login
+    hf_token = os.environ.get("HF_TOKEN") or os.environ.get("hfjob")
+    if hf_token:
+        login(token=hf_token)
+        training_args.hub_token = hf_token
+        logger.info("Logged in to Hugging Face Hub")
+    elif training_args.push_to_hub:
+        logger.warning("HF_TOKEN not found in environment. Hub push will likely fail.")
+
+    trackio.init(project=training_args.output_dir, name=training_args.run_name)
+
+    logging.basicConfig(
+        format="%(asctime)s - %(levelname)s - %(name)s - %(message)s",
+        datefmt="%m/%d/%Y %H:%M:%S",
+        handlers=[logging.StreamHandler(sys.stdout)],
+    )
+    if training_args.should_log:
+        transformers.utils.logging.set_verbosity_info()
+
+    log_level = training_args.get_process_log_level()
+    logger.setLevel(log_level)
+    transformers.utils.logging.set_verbosity(log_level)
+    transformers.utils.logging.enable_default_handler()
+    transformers.utils.logging.enable_explicit_format()
+
+    logger.info(f"Training/evaluation parameters {training_args}")
+
+    # ---- Load dataset ----
+    dataset = load_dataset(
+        data_args.dataset_name,
+        data_args.dataset_config_name,
+        cache_dir=model_args.cache_dir,
+        trust_remote_code=model_args.trust_remote_code,
+    )
+
+    if "train" not in dataset:
+        if len(dataset.keys()) == 1:
+            only_split = list(dataset.keys())[0]
+            dataset[only_split] = dataset[only_split].shuffle(seed=training_args.seed)
+            dataset = dataset[only_split].train_test_split(test_size=data_args.train_val_split or 0.1)
+            dataset = {"train": dataset["train"], "validation": dataset["test"]}
+        else:
+            raise ValueError(f"No 'train' split found. Available: {list(dataset.keys())}")
+    elif "validation" not in dataset and "test" not in dataset:
+        dataset["train"] = dataset["train"].shuffle(seed=training_args.seed)
+        split = dataset["train"].train_test_split(
+            test_size=data_args.train_val_split or 0.1, seed=training_args.seed
+        )
+        dataset["train"] = split["train"]
+        dataset["validation"] = split["test"]
+
+    if data_args.max_train_samples is not None:
+        n = min(data_args.max_train_samples, len(dataset["train"]))
+        dataset["train"] = dataset["train"].select(range(n))
+        logger.info(f"Truncated training set to {n} samples")
+    eval_key = "validation" if "validation" in dataset else "test"
+    if data_args.max_eval_samples is not None and eval_key in dataset:
+        n = min(data_args.max_eval_samples, len(dataset[eval_key]))
+        dataset[eval_key] = dataset[eval_key].select(range(n))
+        logger.info(f"Truncated eval set to {n} samples")
+
+    # ---- Detect model family (SAM vs SAM2) and load processor/model ----
+    model_id = model_args.model_name_or_path.lower()
+    is_sam2 = "sam2" in model_id
+
+    if is_sam2:
+        from transformers import Sam2Processor, Sam2Model
+        processor = Sam2Processor.from_pretrained(model_args.model_name_or_path)
+        model = Sam2Model.from_pretrained(model_args.model_name_or_path)
+    else:
+        from transformers import SamProcessor, SamModel
+        processor = SamProcessor.from_pretrained(model_args.model_name_or_path)
+        model = SamModel.from_pretrained(model_args.model_name_or_path)
+
+    if model_args.freeze_vision_encoder:
+        for name, param in model.named_parameters():
+            if name.startswith("vision_encoder"):
+                param.requires_grad_(False)
+    if model_args.freeze_prompt_encoder:
+        for name, param in model.named_parameters():
+            if name.startswith("prompt_encoder"):
+                param.requires_grad_(False)
+
+    trainable = sum(p.numel() for p in model.parameters() if p.requires_grad)
+    total = sum(p.numel() for p in model.parameters())
+    logger.info(f"Trainable params: {trainable:,} / {total:,} ({100 * trainable / total:.1f}%)")
+
+    # ---- Build datasets ----
+    prompt_col = data_args.prompt_column_name if data_args.prompt_column_name else None
+    ds_kwargs = dict(
+        processor=processor,
+        prompt_type=data_args.prompt_type,
+        image_col=data_args.image_column_name,
+        mask_col=data_args.mask_column_name,
+        prompt_col=prompt_col,
+        bbox_col=data_args.bbox_column_name,
+        point_col=data_args.point_column_name,
+    )
+
+    train_dataset = SAMSegmentationDataset(dataset=dataset["train"], **ds_kwargs)
+    eval_dataset = None
+    if eval_key in dataset:
+        eval_dataset = SAMSegmentationDataset(dataset=dataset[eval_key], **ds_kwargs)
+
+    # ---- Train ----
+    trainer = Trainer(
+        model=model,
+        args=training_args,
+        train_dataset=train_dataset if training_args.do_train else None,
+        eval_dataset=eval_dataset if training_args.do_eval else None,
+        data_collator=collate_fn,
+        compute_loss_func=compute_loss,
+    )
+
+    if training_args.do_train:
+        train_result = trainer.train(resume_from_checkpoint=training_args.resume_from_checkpoint)
+        trainer.save_model()
+        trainer.log_metrics("train", train_result.metrics)
+        trainer.save_metrics("train", train_result.metrics)
+        trainer.save_state()
+
+    if training_args.do_eval and eval_dataset is not None:
+        metrics = trainer.evaluate()
+        trainer.log_metrics("eval", metrics)
+        trainer.save_metrics("eval", metrics)
+
+    trackio.finish()
+
+    kwargs = {
+        "finetuned_from": model_args.model_name_or_path,
+        "dataset": data_args.dataset_name,
+        "tags": ["image-segmentation", "vision", "sam"],
+    }
+    if training_args.push_to_hub:
+        trainer.push_to_hub(**kwargs)
+    else:
+        trainer.create_model_card(**kwargs)
+
+
+if __name__ == "__main__":
+    main()

package/.agent/skills/huggingface-zerogpu/SKILL.md

@@ -0,0 +1,289 @@
+---
+name: huggingface-zerogpu
+description: AI demos and GPU compute with Gradio Spaces and Hugging Face Spaces ZeroGPU. Use when writing or reviewing code that uses `@spaces.GPU`, configuring `python_version` or `requirements.txt` for a ZeroGPU Space, or handling ZeroGPU-specific code constraints — pickle-based process isolation, `gr.State` semantics across the worker boundary, no `torch.compile` (use AoTI instead), CUDA wheel-only builds (no `nvcc` at build or runtime), large vs xlarge sizing, and dynamic duration callables. Make sure to use this skill whenever the user mentions ZeroGPU, `@spaces.GPU`, or the `spaces` Python package, or hits ZeroGPU-specific code errors like `PicklingError` across the worker boundary, `illegal duration`, or `flash-attn` wheel-build failures — even when the user does not explicitly ask for ZeroGPU coding guidance. Trigger on `import spaces` or `@spaces.GPU` in code.
+---
+
+# Hugging Face ZeroGPU
+
+Rules and patterns for ML demos on Hugging Face Spaces with **ZeroGPU** hardware. Covers `@spaces.GPU`, duration and quota tuning, process isolation, the CUDA availability model, concurrency safety, and CUDA build constraints.
+
+## Scope
+
+This skill is for **Gradio SDK Spaces using ZeroGPU hardware**. Docker and Static Spaces cannot schedule onto ZeroGPU, and Streamlit apps now run as Docker Spaces — so this skill applies only to Gradio. For general Gradio coding (components, layouts, event listeners), see the `huggingface-gradio` skill in this repo. The authoritative ZeroGPU docs live at https://huggingface.co/docs/hub/spaces-zerogpu — refer to them for the current backing GPU, runtime version lists, and tier thresholds, all of which change over time.
+
+## Reference Files
+
+| Reference | When to read |
+|-----------|--------------|
+| `references/concurrency.md` | Always read alongside SKILL.md when writing ZeroGPU code — handlers run in parallel by default |
+| `references/how-zerogpu-works.md` | When reasoning about cold-starts, worker reuse, why module-scope warmup does not carry to requests, or why returning CUDA tensors hangs |
+| `references/how-quota-works.md` | When choosing `duration` values, debugging `illegal duration` vs `quota exceeded` errors, or explaining why default 60s blocks short tasks |
+| `references/cuda-and-deps.md` | When installing CUDA-dependent packages (e.g. `flash-attn`), pinning torch side-cars, or reading wheel filename tags |
+
+## Hardware
+
+ZeroGPU exposes two GPU sizes that map to a fraction of the backing card:
+
+| `size` | Slice of backing GPU | Quota cost |
+|--------|----------------------|------------|
+| `large` *(default)* | Half | 1x |
+| `xlarge` | Full | 2x |
+
+Default `large` gives half a physical GPU, so memory bandwidth and compute are significantly lower than the full card's specs. Use `xlarge` only when the workload genuinely needs the extra memory or compute.
+
+> **Backing GPU changes without notice.** ZeroGPU has already migrated across GPU generations several times; older write-ups may name A100 or H200, but those are outdated. For the current backing GPU and exact per-size VRAM, always check the [ZeroGPU docs](https://huggingface.co/docs/hub/spaces-zerogpu) before sizing workloads.
+
+## Basic Pattern
+
+```python
+import spaces
+import torch
+from transformers import pipeline
+
+pipe = pipeline("text-generation", model="...", device="cuda")
+
+@spaces.GPU
+def generate(prompt: str) -> str:
+    return pipe(prompt, max_new_tokens=100)[0]["generated_text"]
+```
+
+Key rules:
+
+1. **Instantiate models at module scope** and call `.to("cuda")` eagerly. ZeroGPU handles the actual device mapping transparently (see CUDA availability model below).
+2. **Decorate GPU functions with `@spaces.GPU`**. The decorator is a no-op outside ZeroGPU, so it is safe to keep in all environments.
+3. **Set `duration` to match the realistic worst-case workload** (default 60s). The platform pre-checks `requested duration` against the user's `remaining quota` — not against the actual run time — so a 10-second task left at the 60s default fails with `quota exceeded` as soon as the user's remaining quota drops below 60s. Smaller declared `duration` also ranks higher in the node-level queue. See "Duration and Quota" below.
+4. **`torch.compile` is NOT supported.** Use PyTorch [ahead-of-time compilation (AoTI)](https://huggingface.co/blog/zerogpu-aoti) (torch 2.8+) instead.
+5. **Use `size="xlarge"` sparingly.** It allocates the full backing GPU, but costs 2x quota and tends to queue longer.
+
+```python
+@spaces.GPU(duration=120)
+def generate_image(prompt: str):
+    return pipe(prompt).images[0]
+```
+
+## CUDA Availability Model
+
+Real GPU access is **only** available inside `@spaces.GPU`-decorated functions. Outside those functions, the GPU is not attached to the process.
+
+However, `import spaces` **monkey-patches `torch`** so that:
+
+- `torch.cuda.is_available()` returns `True` globally.
+- `.to("cuda")` / `device="cuda"` calls at module scope succeed without error.
+
+This is intentional. Module-scope `model.to("cuda")` calls register tensors with the ZeroGPU backend, which writes them to a disk offload directory at a startup "pack" step and frees the corresponding RAM. When a `@spaces.GPU` call lands, a forked GPU worker process streams those weights from disk into VRAM via a pinned-memory pipeline. Warm workers (reused across requests on the same GPU slot) keep weights resident on the GPU and skip the disk → VRAM step. The user-facing rule: write `device="cuda"` at module scope and it works — see `references/how-zerogpu-works.md` for the full lifecycle.
+
+| Action | Where | Why |
+|--------|-------|-----|
+| `model.to("cuda")` / `pipe(..., device="cuda")` | **Module scope** | ZeroGPU registers the tensor and manages device migration |
+| Actual CUDA computation (inference, etc.) | **Inside `@spaces.GPU`** | Real GPU is only attached during the decorated call |
+| Branching on `torch.cuda.is_available()` | Avoid relying on it | Always returns `True` due to the monkey-patch |
+
+Do not run inference or CUDA kernels at module scope — the real GPU is not attached, so operations either silently run on CPU or fail.
+
+### Device selection idiom still works
+
+The standard idiom remains correct under ZeroGPU:
+
+```python
+device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
+model = AutoModel.from_pretrained("...").to(device)
+```
+
+- **ZeroGPU** — `is_available()` is `True` (monkey-patched), so the model is registered for automatic device migration.
+- **Dedicated GPU Spaces / local GPU** — `is_available()` is genuinely `True`.
+- **CPU Spaces / local CPU** — resolves to `"cpu"`.
+
+Do not hardcode `device="cuda"` — it breaks on CPU-only environments.
+
+### Eager loading is the right default
+
+Load models at module scope, not lazily on first request. The Space process starts before any user arrives, so cold-start cost is paid once. Lazy loading (`global model; if model is None: ...`, `@lru_cache` wrappers, factory functions instantiating on first call) just pushes that cost onto the first user.
+
+## Local Development: Just Install `spaces`
+
+Do **not** wrap `import spaces` in `try/except` and redefine `spaces.GPU` as a no-op fallback for local runs. Off-ZeroGPU, the `spaces` package is already a true no-op:
+
+- Heavyweight behavior (CUDA monkey-patching, client init, startup hooks) is gated on the `SPACES_ZERO_GPU` env var, set only on ZeroGPU.
+- `@spaces.GPU` returns the undecorated function unchanged off-ZeroGPU.
+- Top-level `import spaces` performs only lightweight imports.
+
+The Gradio SDK base image installs `spaces` on every hardware tier. So even after duplicating a Space onto a dedicated GPU (T4, L4, A10G, etc.) or CPU basic, no code changes are needed — `import spaces` still succeeds and `@spaces.GPU` becomes a transparent passthrough.
+
+### Anti-pattern
+
+```python
+try:
+    import spaces
+except ImportError:
+    class spaces:  # type: ignore
+        @staticmethod
+        def GPU(func=None, **kwargs):
+            return func if func else (lambda f: f)
+```
+
+Problems:
+
+1. The fallback must mimic every `@spaces.GPU` call shape — bare decorator, `duration=...`, `size=...`, generators, `aoti_*` helpers — and drifts as the `spaces` API grows.
+2. It hides `spaces` from `requirements.txt`, even though the Space needs it at deploy time.
+3. It solves a non-problem: the real package is already a no-op locally.
+
+### Do this instead
+
+Add `spaces` to dependencies and import it unconditionally:
+
+```python
+import spaces
+
+@spaces.GPU
+def generate(prompt: str) -> str:
+    ...
+```
+
+## Duration and Quota
+
+Three things happen when you declare `@spaces.GPU(duration=N)`:
+
+1. **Tier-max check** — each visitor tier has a per-call `duration` cap. Declaring `duration` larger than the cap fails immediately with `ZeroGPU illegal duration`, regardless of remaining quota. (Tier numbers change over time — see the [ZeroGPU docs](https://huggingface.co/docs/hub/spaces-zerogpu).)
+2. **Quota pre-check** — the platform compares `requested duration` against the user's `remaining quota`. If `remaining < requested`, the call fails with `ZeroGPU quota exceeded` — even if the actual work would have fit. The error message shows the explicit numbers, e.g. `"60s requested vs. 30s left"`. A 10-second task left at the default 60s therefore blocks the user once their remaining quota drops below 60s.
+3. **Queue priority** — the queue is node-level (requests from all Spaces on the same node compete for GPU slots), and shorter declared `duration` ranks higher.
+
+All three favor declaring the smallest realistic `duration` — including for short tasks. Explicit `@spaces.GPU(duration=15)` on a 10-second task avoids premature `quota exceeded` rejections and ranks higher in the queue.
+
+> **`xlarge` doubles the request.** `requested = N * 2` when `size="xlarge"`, both for the tier-max check and the quota pre-check. So `@spaces.GPU(duration=60, size="xlarge")` is internally a 120s request.
+
+### Dynamic duration for variable workloads
+
+For workloads whose runtime depends on inputs, pass a callable that estimates per request. A static high `duration` locks out low-tier users (whose tier cap may be smaller than the static value) and unnecessarily reserves quota for light inputs.
+
+```python
+def estimate_duration(prompt, steps):
+    return int(steps * 3.5)
+
+@spaces.GPU(duration=estimate_duration)
+def generate(prompt, steps):
+    return pipe(prompt, num_inference_steps=steps).images[0]
+```
+
+For the full distinction between `illegal duration` vs `quota exceeded`, runs-per-day limits, the 24h quota window, and pay-as-you-go billing, see `references/how-quota-works.md`.
+
+## Process Isolation and Pickle
+
+`@spaces.GPU`-decorated functions run in a **separate process** managed by the ZeroGPU scheduler. Arguments and return values cross the process boundary via **pickle serialization**.
+
+Consequences:
+
+- **Only picklable objects** can be passed in or returned. Open file handles, database connections, locks, lambdas, and closures over unpicklable state will raise `PicklingError`.
+- **Do NOT return CUDA tensors directly.** Unpickling a CUDA tensor in the main process triggers `torch.cuda._lazy_init()`, which ZeroGPU blocks. Convert to CPU first: return `tensor.cpu()` or `tensor.cpu().numpy()`.
+- CPU tensors, numpy arrays, PIL Images, and plain Python objects work fine.
+- Large objects incur serialization overhead. Prefer lightweight returns (tensors, arrays, file paths, base64 strings) over complex object graphs.
+
+### `gr.State` semantics across the boundary
+
+Because handlers run in a separate process, `gr.State` values are **pickled on every yield** — they are NOT shared by reference.
+
+- The generator receives a **copy** of the state (`id()` differs from the caller's).
+- In-place mutations inside the generator are **invisible** to other handlers until the mutated state is explicitly yielded back.
+- Yielding `gr.update()` for a `gr.State` slot **skips the update** — other handlers continue to see the pre-yield value.
+- Each yield that returns the state object creates a **new copy** via pickle.
+
+Practical guidance:
+
+- **Do NOT assume reference semantics for `gr.State`** on ZeroGPU. Code that mutates state in a generator and expects another handler to see those mutations will silently use stale data.
+- **Every yield including a `gr.State` value triggers a full pickle round-trip.** For large state (model sessions, frame buffers), minimize how often you yield it — ideally once at the end. Use `gr.update()` for the state slot on intermediate yields.
+- **CUDA tensors inside state must be moved to CPU before yielding** — same `torch.cuda._lazy_init()` issue as above.
+
+## Concurrency
+
+Handlers run **concurrently by default** on ZeroGPU. This is not opt-in. Code that worked in single-user testing can silently corrupt or leak data in production.
+
+Three rules. Full treatment with examples in `references/concurrency.md`.
+
+1. **No mutable global state.** Concurrent requests overwrite each other.
+2. **No fixed file paths for outputs.** Concurrent requests clobber the same file. Use `tempfile` for unique paths.
+3. **Read-only globals are safe.** Model objects, tokenizers, configs loaded once at startup and only read during requests are safe and encouraged.
+
+## Call Granularity
+
+Each entry into a `@spaces.GPU` function carries non-trivial cost — pickle round-trip across the process boundary, worker warm-up, CUDA re-attach, and a fresh pass through the node-level queue. Calling a decorated function from inside a hot loop multiplies these costs and adds a new failure mode: a later iteration may fail to acquire a GPU slot, stalling the whole job mid-way.
+
+Decorate the outer function that owns the loop, not the per-iteration worker:
+
+```python
+# Avoid — N GPU entries for N frames
+def process_video(frames):
+    return [process_frame(f) for f in frames]
+
+@spaces.GPU(duration=...)
+def process_frame(frame):
+    ...
+
+# Prefer — one GPU entry for the whole video
+@spaces.GPU(duration=...)
+def process_video(frames):
+    return [process_frame(f) for f in frames]
+
+def process_frame(frame):
+    ...
+```
+
+If the loop mixes heavy CPU work with GPU work, wrapping the whole loop charges that CPU time against the user's quota. When that cost is material, batching the GPU work so CPU pre/post-processing stays outside the decorator is a situational optimization — not the default.
+
+## CUDA Build Constraints
+
+HF Spaces builds Docker images in a CPU-only environment. **On ZeroGPU, the build phase has no `nvcc`** because the base image is `python:3.13` (dedicated-GPU Spaces use `nvidia/cuda:*-devel-*` and have `nvcc` at build time). A CUDA-dependent package whose only distribution is sdist — e.g. bare `flash-attn` — therefore cannot be installed via `requirements.txt` on ZeroGPU. Only pre-built wheels work.
+
+ZeroGPU **runtime** does have `nvcc` available, mounted from a CUDA devel image at `/cuda-image` since 2025-07 (originally added for AoTI support). This is what makes `torch.export` / AoTI workflows possible inside `@spaces.GPU` calls.
+
+**Bottom line**: install every CUDA-dependent package from a pre-built wheel. If no wheel is available on PyPI, build one externally (e.g. host on HF Hub) and pin the URL. For `flash-attn`, the upstream releases page ships a fairly complete wheel matrix covering most Python × CUDA × torch combinations.
+
+For wheel-tag reading (cxx11 ABI, `cu12torch2.X`, `cp3XX`), torch-family side-car drift, and the kernels-community fallback, see `references/cuda-and-deps.md`.
+
+## Example Caching
+
+`gr.Examples` behavior is environment-dependent. On ZeroGPU specifically:
+
+- `cache_examples` defaults to `True` (Spaces sets `GRADIO_CACHE_EXAMPLES=true`).
+- `cache_mode` defaults to `"lazy"` (Spaces sets `GRADIO_CACHE_MODE=lazy` only on ZeroGPU).
+
+ZeroGPU defaults to `lazy` because eager caching pre-runs every example at app startup, but ZeroGPU has **no GPU attached at startup** — only during request handling. Eager caching of GPU-bound examples would fail there.
+
+When `cache_examples=True`, the `run_on_click` / `run_examples_on_click` parameter is silently ignored. If your app relies on click-populates-only behavior, set `cache_examples=False` explicitly to preserve it.
+
+To reproduce ZeroGPU example-caching behavior locally:
+
+```bash
+GRADIO_CACHE_EXAMPLES=true GRADIO_CACHE_MODE=lazy python app.py
+```
+
+## Dependency Management
+
+### `python_version` pin in README frontmatter
+
+Pinning `python_version` is **effectively required** for ZeroGPU. The runtime default is currently Python 3.10, so a local environment using 3.11+ will fail to install on the Space without an explicit pin. Pin to a ZeroGPU-supported version (3.12 is a reasonable default); the authoritative supported list lives in the [ZeroGPU docs](https://huggingface.co/docs/hub/spaces-zerogpu) — do not hardcode the full list, refer to the docs.
+
+```yaml
+# README.md frontmatter
+python_version: "3.12"
+```
+
+Both `"3.12"` and `"3.12.12"` forms are accepted.
+
+### Do not pin `spaces` in `requirements.txt`
+
+The Space platform pins its own `spaces` version. A conflicting pin in `requirements.txt` causes pip resolution to fail at build time.
+
+> **Rule**: Do not include `spaces` in `requirements.txt`.
+
+How to achieve this depends on your tooling:
+
+- **Hand-written `requirements.txt`**: simply omit `spaces`.
+- **uv** (`pyproject.toml`-managed): declare `spaces` in `pyproject.toml` so uv co-resolves transitive constraints (notably `psutil`, which `spaces` pins), then exclude it from the export:
+  ```bash
+  uv export --no-hashes --no-dev --no-emit-package spaces -o requirements.txt
+  ```
+  Without `spaces` in `pyproject.toml`, uv cannot see its transitive constraints and may resolve incompatible versions at build time.
+- **pip-tools** (`pip-compile`) / **Poetry**: use the equivalent exclude mechanism.
+
+### Pin `torch` to match wheel tags
+
+If you install a CUDA-dependent wheel via direct URL, the wheel filename encodes the `torch` major.minor it was built against (e.g. `cu12torch2.8`). Pin `torch==X.Y.Z` in `requirements.txt` to match — otherwise pip may resolve `torch` to a different version and the Space fails on first import. Details and the kernels-community alternative are in `references/cuda-and-deps.md`.