Instructions to use physicsrob/torchwright-doom-e1m1 with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use physicsrob/torchwright-doom-e1m1 with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-generation", model="physicsrob/torchwright-doom-e1m1")# Load model directly from transformers import AutoTokenizer, AutoModelForCausalLM tokenizer = AutoTokenizer.from_pretrained("physicsrob/torchwright-doom-e1m1") model = AutoModelForCausalLM.from_pretrained("physicsrob/torchwright-doom-e1m1", device_map="auto") - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- vLLM
How to use physicsrob/torchwright-doom-e1m1 with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "physicsrob/torchwright-doom-e1m1" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "physicsrob/torchwright-doom-e1m1", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }'Use Docker
docker model run hf.co/physicsrob/torchwright-doom-e1m1
- SGLang
How to use physicsrob/torchwright-doom-e1m1 with SGLang:
Install from pip and serve model
# Install SGLang from pip: pip install sglang # Start the SGLang server: python3 -m sglang.launch_server \ --model-path "physicsrob/torchwright-doom-e1m1" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "physicsrob/torchwright-doom-e1m1", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }'Use Docker images
docker run --gpus all \ --shm-size 32g \ -p 30000:30000 \ -v ~/.cache/huggingface:/root/.cache/huggingface \ --env "HF_TOKEN=<secret>" \ --ipc=host \ lmsysorg/sglang:latest \ python3 -m sglang.launch_server \ --model-path "physicsrob/torchwright-doom-e1m1" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "physicsrob/torchwright-doom-e1m1", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }' - Docker Model Runner
How to use physicsrob/torchwright-doom-e1m1 with Docker Model Runner:
docker model run hf.co/physicsrob/torchwright-doom-e1m1
File size: 12,361 Bytes
b9a8681 ed03dd6 b9a8681 ed03dd6 b9a8681 ed03dd6 b9a8681 ed03dd6 b9a8681 ed03dd6 b9a8681 ed03dd6 b9a8681 ed03dd6 b9a8681 ed03dd6 b9a8681 ed03dd6 b9a8681 ed03dd6 b9a8681 ed03dd6 b9a8681 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 | """The sole Doom inference program: portable stock-Hugging-Face generation.
This file is copied byte-identical to the root of every published Doom
bundle (``<bundle>/infer.py``) and executed there as a subprocess — by
anyone who downloads a bundle and by production render orchestration
(``run.py``) alike. It is executed, never imported. It intentionally
imports no TorchWright or ``torchwright_doom`` code: text enters through
the saved tokenizer, a stock ``Phi3ForCausalLM`` produces rows (a "row" is
one tokenizer id — one row of the tied embedding matrix, one sequence
position), and the only outputs are canonical integer ids plus their raw
tokenizer text. No pixels are produced here: the bundle's standalone
tools (``tools/txt_to_png.py``; token protocol in ``PROTOCOL.md`` in the
source repo) decode those ids into a frame afterward and do no inference.
The bundle manifest's schema, field meanings, and completeness gate live
in ``torchwright_doom/bundle/manifest.py`` in the source repo.
"""
from __future__ import annotations
import argparse
import hashlib
import json
import os
import time
from pathlib import Path
# Multi-shard checkpoints otherwise load serially. Keep these defaults in the
# portable program so downloaded bundles and production use the same loader.
os.environ.setdefault("HF_ENABLE_PARALLEL_LOADING", "true")
os.environ.setdefault("HF_PARALLEL_LOADING_WORKERS", "8")
import torch
import transformers
from transformers import TextGenerationPipeline, pipeline
_PROGRESS_INTERVAL_SECONDS = 15.0
def _canonical_json(value) -> bytes:
return json.dumps(value, ensure_ascii=False, separators=(",", ":")).encode("utf-8")
def _sha(data: bytes) -> str:
return hashlib.sha256(data).hexdigest()
def _cuda_devices(model) -> list[torch.device]:
return sorted(
{parameter.device for parameter in model.parameters() if parameter.is_cuda},
key=str,
)
class _ProgressStreamer:
"""Report generation throughput without changing or collecting tokens."""
def __init__(self, prompt_rows: int, max_new_tokens: int) -> None:
self.prompt_rows = prompt_rows
self.max_new_tokens = max_new_tokens
self.started = time.monotonic()
self.last_progress = self.started
self.prefill_seconds: float | None = None
self.finished: float | None = None
self.generated_rows = 0
self._saw_prompt = False
def put(self, value: torch.Tensor) -> None:
# GenerationMixin streams the complete prompt once before any emitted
# row. It is already accounted for separately in ``prompt_rows``.
if not self._saw_prompt:
self._saw_prompt = True
return
now = time.monotonic()
if self.prefill_seconds is None:
self.prefill_seconds = now - self.started
print(
f"[infer] prefill complete; rows={self.prompt_rows} "
f"elapsed={self.prefill_seconds:.1f}s",
flush=True,
)
self.generated_rows += value.numel()
if now - self.last_progress >= _PROGRESS_INTERVAL_SECONDS:
elapsed = now - self.started - self.prefill_seconds
last_row = int(value.reshape(-1)[-1])
print(
f"[infer] decode rows={self.generated_rows}/{self.max_new_tokens} "
f"total_position={self.prompt_rows + self.generated_rows} "
f"elapsed={elapsed:.1f}s "
f"rows/s={self.generated_rows / elapsed:.1f} "
f"last_row={last_row}",
flush=True,
)
self.last_progress = now
def end(self) -> None:
self.finished = time.monotonic()
@property
def decode_seconds(self) -> float:
stopped = self.finished or time.monotonic()
prefill = self.prefill_seconds or 0.0
return stopped - self.started - prefill
def main(argv: list[str] | None = None) -> int:
parser = argparse.ArgumentParser(description="Run stock Phi-3 Doom inference")
parser.add_argument("--model", type=Path)
parser.add_argument("--prompt", type=Path)
parser.add_argument("--output", type=Path, default=Path("out"))
parser.add_argument(
"--device", default="cuda" if torch.cuda.is_available() else "cpu"
)
parser.add_argument("--max-new-tokens", type=int)
args = parser.parse_args(argv)
# This file sits at the bundle root, so its own directory is the bundle.
model_dir = (args.model or Path(__file__).resolve().parent).resolve()
prompt_path = args.prompt or model_dir / "examples" / "e1m1_prompt.txt"
manifest = json.loads((model_dir / "doom_bundle_manifest.json").read_text())
if not manifest.get("validation", {}).get("complete"):
raise ValueError("Doom bundle manifest is not complete")
prompt_bytes = prompt_path.read_bytes()
prompt_sha256 = _sha(prompt_bytes)
bundled_prompt = prompt_sha256 == manifest["prompt"]["sha256"]
load_t0 = time.monotonic()
model_kwargs = {
"attn_implementation": "eager",
# Read each shard's bytes eagerly: deferring them to mmap page faults
# stalls badly on network filesystems, and eager reads are harmless on
# local disks.
"disable_mmap": True,
}
generate: TextGenerationPipeline
if args.device != "cpu":
# Accelerate builds the skeleton on meta and dispatches each shard
# directly to the target device. This avoids a second full-model
# ``model.to(cuda)`` pass through CPU-backed mmap pages.
generate = pipeline(
"text-generation",
model=str(model_dir),
dtype=torch.float32,
model_kwargs=model_kwargs,
device_map=args.device,
)
else:
generate = pipeline(
"text-generation",
model=str(model_dir),
dtype=torch.float32,
model_kwargs=model_kwargs,
)
tokenizer = generate.tokenizer
if tokenizer is None:
raise RuntimeError("text-generation pipeline loaded without a tokenizer")
model = generate.model
model.eval()
cuda_devices = _cuda_devices(model)
for cuda_device in cuda_devices:
# Reset after loading: the current allocation still includes all
# weights, while the peak will additionally capture generation cache
# and runtime workspace. This is the consumer-fit measurement.
torch.cuda.reset_peak_memory_stats(cuda_device)
attention_implementation = getattr(model.config, "_attn_implementation", None)
if attention_implementation != "eager":
# Eager is the implementation the published render was validated
# under; fused kernels change fp accumulation order, and this check
# keeps every run on the validated numerics.
raise RuntimeError(
"Doom inference requires eager attention, got "
f"{attention_implementation!r}"
)
if (
model.config.original_max_position_embeddings
!= model.config.max_position_embeddings
):
raise RuntimeError(
"default-RoPE Doom model has inconsistent original/max position "
"capacity; GenerationMixin would discard its cache at the boundary"
)
load_seconds = time.monotonic() - load_t0
prompt_text = prompt_bytes.decode("utf-8")
encoded_prompt = tokenizer(
prompt_text,
return_tensors="pt",
add_special_tokens=False,
)
input_device = next(model.parameters()).device
prompt_ids = [int(row) for row in encoded_prompt.input_ids[0].tolist()]
prompt_ids_sha256 = _sha(_canonical_json(prompt_ids))
# Only the bundled prompt has a manifest row-id expectation; a custom
# prompt is permitted, never verified, and recorded in the payload as
# matches_bundled_prompt=false.
if bundled_prompt and prompt_ids_sha256 != manifest["prompt"]["row_ids_sha256"]:
raise ValueError("bundled prompt text does not reproduce its manifest rows")
default_new = int(manifest["generation"]["max_new_tokens"])
max_new = default_new if args.max_new_tokens is None else int(args.max_new_tokens)
if max_new < 1:
raise ValueError("max-new-tokens must be >= 1")
if len(prompt_ids) + max_new > model.config.max_position_embeddings:
raise ValueError("requested generation exceeds model position capacity")
print(
f"[infer] model ready in {load_seconds:.1f}s; prompt={len(prompt_ids)} "
f"max_new_tokens={max_new} device={input_device}",
flush=True,
)
generate_t0 = time.monotonic()
progress = _ProgressStreamer(len(prompt_ids), max_new)
print(f"[infer] generation started; max_new_tokens={max_new}", flush=True)
with torch.inference_mode():
records = generate(
prompt_text,
add_special_tokens=False,
return_tensors=True,
do_sample=False,
use_cache=True,
max_new_tokens=max_new,
eos_token_id=tokenizer.eos_token_id,
pad_token_id=tokenizer.pad_token_id,
streamer=progress,
)
generate_seconds = time.monotonic() - generate_t0
sequence = records[0]["generated_token_ids"]
generated = [int(row) for row in sequence[len(prompt_ids) :]]
for cuda_device in cuda_devices:
torch.cuda.synchronize(cuda_device)
cuda_memory = [
{
"device": str(cuda_device),
"peak_allocated_bytes": torch.cuda.max_memory_allocated(cuda_device),
"peak_reserved_bytes": torch.cuda.max_memory_reserved(cuda_device),
}
for cuda_device in cuda_devices
]
prefill_seconds = progress.prefill_seconds or generate_seconds
decode_seconds = progress.decode_seconds
raw_text = tokenizer.decode(
generated, skip_special_tokens=False, clean_up_tokenization_spaces=False
)
if not isinstance(raw_text, str):
raise TypeError("tokenizer returned a batched decode for one row list")
if tokenizer(raw_text, add_special_tokens=False)["input_ids"] != generated:
raise ValueError("decoded output text does not round-trip to generated rows")
args.output.mkdir(parents=True, exist_ok=True)
emitted_ids_sha256 = _sha(_canonical_json(generated))
stopped = bool(generated and generated[-1] == tokenizer.eos_token_id)
payload = {
"format": "torchwright_doom.output_ids.v1",
"bundle": manifest.get("bundle_identity"),
"compile_payload_sha256": manifest.get("compile_payload_sha256"),
"row_vocab_fingerprint": manifest.get("row_vocab_fingerprint"),
"prompt": {
"sha256": prompt_sha256,
"matches_bundled_prompt": bundled_prompt,
"row_ids": prompt_ids,
"row_ids_sha256": prompt_ids_sha256,
},
"emitted_row_ids": generated,
"emitted_row_ids_sha256": emitted_ids_sha256,
"generation": {
"mode": "transformers_pipeline",
"max_new_tokens": max_new,
"termination_reason": "terminal" if stopped else "cap",
},
"timing_seconds": {
"load": load_seconds,
"prefill": prefill_seconds,
"decode": decode_seconds,
"generate": generate_seconds,
},
"attention_implementation": attention_implementation,
"cuda_memory": cuda_memory,
"transformers_version": transformers.__version__,
}
(args.output / "output.ids.json").write_text(
json.dumps(payload, indent=2, sort_keys=True) + "\n", encoding="utf-8"
)
(args.output / "output.txt").write_text(raw_text + "\n", encoding="utf-8")
print(
f"[infer] wrote {len(generated)} rows in {generate_seconds:.1f}s; "
f"stopped={payload['generation']['termination_reason']}",
flush=True,
)
for memory in cuda_memory:
peak_allocated = int(memory["peak_allocated_bytes"])
peak_reserved = int(memory["peak_reserved_bytes"])
print(
f"[infer] {memory['device']} peak allocated="
f"{peak_allocated / 1024**3:.2f} GiB "
f"reserved={peak_reserved / 1024**3:.2f} GiB",
flush=True,
)
return 0
if __name__ == "__main__":
raise SystemExit(main())
|