tarekziade HF Staff
Publish MIC usage, slim fixture and reviewed Transformers expectations
1a76047 verified | # BEiT: image classification with Transformers | |
| This page is the Transformers contract of the BEiT 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 `microsoft/beit-base-patch16-224`. 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 class of an image | |
| ```py runnable:image_classification | |
| import torch | |
| from transformers import AutoImageProcessor, AutoModelForImageClassification, set_seed | |
| import json # doc-builder: hide | |
| import os # doc-builder: hide | |
| model_id = "microsoft/beit-base-patch16-224" | |
| model_id = os.environ.get("MIC_MODEL", model_id) # doc-builder: hide | |
| variant = 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 | |
| processor = AutoImageProcessor.from_pretrained(model_id) | |
| model = AutoModelForImageClassification.from_pretrained(model_id).to(device) | |
| if variant: # doc-builder: hide | |
| del model # doc-builder: hide | |
| model = AutoModelForImageClassification.from_pretrained(model_id, **variant).to(device) # doc-builder: hide | |
| # Two synthetic images that differ in colour, so batch perturbation is meaningful. | |
| tint = torch.tensor([[0.9, 0.2, 0.1], [0.1, 0.3, 0.9]]).view(2, 3, 1, 1) | |
| images = list(((0.7 * tint + 0.3 * torch.rand(2, 3, 224, 224)).clamp(0, 1) * 255).byte()) | |
| inputs = processor(images=images, return_tensors="pt") | |
| inputs = inputs.to(device, dtype=model.dtype) | |
| with torch.no_grad(): | |
| outputs = model(**inputs) | |
| logits = outputs.logits | |
| predicted_class = logits.argmax(-1).tolist() | |
| print("Predicted classes:", [model.config.id2label[i] for i in predicted_class]) | |
| ``` | |
| ## One training step | |
| ```py runnable:image_classification:2 | |
| labels = torch.tensor([0, 1], device=device) | |
| model.train() | |
| optimizer = torch.optim.SGD(model.parameters(), 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 = ("beit.layers.0.attention.q_proj.weight", "beit.layers.0.mlp.fc1.weight") | |
| result = { | |
| "runtime": { | |
| "device": model.device.type, | |
| "dtype": str(model.dtype).removeprefix("torch."), | |
| "attn_implementation": model.config._attn_implementation, | |
| }, | |
| "predicted_class": predicted_class, | |
| "logits": 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)) | |
| ``` | |