Skip to main content

An auditable PyTorch inference plan selector with FX, Triton, compiler plugins, and agent tools

Project description

Custom-DL-Optimizer

PyPI CI Python License: MIT

Custom-DL-Optimizer is an auditable PyTorch inference plan selector. Give it a model and representative inputs; it profiles eligible execution plans, validates every candidate against eager FP32, and returns the fastest plan that clears your configured gain threshold.

Project site | Usage | Provider API | Agent toolkit | Research notebook

Status: research alpha. Use it for controlled inference experiments and deployment feasibility checks. It complements rather than replaces TorchInductor, Torch-TensorRT, TensorRT, ONNX Runtime, TVM, or vendor profilers.

Why It Exists

An optimization is useful only when it wins on the actual model, input signature, device, and software stack. A transformation that helps ResNet can regress MobileNet; compilation can reduce steady-state latency while adding material setup cost; reduced precision can be fast but numerically unacceptable.

Custom-DL-Optimizer makes those tradeoffs explicit:

  • measures eager FP32, native AMP/layout, FX, and optional compiler candidates;
  • supports external candidate providers for TensorRT, ONNX Runtime wrappers, private compilers, or research passes;
  • rejects candidates that fail output structure or tolerance checks;
  • records setup time separately from steady-state latency;
  • reports speedup against eager FP32 and the native optimized path;
  • falls back when custom work does not clear min_speedup;
  • exports runtime provenance and results as JSON;
  • exposes a closed, dependency-neutral tool surface for in-process agents.

Installation

pip install custom-dl-optimizer

Vision examples require:

pip install "custom-dl-optimizer[vision]"

Triton and third-party compiler packages are runtime-detected. They are not force-installed because their versions must match the installed PyTorch/CUDA stack.

Quick Start

Version 2 uses a result-oriented API:

import torch
from torchvision.models import resnet50

from custom_dl_optimizer import OptimizationConfig, Optimizer

model = resnet50(weights=None).eval()
sample = torch.randn(8, 3, 224, 224)

optimizer = Optimizer(
    device="cuda" if torch.cuda.is_available() else "cpu",
    config=OptimizationConfig(
        enable_compile=torch.cuda.is_available(),
        compile_mode="max-autotune",
        min_speedup=1.02,
    ),
)
result = optimizer.optimize(model, sample)

with torch.inference_mode():
    output = result(sample)

print(result.selected_plan)
print(result.report.selection_reason)
result.save_report("artifacts/resnet50-optimization.json")

OptimizationResult owns both the callable selected module and the evidence used to select it. The selected wrapper prepares nested positional and keyword tensors for the target device and memory layout.

Candidate Evidence

for candidate in result.report.candidates:
    print(
        candidate.name,
        candidate.latency_ms,
        candidate.speedup_vs_eager,
        candidate.speedup_vs_native,
        candidate.parity,
        candidate.error,
    )

Built-in plans are:

Candidate Purpose
eager_fp32 Correctness and performance reference
native Eligible AMP and channels-last execution
fx Safe Conv-BN folding and supported FX rewrites
fx_inductor FX preparation followed by TorchInductor

Only valid candidates participate in selection. Pilot measurements are useful for plan choice; use a full benchmark protocol for publication claims.

Compare Another Compiler

External backends implement the small CandidateProvider protocol. The package handles warmup, timing, parity, reporting, and selection:

import torch
import torch_tensorrt  # Registers the torch.compile backend.

from custom_dl_optimizer import (
    FunctionCandidateProvider,
    OptimizationConfig,
    Optimizer,
)


def build_torch_tensorrt(model, context):
    return torch.compile(
        model,
        backend="torch_tensorrt",
        dynamic=context.config.dynamic_shapes,
    )


optimizer = Optimizer(
    device="cuda",
    config=OptimizationConfig(min_speedup=1.02),
    providers=(
        FunctionCandidateProvider(
            name="torch_tensorrt",
            builder=build_torch_tensorrt,
            availability=lambda context: context.device.type == "cuda",
        ),
    ),
)
result = optimizer.optimize(model, sample)

See docs/providers.md for isolation, input, correctness, and dependency rules. Torch-TensorRT officially supports use as a torch.compile backend; ONNX Runtime uses ordered execution providers and may require a wrapper that converts between PyTorch tensors and the session API.

Agent Toolkit

Agents cannot safely transmit live modules or tensors through JSON. The host application therefore registers workloads in process, then exposes four bounded tools: inspect runtime, list workloads, optimize one workload, and read its report.

from custom_dl_optimizer import OptimizationAgentToolkit, Optimizer

toolkit = OptimizationAgentToolkit(Optimizer(device="cuda"))
toolkit.register_workload(
    "resnet50-b8",
    model,
    sample,
    description="ResNet-50 inference, batch 8",
)

schemas = toolkit.tool_schemas()
response = toolkit.invoke(
    "custom_dl_optimize",
    {"workload": "resnet50-b8"},
)

The toolkit has no network client and never evaluates caller-provided code. See docs/agents.md.

Runtime Provenance

capabilities = optimizer.inspect_runtime()
print(capabilities.as_dict())

Reports include Python and PyTorch versions, device name and type, CUDA/cuDNN versions, compute capability, and the availability of AMP, channels-last, Triton, and torch.compile.

v1 Compatibility

AutoOptimizer remains available for one transition release, but new code should use Optimizer. The primary v2 contract returns one OptimizationResult rather than a (module, report) tuple. See docs/migration-v2.md.

Historical Research Snapshot

An earlier fixed-path notebook run on an NVIDIA Tesla T4 produced the following hardware-specific results. These are not guaranteed package performance and are not a state-of-the-art claim.

Model Batch Eager FP32 Inductor Experimental vs Eager vs Inductor
ResNet-50 128 366.997 ms 99.254 ms 89.307 ms 4.11x 1.11x
MobileNet-V2 128 112.703 ms 54.312 ms 64.372 ms 1.75x 0.84x
VGG-16 128 639.399 ms 273.326 ms 273.402 ms 2.34x 1.00x
EfficientNet-B0 128 146.788 ms 70.784 ms 66.409 ms 2.21x 1.07x
DenseNet-121 128 360.750 ms 194.997 ms 193.169 ms 1.87x 1.01x

MobileNet-V2 is the important result: the experimental path regressed against Inductor. Version 2 measures and exposes that failure instead of assuming every rewrite is beneficial. Rerun the research notebook before citing any value.

Development

git clone https://github.com/Devrajsinh-Jhala/Custom-DL-Optimizer.git
cd Custom-DL-Optimizer
python -m pip install -e ".[dev]"
python -m pytest
python -m ruff check custom_dl_optimizer tests examples tools
python -m build
python -m twine check dist/*

Read CONTRIBUTING.md, SECURITY.md, and CHANGELOG.md before contributing or publishing.

Limitations

  • Selection is specific to the supplied shapes, dtypes, device, and software versions.
  • FX symbolic tracing cannot represent every data-dependent Python program.
  • Provider setup may require third-party dependencies and substantial compilation time.
  • Tensor parity is not a substitute for dataset-level quality evaluation.
  • The current package targets inference; it does not optimize training or backward graphs.
  • GPU energy, peak memory, and multi-stream throughput require separate measurement.

Citation and License

Citation metadata is in CITATION.cff. Report the package version, hardware, CUDA, PyTorch, candidate providers, shapes, precision, warmup, iterations, and tolerances.

Released under the MIT License.

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

custom_dl_optimizer-2.0.0.tar.gz (363.8 kB view details)

Uploaded Source

Built Distribution

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

custom_dl_optimizer-2.0.0-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file custom_dl_optimizer-2.0.0.tar.gz.

File metadata

  • Download URL: custom_dl_optimizer-2.0.0.tar.gz
  • Upload date:
  • Size: 363.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for custom_dl_optimizer-2.0.0.tar.gz
Algorithm Hash digest
SHA256 c130f7f8b0ecd09053a4952203e8990fc7c80fe003da842f802465b8be35d8af
MD5 e4d910ee2ce6695cd86f8726235ab470
BLAKE2b-256 4b22189940e20edcd94127cd14ebcc20d47b9659019bfc0c03130a1fa3fab65e

See more details on using hashes here.

File details

Details for the file custom_dl_optimizer-2.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for custom_dl_optimizer-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c13133433f4b866c310f3525e3419918da3ca5e37bb9ec0687b7963c04345b37
MD5 ef3cd654e49ecfeebb943a77e86490d2
BLAKE2b-256 eedcb10174e55311d8dede22570e07562c8ddd1c973983490db102e4eb578d14

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