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, workload-aware PyTorch inference plan selector. Give it a model and representative serving inputs; it profiles eligible execution plans, validates every candidate against eager FP32, applies deployment constraints, and returns the plan with the best measured lifecycle cost.

Project site | Usage | Provider API | Research protocol | 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;
  • validates every candidate across weighted input shapes, batches, and keyword signatures;
  • records construction and lazy first-call time separately from steady-state latency;
  • reports request samples, median, P90/P95/P99, mean confidence intervals, incremental peak CUDA memory, and break-even calls;
  • optionally selects by projected total cost for an expected request volume;
  • rejects plans that exceed configured setup, first-call, or memory limits;
  • persists content-addressed decisions and revalidates cached winners before reuse;
  • includes optional Torch-TensorRT, ONNX Runtime, and TorchAO providers;
  • 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]"

Optional integration dependencies are deliberately separate:

pip install "custom-dl-optimizer[onnxruntime-gpu]"
pip install "custom-dl-optimizer[quantization]"

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",
        expected_calls=50_000,
        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.

Workload-Aware Selection

Use a weighted profile when production traffic contains multiple signatures:

from custom_dl_optimizer import WorkloadCase, WorkloadProfile

profile = WorkloadProfile(
    name="image-serving",
    expected_calls=100_000,
    cases=(
        WorkloadCase("batch-1", args=(batch_1,), weight=70),
        WorkloadCase("batch-8", args=(batch_8,), weight=25),
        WorkloadCase("batch-32", args=(batch_32,), weight=5),
    ),
)
result = optimizer.optimize_workload(model, profile)

Each candidate must pass parity for every case. Selection uses the normalized traffic weights, so a backend cannot win by optimizing an unrepresentative shape.

Candidate Evidence

for candidate in result.report.candidates:
    print(
        candidate.name,
        candidate.latency_ms,
        candidate.latency_p90_ms,
        candidate.latency_p99_ms,
        candidate.latency_ci95_low_ms,
        candidate.latency_ci95_high_ms,
        candidate.peak_memory_mb,
        candidate.first_call_time_s,
        candidate.projected_total_ms,
        candidate.break_even_calls_vs_baseline,
        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.

Resource policies are optional:

config = OptimizationConfig(
    max_setup_time_s=30,
    max_first_call_time_s=10,
    max_peak_memory_mb=2048,
)

Cold-Start-Aware Selection

Steady-state latency is the default selection basis. For a known serving horizon, set expected_calls to include candidate construction, lazy compilation on first invocation, and the remaining steady-state calls:

config = OptimizationConfig(
    enable_compile=True,
    expected_calls=10_000,
    min_speedup=1.02,
)

The report exposes selection_basis="projected_total_time", projected total milliseconds for each valid candidate, and its break-even call count against the fastest steady-state built-in baseline. This prevents a short-lived job from choosing a compiler whose build cost cannot be recovered.

Persistent Plan Cache

Enable a content-addressed cache to avoid re-running the full candidate race at every process start:

config = OptimizationConfig(
    plan_cache_dir=".custom-dl-cache",
    reuse_cached_plan=True,
)

The key includes model weights, workload signatures and weights, selection policy, provider settings, and runtime provenance. A cache hit still runs output parity, constraint checks, and a short latency-regression probe before the plan is accepted.

Compare Other Runtimes

First-party optional providers use the same policy as built-in plans:

from custom_dl_optimizer import (
    ONNXRuntimeProvider,
    Optimizer,
    TorchAOQuantizationProvider,
    TorchTensorRTProvider,
)

optimizer = Optimizer(
    device="cuda",
    providers=(
        TorchTensorRTProvider(
            compile_options={"optimization_level": 3},
        ),
        ONNXRuntimeProvider(),
        TorchAOQuantizationProvider(scheme="int8_weight_only"),
    ),
)
result = optimizer.optimize(model, sample)

Unavailable optional dependencies are reported without breaking the remaining race. Custom and private backends can still implement CandidateProvider. See the provider documentation.

CLI and Decision Bundles

custom-dl-optimizer inspect --device cuda
custom-dl-optimizer report artifacts/report.json
custom-dl-optimizer cache list --cache-dir .custom-dl-cache
custom-dl-optimizer paper-export artifacts/run-*/report.json \
  --output-dir artifacts/paper

result.save_bundle("artifacts/run") writes a report and portable decision manifest. Executable engine serialization remains provider-owned so the package never pretends a generic Python module is a deployable engine artifact.

paper-export preserves raw samples in candidate-level and workload-case CSV files, writes a LaTeX results table and provenance manifest, and produces median/P99 figures when the research extra is installed. These are reporting artifacts, not a substitute for the controlled protocol in paper-launch.md.

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 the agent documentation.

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 the version 2 migration guide.

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 workload distribution, 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.
  • peak_memory_mb is incremental allocated CUDA memory during a warmed serial invocation; total process VRAM, energy, and concurrent-service tails 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.2.0.tar.gz (389.7 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.2.0-py3-none-any.whl (39.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: custom_dl_optimizer-2.2.0.tar.gz
  • Upload date:
  • Size: 389.7 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.2.0.tar.gz
Algorithm Hash digest
SHA256 df355b2d16e8bf5763cde552f22a7f91ebbe24bb88c5bee8d2577caff247beea
MD5 f8527049aee601b876e0131f7033a806
BLAKE2b-256 b601d970baa3f0960e5e9c5034cc8ee6e689717b1f620bd97d644e5353f960cf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for custom_dl_optimizer-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 230fb348c5b91d737739ac745982cf4379c3de8bf70e58c4fcbb2f799aa329b2
MD5 c771a1a58dca2be0a4f3d1118f9bf31f
BLAKE2b-256 77e7494710cfe6ab47e6da3cd01a381e081a413a8e8591684537b11d2eabd52a

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