Skip to main content

Automatic Pytorch Image Models

Project description

AutoTimm

Train state-of-the-art vision models with minimal code
From prototype to production in minutes, not hours

PyPI Python License Stars

DocumentationQuick StartExamplesAPI Reference


What is AutoTimm?

AutoTimm is a production-ready computer vision framework that combines timm (1000+ pretrained models) with PyTorch Lightning. Train image classifiers, object detectors, and segmentation models with any timm backbone using a simple, intuitive API.

Perfect for:

  • Researchers needing reproducible experiments and quick iterations
  • Engineers building production ML systems with minimal boilerplate
  • Students learning computer vision with modern best practices
  • Startups rapidly prototyping vision applications

Why AutoTimm?

Fast

From idea to trained model in minutes. Auto-tuning, mixed precision, and multi-GPU out of the box.

Flexible

1000+ backbones, 4 vision tasks, multiple transform backends. Use what works best.

Production Ready

410+ tests, comprehensive logging, checkpoint management. Deploy with confidence.

What's New in v0.7.3

  • CSV Data Loading - Load data from CSV files for all task types: classification, object detection, semantic segmentation, and instance segmentation
  • CSVImageDataset - Single-label classification from CSV with auto class detection and both torchvision/albumentations backends
  • CSVDetectionDataset - Object detection from CSV with multi-row-per-image grouping and xyxy bbox format
  • CSVInstanceDataset - Instance segmentation from CSV with binary mask PNGs (no pycocotools required)
  • CSV Segmentation - Semantic segmentation from CSV via format="csv" in SemanticSegmentationDataset
  • All DataModules Updated - ImageDataModule, DetectionDataModule, SegmentationDataModule, and InstanceSegmentationDataModule all support train_csv/val_csv/test_csv parameters
  • Multi-Label Classification - Native multi-label support in ImageClassifier with multi_label=True, using BCEWithLogitsLoss and sigmoid predictions
  • MultiLabelImageDataModule - New data module for loading multi-label datasets from CSV files with auto-detected label columns, validation splits, and rich summary tables
  • Multi-Label Metrics - MetricManager now auto-injects num_labels and resolves torchmetrics.classification metrics (e.g., MultilabelAccuracy, MultilabelF1Score)
v0.7.2
  • torch.inference_mode - Faster inference across all tasks, export, and interpretation using torch.inference_mode() instead of torch.no_grad()
  • Reproducibility by Default - Automatic seeding with seed=42 and deterministic mode enabled out-of-the-box for fully reproducible training and inference
  • torch.compile by Default - Automatic PyTorch 2.0+ optimization enabled out-of-the-box for faster training and inference
  • TorchScript Export - Export trained models to TorchScript (.pt) for production deployment without Python dependencies
  • Model Interpretation - Complete explainability toolkit with 6 interpretation methods, 6 quality metrics, interactive Plotly visualizations, and up to 100x speedup with optimization
  • Tutorial Notebook - Comprehensive Jupyter notebook covering all interpretation features end-to-end
  • YOLOX Models - Official YOLOX implementation (nano to X) with CSPDarknet backbone
  • Smart Backend Selection - AI-powered recommendation for optimal transform backends
  • TransformConfig - Unified transform configuration with presets and model-specific normalization
  • Optional Metrics - Metrics now optional for inference-only deployments
  • Python 3.10-3.14 - Latest Python support

Quick Start

Installation

pip install autotimm

Everything included: PyTorch, timm, PyTorch Lightning, torchmetrics, albumentations, pycocotools, and more.

Optional extras
# Logging backends
pip install autotimm[tensorboard]  # TensorBoard
pip install autotimm[wandb]        # Weights & Biases
pip install autotimm[mlflow]       # MLflow

# Interpretation
pip install autotimm[interactive]  # Interactive Plotly visualizations

# All extras
pip install autotimm[all]          # Everything

Your First Model in 30 Seconds

from autotimm import AutoTrainer, ImageClassifier, ImageDataModule, MetricConfig

# Data
data = ImageDataModule(
    data_dir="./data",
    dataset_name="CIFAR10",
    image_size=224,
    batch_size=64,
)

# Metrics
metrics = [
    MetricConfig(
        name="accuracy",
        backend="torchmetrics",
        metric_class="Accuracy",
        params={"task": "multiclass"},
        stages=["train", "val", "test"],
        prog_bar=True,
    )
]

# Model
model = ImageClassifier(
    backbone="resnet18",  # Try efficientnet_b0, vit_base_patch16_224, etc.
    num_classes=10,
    metrics=metrics,
    lr=1e-3,
)

# Train with auto-tuning (finds optimal LR and batch size automatically!)
trainer = AutoTrainer(max_epochs=10)
trainer.fit(model, datamodule=data)

Auto-tuning is enabled by default. Disable with tuner_config=False for manual control.

Key Features

4 Vision Tasks Classification (single & multi-label) • Object Detection • Semantic Segmentation • Instance Segmentation
1000+ Backbones ResNet • EfficientNet • ViT • ConvNeXt • Swin • DeiT • BEiT • and more from timm
Model Interpretation 6 explanation methods • 6 quality metrics • Interactive visualizations • Up to 100x speedup
HuggingFace Integration Load models from HF Hub with hf-hub: prefix + Direct Transformers support
YOLOX Support Official YOLOX models (nano → X) + YOLOX-style heads with any timm backbone
Advanced Architectures DeepLabV3+ • FCOS • YOLOX • Mask R-CNN • Feature Pyramids
Auto-Tuning Automatic LR and batch size finding—enabled by default
Smart Transforms AI-powered backend recommendations + unified TransformConfig with presets
Multi-Logger Support TensorBoard • MLflow • Weights & Biases • CSV—use simultaneously
torch.compile Support Automatic PyTorch 2.0+ optimization • Enabled by default • Configurable modes
CSV Data Loading Load any task from CSV files — classification, detection, segmentation, instance segmentation
Production Ready Mixed precision • Multi-GPU • Gradient accumulation • 410+ tests

Task Examples

Image Classification

from autotimm import ImageClassifier

# Use any timm backbone or HuggingFace model
model = ImageClassifier(
    backbone="efficientnet_b0",  # or "hf-hub:timm/resnet50.a1_in1k"
    num_classes=10,
    metrics=metrics,  # Optional for inference!
)

trainer = AutoTrainer(max_epochs=10)
trainer.fit(model, datamodule=data)

Multi-Label Classification

from autotimm import ImageClassifier, MultiLabelImageDataModule, MetricConfig

# CSV data with columns: image_path, cat, dog, outdoor, indoor
data = MultiLabelImageDataModule(
    train_csv="train.csv",
    image_dir="./images",
    val_csv="val.csv",
    image_size=224,
    batch_size=32,
)
data.setup("fit")

model = ImageClassifier(
    backbone="resnet50",
    num_classes=data.num_labels,
    multi_label=True,       # BCEWithLogitsLoss + sigmoid
    threshold=0.5,
    metrics=[
        MetricConfig(
            name="accuracy",
            backend="torchmetrics",
            metric_class="MultilabelAccuracy",
            params={"num_labels": data.num_labels},
            stages=["train", "val"],
            prog_bar=True,
        ),
    ],
)

trainer = AutoTrainer(max_epochs=10)
trainer.fit(model, datamodule=data)

Object Detection with YOLOX

Official YOLOX (matches paper benchmarks):

from autotimm import YOLOXDetector, DetectionDataModule

model = YOLOXDetector(
    model_name="yolox-s",  # nano, tiny, s, m, l, x
    num_classes=80,
    lr=0.01,
    optimizer="sgd",
    scheduler="yolox",
    total_epochs=300,
)

trainer = AutoTrainer(max_epochs=300, precision="16-mixed")
trainer.fit(model, datamodule=DetectionDataModule(data_dir="./coco", image_size=640))

YOLOX-style head with any timm backbone:

from autotimm import ObjectDetector

model = ObjectDetector(
    backbone="resnet50",  # Experiment with any backbone!
    num_classes=80,
    detection_arch="yolox",
    fpn_channels=256,
)

Complete YOLOX GuideQuick Reference

Semantic Segmentation

from autotimm import SemanticSegmentor, SegmentationDataModule

model = SemanticSegmentor(
    backbone="resnet50",
    num_classes=19,
    head_type="deeplabv3plus",
    loss_type="combined",  # CE + Dice for better boundaries
)

data = SegmentationDataModule(
    data_dir="./cityscapes",
    format="cityscapes",  # or "coco", "voc", "png"
    image_size=512,
)

trainer = AutoTrainer(max_epochs=100)
trainer.fit(model, datamodule=data)

Instance Segmentation

from autotimm import InstanceSegmentor, InstanceSegmentationDataModule

model = InstanceSegmentor(
    backbone="resnet50",
    num_classes=80,
    mask_loss_weight=1.0,
)

trainer = AutoTrainer(max_epochs=100)
trainer.fit(model, datamodule=InstanceSegmentationDataModule(data_dir="./coco"))

CSV Data Loading

Load data from CSV files instead of folder structures or COCO JSON:

from autotimm import ImageClassifier, ImageDataModule, AutoTrainer

# Classification from CSV (columns: image_path, label)
data = ImageDataModule(
    train_csv="train.csv",
    val_csv="val.csv",
    image_dir="./images",
    image_size=224,
    batch_size=32,
)

model = ImageClassifier(backbone="resnet50", num_classes=10)
trainer = AutoTrainer(max_epochs=10)
trainer.fit(model, datamodule=data)
from autotimm import ObjectDetector, DetectionDataModule

# Detection from CSV (columns: image_path, x_min, y_min, x_max, y_max, label)
data = DetectionDataModule(
    train_csv="annotations.csv",
    image_dir="./images",
    image_size=640,
    batch_size=8,
)

CSV loading is supported for all tasks: classification, object detection, semantic segmentation, and instance segmentation.

CSV Data Loading Guide

Model Interpretation & Explainability

Understand what your models learn and how they make decisions with comprehensive interpretation tools.

Quick Explanation

from autotimm.interpretation import quick_explain

# One-line explanation
result = quick_explain(
    model,
    image,
    method="gradcam",
    save_path="explanation.png"
)

6 Interpretation Methods

from autotimm.interpretation import (
    GradCAM,                # Fast, class-discriminative (CNNs)
    GradCAMPlusPlus,        # Better for multiple objects
    IntegratedGradients,    # Theoretically sound, pixel-level
    SmoothGrad,             # Noise-reduced gradients
    AttentionRollout,       # Vision Transformers
    AttentionFlow,          # Vision Transformers
)

# Use any method
explainer = GradCAM(model)
heatmap = explainer.explain(image, target_class=5)
explainer.visualize(image, heatmap, save_path="gradcam.png")

Quantitative Evaluation

from autotimm.interpretation import ExplanationMetrics

metrics = ExplanationMetrics(model, explainer)

# Faithfulness metrics
deletion = metrics.deletion(image, target_class=5, steps=50)
insertion = metrics.insertion(image, target_class=5, steps=50)

# Stability metric
sensitivity = metrics.sensitivity_n(image, n_samples=50)

# Sanity checks
param_test = metrics.model_parameter_randomization_test(image)
data_test = metrics.data_randomization_test(image)

# Localization metric
pointing = metrics.pointing_game(image, bbox=(50, 50, 150, 150))

print(f"Deletion AUC: {deletion['auc']:.4f}")  # Lower = better
print(f"Insertion AUC: {insertion['auc']:.4f}")  # Higher = better
print(f"Sensitivity: {sensitivity['sensitivity']:.4f}")  # Lower = more stable

Interactive Visualizations

from autotimm.interpretation import InteractiveVisualizer

viz = InteractiveVisualizer(model)

# Create interactive HTML with zoom/pan/hover
fig = viz.visualize_explanation(
    image,
    explainer,
    colorscale="Viridis",
    save_path="interactive.html"
)

# Compare methods side-by-side
explainers = {
    'GradCAM': GradCAM(model),
    'GradCAM++': GradCAMPlusPlus(model),
    'Integrated Gradients': IntegratedGradients(model),
}
viz.compare_methods(image, explainers, save_path="comparison.html")

# Generate comprehensive report
viz.create_report(image, explainer, save_path="report.html")

Performance Optimization

from autotimm.interpretation.optimization import (
    ExplanationCache,        # 10-50x speedup
    BatchProcessor,          # 2-5x speedup
    PerformanceProfiler,     # Identify bottlenecks
    optimize_for_inference,  # 1.5-3x speedup
)

# Enable caching
cache = ExplanationCache(cache_dir="./cache", max_size_mb=5000)

# Optimize model
model = optimize_for_inference(model, use_fp16=True)

# Batch processing
processor = BatchProcessor(model, explainer, batch_size=32)
heatmaps = processor.process_batch(images)

# Profile performance
profiler = PerformanceProfiler(enabled=True)
with profiler.profile("explanation"):
    heatmap = explainer.explain(image)
profiler.print_stats()

Training Integration

from autotimm import AutoTrainer
from autotimm.interpretation import InterpretationCallback

# Monitor interpretations during training
callback = InterpretationCallback(
    sample_images=val_images,
    method="gradcam",
    log_every_n_epochs=5,
)

trainer = AutoTrainer(
    max_epochs=100,
    callbacks=[callback],
    logger="tensorboard",
)
trainer.fit(model, datamodule=data)

Features:

  • 6 interpretation methods for different use cases
  • 6 quality metrics for quantitative evaluation
  • Interactive visualizations with Plotly (zoom/pan/hover)
  • Up to 100x speedup with caching and optimization
  • Feature visualization and receptive field analysis
  • Training callbacks for automatic monitoring
  • Comprehensive tutorial notebook included

Interpretation GuideTutorial Notebook

HuggingFace Integration

Three Approaches

Approach Best For Example
HF Hub timm CNNs, Production "hf-hub:timm/resnet50.a1_in1k"
HF Transformers Direct Vision Transformers ViTModel.from_pretrained(...)
HF Transformers Auto Quick Prototyping AutoModel.from_pretrained(...)

All approaches fully support AutoTrainer (checkpointing, early stopping, mixed precision, multi-GPU, auto-tuning).

from autotimm import ImageClassifier, list_hf_hub_backbones

# Discover models
models = list_hf_hub_backbones(model_name="resnet", limit=5)

# Use any HF Hub model (just add 'hf-hub:' prefix!)
model = ImageClassifier(
    backbone="hf-hub:timm/convnext_base.fb_in22k_ft_in1k",
    num_classes=100,
)

HF Integration ComparisonHF Hub GuideHF Transformers Guide

Smart Features

torch.compile Optimization

Enabled by default for all tasks with PyTorch 2.0+:

# Default: torch.compile enabled for faster training/inference
model = ImageClassifier(backbone="resnet50", num_classes=10)

# Disable if needed
model = ImageClassifier(backbone="resnet50", num_classes=10, compile_model=False)

# Custom compile options
model = ImageClassifier(
    backbone="resnet50",
    num_classes=10,
    compile_kwargs={"mode": "reduce-overhead", "fullgraph": True}
)

Compile modes:

  • "default" - Balanced performance (default)
  • "reduce-overhead" - Lower latency, better for smaller batches
  • "max-autotune" - Maximum optimization, longer compile time

What gets compiled:

  • Classification: backbone + head
  • Detection: backbone + FPN/neck + head
  • Segmentation: backbone + segmentation head
  • Instance Segmentation: backbone + FPN + detection head + mask head

Gracefully falls back on PyTorch < 2.0 with a warning.

Reproducibility by Default

Automatic seeding for reproducible experiments:

# Default: seed=42, deterministic=True for full reproducibility
model = ImageClassifier(backbone="resnet50", num_classes=10)
trainer = AutoTrainer(max_epochs=10)

# Custom seed
model = ImageClassifier(backbone="resnet50", num_classes=10, seed=123)
trainer = AutoTrainer(max_epochs=10, seed=123)

# Faster training (disable deterministic mode)
model = ImageClassifier(backbone="resnet50", num_classes=10, deterministic=False)
trainer = AutoTrainer(max_epochs=10, deterministic=False)

# Manual seeding
from autotimm import seed_everything
seed_everything(42, deterministic=True)

What's seeded:

  • Python's random module
  • NumPy's random number generator
  • PyTorch (CPU & CUDA)
  • Environment variables for reproducibility
  • cuDNN deterministic algorithms (when deterministic=True)

Seeding options:

  • Model-level: Seeds when model is created
  • Trainer-level: Seeds before training starts (uses Lightning's seeding by default)
  • Manual: Use seed_everything() for custom control

Perfect for research papers, debugging, and ensuring consistent results across runs!

TorchScript Export

Export trained models for production deployment:

from autotimm import ImageClassifier, export_to_torchscript
import torch

# Load trained model
model = ImageClassifier.load_from_checkpoint("model.ckpt")

# Export to TorchScript
example_input = torch.randn(1, 3, 224, 224)
export_to_torchscript(
    model,
    "model.pt",
    example_input=example_input,
    method="trace"  # Recommended
)

# Or use the convenience method
model.to_torchscript("model.pt")

# Load and use in production
scripted_model = torch.jit.load("model.pt")
output = scripted_model(image)

Benefits:

  • No Python dependencies required
  • Deploy to C++, mobile, or edge devices
  • Faster inference with torch.inference_mode() and JIT optimizations
  • Single-file deployment
  • Graceful fallback if JIT optimization fails on your platform

Smart Backend Selection

from autotimm import recommend_backend, compare_backends

# Get AI-powered recommendation
rec = recommend_backend(task="detection")
config = rec.to_config(image_size=640)

# Compare backends side-by-side
compare_backends()

Unified Transform Configuration

from autotimm import TransformConfig, list_transform_presets

# Discover presets
list_transform_presets()  # ['default', 'autoaugment', 'randaugment', ...]

# Configure with model-specific normalization
config = TransformConfig(
    preset="randaugment",
    image_size=384,
    use_timm_config=True,  # Auto-detect mean/std from backbone
)

model = ImageClassifier(
    backbone="efficientnet_b4",
    num_classes=10,
    transform_config=config,
)

Custom Auto-Tuning

from autotimm import AutoTrainer, TunerConfig

# Default: Full auto-tuning
trainer = AutoTrainer(max_epochs=10)

# Disable auto-tuning
trainer = AutoTrainer(max_epochs=10, tuner_config=False)

# Custom configuration
trainer = AutoTrainer(
    max_epochs=10,
    tuner_config=TunerConfig(
        auto_lr=True,
        auto_batch_size=True,
        lr_find_kwargs={"min_lr": 1e-6, "max_lr": 1.0},
    ),
)

Optional Metrics for Inference

# Training with metrics
model = ImageClassifier(backbone="resnet50", num_classes=10, metrics=metrics)

# Inference without metrics
model = ImageClassifier(backbone="resnet50", num_classes=10)
model = model.load_from_checkpoint("checkpoint.ckpt")
predictions = model(image)

Explore Models

YOLOX Models

import autotimm

# List all YOLOX variants
autotimm.list_yolox_models()  # ['yolox-nano', 'yolox-tiny', 'yolox-s', ...]

# Get detailed specs (params, FLOPs, mAP)
autotimm.list_yolox_models(verbose=True)

# Get model info
info = autotimm.get_yolox_model_info("yolox-s")
print(f"Params: {info['params']}, mAP: {info['mAP']}")  # Params: 9.0M, mAP: 40.5

# List components
autotimm.list_yolox_backbones()
autotimm.list_yolox_necks()
autotimm.list_yolox_heads()

timm Backbones

# Search 1000+ timm models
autotimm.list_backbones("*efficientnet*", pretrained_only=True)
autotimm.list_backbones("*vit*")

# Search HuggingFace Hub
autotimm.list_hf_hub_backbones(model_name="resnet", limit=10)

# Inspect a model
backbone = autotimm.create_backbone("convnext_tiny")
print(f"Features: {backbone.num_features}, Params: {autotimm.count_parameters(backbone):,}")

Documentation & Examples

Documentation

Comprehensive documentation with interactive diagrams, search optimization, and fast navigation:

Section Description
Quick Start Get up and running in 5 minutes
User Guide In-depth guides for all features
Interpretation Guide Model explainability and visualization
YOLOX Guide Complete YOLOX implementation guide
API Reference Complete API documentation
Examples 50 runnable code examples

Ready-to-Run Examples

🚀 Getting Started

🎯 Computer Vision Tasks

🤗 HuggingFace Hub (14 examples)

📊 Data & Training

🔍 Model Understanding

Browse all examples →

Supported Architectures

Classification

  • Models: Any timm backbone (1000+)
  • Losses: CrossEntropy with label smoothing, Mixup; BCEWithLogitsLoss for multi-label

Object Detection

  • Architectures: FCOS, YOLOX (official & custom)
  • Losses: Focal Loss, GIoU Loss, Centerness Loss

Semantic Segmentation

  • Architectures: DeepLabV3+, FCN
  • Losses: CrossEntropy, Dice, Focal, Combined, Tversky
  • Formats: PNG masks, COCO stuff, Cityscapes, Pascal VOC, CSV

Instance Segmentation

  • Architecture: FCOS + Mask R-CNN style mask head
  • Losses: Detection losses + Binary mask loss
  • Formats: COCO JSON, CSV with binary mask PNGs

Testing

Comprehensive test suite with 410+ tests:

# Run all tests
pytest tests/ -v

# Specific modules
pytest tests/test_classification.py
pytest tests/test_yolox.py
pytest tests/test_interpretation.py
pytest tests/test_csv_datamodules.py

# With coverage
pytest tests/ --cov=autotimm --cov-report=html

Contributing

We welcome contributions!

git clone https://github.com/theja-vanka/AutoTimm.git
cd AutoTimm
pip install -e ".[dev,all]"
pytest tests/ -v

For major changes, please open an issue first.

Citation

@software{autotimm,
  author = {Krishnatheja Vanka},
  title = {AutoTimm: Automatic PyTorch Image Models},
  url = {https://github.com/theja-vanka/AutoTimm},
  year = {2026},
  version = {0.7.3}
}

Built with ❤️ using timm and PyTorch Lightning

Star us on GitHubReport IssuesRead the Docs

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

autotimm-0.7.3.tar.gz (4.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

autotimm-0.7.3-py3-none-any.whl (190.9 kB view details)

Uploaded Python 3

File details

Details for the file autotimm-0.7.3.tar.gz.

File metadata

  • Download URL: autotimm-0.7.3.tar.gz
  • Upload date:
  • Size: 4.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for autotimm-0.7.3.tar.gz
Algorithm Hash digest
SHA256 9e95e25617b21f4d67c0672b23e85c400c852acb48f917c3098a0847fe823753
MD5 9e5fb2102bbf3f4622bdf5b7ed4095eb
BLAKE2b-256 bd342844f22d0ba629bb774e860c242d1353b61e553dc10ef702a9019f28606e

See more details on using hashes here.

File details

Details for the file autotimm-0.7.3-py3-none-any.whl.

File metadata

  • Download URL: autotimm-0.7.3-py3-none-any.whl
  • Upload date:
  • Size: 190.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for autotimm-0.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a3dc34cb8876c136af3c386c9bd7e718a422714ab22c630e2350769744d69ad2
MD5 6db5a9ea489610624481a87b91f0ae20
BLAKE2b-256 6b181779c4d1b008184e50c8f450b91256d6c1109a229e9532971d5b65f0b1e4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page