tarekziade's picture
tarekziade HF Staff
Publish MIC usage, slim fixture and reviewed Transformers expectations
f707289 verified
|
Raw History Blame Contribute Delete
3.6 kB
# Olmo 3 Instruct: next-token prediction with Transformers
This page is the Transformers contract of the Olmo 3 Instruct MIC and also a usage example. [doc-builder](https://github.com/huggingface/doc-builder/blob/main/docs/runnable-code-blocks.md) renders the `runnable` blocks below as documentation, and its pytest plugin runs them as written against `allenai/Olmo-3-7B-Instruct`. The MIC runner runs the same blocks against each slim fixture and each checkpoint in [`integration.json`](../../integration.json). Lines marked `# doc-builder: hide` only matter there: they swap in the pinned checkpoint or variant and print the result record.
## Predict the next token
```py runnable:next_token
import torch
from transformers import AutoModelForCausalLM, AutoTokenizer, set_seed
import json # doc-builder: hide
import os # doc-builder: hide
model_id = "allenai/Olmo-3-7B-Instruct"
model_id = os.environ.get("MIC_MODEL", model_id) # doc-builder: hide
model_kwargs = json.loads(os.environ.get("MIC_MODEL_KWARGS", "{}")) # doc-builder: hide
device = "cuda" if torch.cuda.is_available() else "cpu"
set_seed(0) # seeds torch, NumPy, and Python: loading, dropout, and data augmentation draw random numbers
tokenizer = AutoTokenizer.from_pretrained(model_id)
model = AutoModelForCausalLM.from_pretrained(model_id).to(device)
if model_kwargs: # doc-builder: hide
del model # doc-builder: hide
model = AutoModelForCausalLM.from_pretrained(model_id, **model_kwargs).to(device) # doc-builder: hide
messages = [
[{"role": "user", "content": "Who would win in a fight - a dinosaur or a cow named Moo Moo?"}],
[{"role": "user", "content": "Name three prime numbers."}],
]
texts = [tokenizer.apply_chat_template(m, add_generation_prompt=True, tokenize=False) for m in messages]
inputs = tokenizer(texts, return_tensors="pt", padding=True).to(device)
with torch.no_grad():
logits = model(**inputs).logits
# left padding: the last position is the next-token position for every row
next_logits = logits[:, -1, :]
next_token_ids = next_logits.argmax(dim=-1)
print(tokenizer.batch_decode(next_token_ids.unsqueeze(-1)))
```
## One training step
```py runnable:next_token:2
labels = inputs["input_ids"].clone()
labels[inputs["attention_mask"] == 0] = -100
model.train()
optimizer = torch.optim.SGD([p for p in model.parameters() if p.requires_grad], lr=0.01)
loss = model(**inputs, labels=labels).loss
loss.backward()
before = {n: p.detach().cpu().clone() for n, p in model.named_parameters() if p.requires_grad} # doc-builder: hide
optimizer.step()
print(f"loss: {loss.item():.4f}")
if os.environ.get("MIC_RUNNER"): # doc-builder: hide
named = dict(model.named_parameters())
checked = ("model.layers.0.self_attn.q_proj.weight", "model.layers.0.mlp.up_proj.weight")
result = {
"runtime": {
"device": model.device.type,
"dtype": str(model.dtype).removeprefix("torch."),
"attn_implementation": model.config._attn_implementation,
},
"next_token_ids": next_token_ids.tolist(),
"next_token_text": tokenizer.batch_decode(next_token_ids.unsqueeze(-1)),
"probe_logits": next_logits[:, :5].float().tolist(),
"training": {
"loss": loss.item(),
"gradients": {n: bool(named[n].grad is not None and torch.count_nonzero(named[n].grad) > 0 and torch.isfinite(named[n].grad).all()) for n in checked},
"updated": any(not torch.equal(p.detach().cpu(), before[n]) for n, p in model.named_parameters() if n in before),
},
}
print(json.dumps(result))
```