nvidia/compileiq · Archived

compileiq-author-objective

Use when writing the objective_function= passed to Search(). Covers the two legal signatures (compiler-only str vs mixed list), the baseline-knockout branch, per-eval cache busting, framework-specific --apply-controls injection (raw PTXAS, NVCC, Triton, Helion, cuTeDSL/FA4, FlashInfer), correctness-before-timing, INVALID_SCORE handling, and the Debug-pack O0/O3 ACF-injection canary that must pass before launching a search. Triggers on "objective function", "apply-controls", "INVALID_SCORE", "sa…

First seen Jul 3, 2026

Installation

$ npx skills add nvidia/compileiq --skill compileiq-author-objective

Stronger alternatives

This repository is archived — consider an actively maintained alternative.

Also in this package

Other skills from nvidia/compileiq.

npx skills add nvidia/compileiq

Browse all from nvidia/compileiq

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 128
License LICENSE
Default branch main
Open issues 0
Status Archived

Skill metadata

Parsed from SKILL.md frontmatter.

Version1.0.0
LicenseApache-2.0
Allowed toolsBash Read
More metadata
version
1.0.0
author
NVIDIA CompileIQ
domain
compiler-optimization

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 9,091 B
  • docs SUMMARY.md 653 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 3 installs

SKILL.md

compileiq-author-objective

The objective function is where ~80% of CompileIQ user errors happen. This skill tells you the exact shape it must have for current CompileIQ, how to inject --apply-controls for each supported compile path, and how to verify the whole pipeline works before paying for a full search.

For paste-ready full-file templates per framework, see references/templates.md.

When

  • Writing a brand-new objective function.
  • Migrating an older objective off the legacy bytes.fromhex(config_blob) pattern.
  • Diagnosing "every config returns the same score" or "TypeError: fromhex".

The two legal signatures

Shape of search_space= Objective signature What config is
Single provider, e.g. PtxasSearchSpace() def objective(config: str) -> float A hex string. Pass it straight to savecompilerconfig(acf_path, config).
List, e.g. [{"k": ss.choice(...)}, PtxasSearchSpace()] def objective(mixed: list) -> float A list of the same length. Unpack: userspace, ptxasconfig = mixed.

Mixed-space results keep the same list shape in best["params"]. Unpack it before saving the ACF, for example: userspace, ptxasconfig = best["params"]. (Pattern reference: examples/compilers/tritonexample/mixedtriton.py:123-146.)

For multi-objective, return tuple[float, ...] of length num_objectives.

Canonical imports

from compileiq.types import INVALID_SCORE, BASELINE_CONFIG
from compileiq.utils.helpers import save_compiler_config

INVALID_SCORE is CompileIQ's sentinel — return it on any failure (compile, hang, wrong answer, exception). Do not redefine it as float('inf').

BASELINE_CONFIG is the empty-dict sentinel CompileIQ passes when a knockout knocks out every parameter (typically with normalize=True).

savecompilerconfig(path, hex_str) writes the binary blob to disk; it handles the bytes.fromhex internally (compileiq/utils/helpers.py:128-137). Users never need to touch fromhex themselves.

Self-contained for IsoMultiProcessWorker and Ray

Heavy library imports (torch, triton, helion, cute) go inside the function so the process IsoMultiProcessWorker spawns — or the remote Ray task — can re-import them in a clean state. Cheap module-level constants (paths, regexes) are fine.

Per-eval cache busting (non-negotiable)

import os, tempfile
env = os.environ.copy()
env["TRITON_ALWAYS_COMPILE"] = "1"
env["HELION_SKIP_CACHE"]     = "1"
env["TRITON_CACHE_DIR"]      = tempfile.mkdtemp(prefix="ciq_triton_")

For FlashInfer, additionally confirm the prebuilt cubin cache packages are absent — flashinfercubin and flashinferjitcache. See docs/flashinferbooster.md:56-64 for the import-time check.

Per-framework --apply-controls injection

Target Injection
Raw PTXAS (you have a .ptx file) ptxas --apply-controls candidate.acf kernel.ptx -arch=sm_100 -o kernel.cubin
NVCC source (CUDA .cu) nvcc -Xptxas --apply-controls=candidate.acf -arch=sm100 kernel.cu -o exe (canonical; see examples/compilers/nvbenchexample/optimize_reduction.py:108)
Triton kernel kernel kwarg: kernel[grid](..., ptxoptions=f"--apply-controls={acfpath}") plus TRITONALWAYSCOMPILE=1, os.environ["TRITONPTXASPATH"] = shutil.which("ptxas"), and os.environ["TRITONPTXASBLACKWELLPATH"] = shutil.which("ptxas") when Blackwell-specific PTXAS selection may apply. This replaces the older PTXASOPTIONS= env-var approach for Triton.
Helion Helion's official ACF API. See https://helionlang.com/examples/acfs/softmaxacf.html. Always set HELIONSKIP_CACHE=1.
cuTeDSL / FA4 (TVM-FFI) cute.compile(..., options=f"{existingoptions} --ptxas-options '--apply-controls {acfpath}'"). If you can't reach the call site, patch CompileCallable.call to splice in the option string.
FlashInfer FLASHINFEREXTRACUDAFLAGS="--ptxas-options=--apply-controls=$ACFFILE" (see docs/flashinferbooster.md:107).

Baseline knockout branch

def objective(config):
    if isinstance(config, dict) and not config:   # config == BASELINE_CONFIG
        return measure_without_acf()              # establish baseline run
    # config is a hex string (or list with hex tail) — apply ACF
    ...

Correctness-before-timing (mandatory)

The optimizer rewards whatever you measure. If you only measure latency, the algorithm will happily reward configs that compile faster by producing wrong answers. Always verify against a reference first:

if not torch.allclose(actual, reference, atol=1e-2, rtol=0):
    return INVALID_SCORE
return triton.testing.do_bench(lambda: kernel(...), warmup=100, rep=1000, return_mode="mean")

(Pattern from examples/compilers/tritonexample/mixedtriton.py:141-146.)

Catch everything → return INVALID_SCORE

try:
    ...
except (subprocess.TimeoutExpired, RuntimeError, FileNotFoundError, ValueError, OSError) as e:
    return INVALID_SCORE

When in doubt, catch broadly. CompileIQ expects INVALID_SCORE as the "this config is broken" signal — re-raising means the entire search fails.

Pre-search canary (mandatory before tuner.start())

Two cheap calls that catch ~90% of "every score is the same" bugs:

# Shape check — does the objective even run?
sample = tuner.sample(1)[0]
score = objective(sample)
print(f"sample run: {score}")
assert isinstance(score, (int, float)) and score == score   # not NaN

# ACF-injection canary using the Debug pack (downloaded once)
from compileiq.utils.helpers import load_compiler_config
O0_HEX = load_compiler_config("booster-pack-debug/ptxas_opt0.acf")
O3_HEX = load_compiler_config("booster-pack-debug/ptxas_opt3.acf")

baseline = objective({})                  # BASELINE_CONFIG path
score_O0 = objective(O0_HEX)
score_O3 = objective(O3_HEX)

assert score_O0 > baseline * 1.05, (
    f"O0 should regress (got {score_O0} vs baseline {baseline}). "
    "ACF is NOT reaching PTXAS — fix the cache-bust."
)
assert abs(score_O3 - baseline) / baseline < 0.05, (
    f"O3 should match baseline (got {score_O3} vs {baseline})."
)
print("ACF injection canary PASSED — safe to start the search.")

If either assertion fails, stop and fix the cache-bust before launching the search. Otherwise every generation's score is measurement noise on a stale binary.

Self-test

A 3-line "smoke" objective inside the SKILL author's repo, used to verify the scaffolding before plugging in a real kernel:

def smoke_objective(config):
    return 1.0   # constant; useful to verify Search() shape, not measurement

Drop it into the Search(...) call and run 2 generations; if that completes and results.getbestresult() returns a dict, your scaffold is correct.

Gotchas

  • PTXAS_OPTIONS is not the canonical Triton injection. It still works

for raw subprocess invocations, but Triton 3.x prefers the ptx_options= kernel kwarg. See the table above.

  • Mixed search spaces require list unpacking. If you pass

searchspace=[userdict, PtxasSearchSpace()], your objective must accept a list, not a string. Results keep that list in best["params"]; unpack it before saving the compiler config.

  • Don't redefine INVALID_SCORE. Import it from compileiq.types. If

you redefine it locally as float('inf'), the value happens to work today but is not guaranteed to in future releases.

  • config_blob is no longer a parameter name. The old skill set used

def objective(configblob) and called bytes.fromhex(configblob). Both are stale. Use def objective(config) and savecompilerconfig(path, config).

Next

  • Sizing SearchConfiguration and picking a Worker: compileiq-run-search.
  • After the search: compileiq-validate-result.
  • If something's wrong: compileiq-debug.