Generated banner for Omniverse Usd Performance Tuning
Generated logo for Omniverse Usd Performance Tuning

Omniverse Usd Performance Tuning

NVIDIAOfficialCreated by NVIDIA Omniverse

  • Skill
  • Workflow
  • Software development
  • Apache-2.0
  • Medium risk
  • Has scripts

From the author

Diagnose and optimize USD stages for slow loading, high memory, low FPS or validation; preserve asset boundaries and reuse shared definitions.
— the description by NVIDIA Omniverse

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides a structured workflow for diagnosing and optimizing USD stages. It focuses on improving performance metrics like load times, memory footprint, and frame rates by identifying and optimizing unique asset definitions, reusing shared definitions, and pruning unnecessary data. The process emphasizes preserving original asset boundaries, animation, and interface requirements, ensuring that downstream applications remain functional after optimization.

What it does

  • Inspects USD stages to identify performance bottlenecks and structural inefficiencies.
  • Classifies assets into atomic, package, or aggregate structures to guide optimization.
  • Performs native USD optimization operations on disjoint scopes.
  • Publishes semantic libraries to enable efficient asset reuse.
  • Validates composition, ownership, and interface accessibility of the optimized output.
  • Profiles the final output against the original baseline to report measured improvements.

When to use it

  • When a USD stage suffers from slow loading times or high memory consumption.
  • When rendering performance (FPS) needs improvement in a production environment.
  • Before finalizing a USD assembly for downstream consumption.
  • When you need to standardize asset structures according to factory-level guidelines.

Advantages

  • Maintains asset boundaries and critical metadata during optimization.
  • Reduces scene complexity through intelligent reuse of shared definitions.
  • Provides verifiable reports on performance gains and composition integrity.
  • Supports large-scale scene optimization by processing independent definition scopes.

Usage examples

“Inspect the USD stage at /data/factory.usdc for performance issues and prepare a review workspace.”
The agent initializes the workspace, runs the inspection script, and provides a summary of candidates for optimization.
“Submit the optimization decisions for the factory stage based on the generated JSON.”
The agent processes the boundary decisions, executes the optimization operations, and generates the final optimized USD assembly.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/nvidia/omniverse-usd-performance-tuning/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip omniverse-usd-performance-tuning.zip -d .agents/skills

Documentation by NVIDIA Omniverse

Omniverse USD Performance Tuning

Purpose

Improve loading, memory use or rendering for the requested workload. Preserve the prim paths, appearance, placement and behavior required by downstream applications. Follow the component/subcomponent model in NVIDIA's Factory-Level USD Structuring guide. Apply the relevant parts of that model; a static asset does not need new animation or physics.

Inputs

Required: the source USD stage. When no workload is specified, use factory layout planning and visualization and record that assumption in the request/report. Explicit workload and preservation requirements take precedence. Optional: an output workspace, preservation requirements, physical error budget, existing library indexes and recorded runtime evidence. Use values from the current user request; reuse recorded values only while they remain applicable. Follow setup when no output path is supplied.

Prerequisites

Verify the selected runtime and required capabilities using setup. Keep its preflight record with the run; installation and remote access are conditional steps described there.

Instructions

  1. Inspect. Establish the workload, preservation requirements and output workspace. Set up progress and dashboard access before assessment. Verify setup and inspect the selected source configuration.

  2. Judge boundaries. Review equipment, service-system sections and architectural elements in the selected configuration, including animation and interiors. Record owners, editable interfaces, equipment categories and optional families using boundary guidance.

  3. Classify and author. Classify accepted assets children before parents. Capture or reuse the original profile before authoring. Prepare reusable definitions, materials and occurrence opinions using asset authoring.

  4. Optimize unique definitions. Run supported native operations concurrently on disjoint scopes with the recorded physical budget.

  5. Publish semantic libraries. Use one writer per category layer and remap consumer references.

  6. Check composition. Check authored ownership, references, bindings, placement, animation and interface accessibility through the written-output checks.

  7. Profile and report. Compare the final consumer with the original baseline under comparable conditions and report measured benefits, completion and operations by asset definition.

sequenceDiagram
    participant A as Agent
    participant T as USD tools
    participant W as Definition workers
    participant L as Library publisher
    participant D as Read-only progress dashboard
    Note over A,L: One compact progress state also renders text progress
    T-->>D: Recorded phase, assessment rounds, counters and decision reasons
    A->>T: Inspect original selected configuration
    T->>T: Collect cached child-to-parent summaries and repetition nominations
    T->>T: Load supplied indexes once and batch authored product clues
    T-->>A: Product review groups, member context, animation and reuse evidence
    loop Until boundaries and interiors are reviewed
        A->>A: Select asset boundaries, then identify required internal prims and properties
        A->>T: Submit boundary decisions with reviewed scope, required edits, category and optional family
        T->>T: Reuse unchanged source evidence, recompute boundary-dependent results
        opt Geometry ownership requires reconstruction
            T->>T: Regroup or native split, remap paths and reassess affected regions
        end
        T-->>A: Remaining candidates and member exceptions
    end
    T->>T: Classify selected child assets before parent assets, confirm reuse
    T->>T: Capture or reuse original baseline profile
    T->>T: Confirm accepted product identities from source and supplied indexes; reconcile complete parent-child groups
    T->>T: Skip worker inputs for confirmed groups; author remaining materials, editable prims and occurrence overrides
    T->>T: Determine merge groups on prepared interiors; preserve selected child assets and required prims
    T->>W: Read-only input USD layers for existing-library matching
    par Independent preparation jobs
        W->>W: Confirm remaining product, exact source or authorized normalized reuse; preserve occurrence placement
        W->>W: Consolidate accepted product or compatible exact/normalized leaf inputs; retain every occurrence
    end
    W-->>T: Confirmed library hits and definitions requiring optimization
    T->>W: Owned geometry prim paths in read-only input layers
    par Independent definition scopes
        W->>W: Remove small meshes when authorized; apply asset representation: reserve merge inputs or fit analytic prims; reduce, merge (native clustering if required), prune, flatten, prune
    end
    W->>L: Geometry outputs and assembly authoring outcomes
    L->>L: Share eligible static whole definitions within current category publication
    L->>L: Share remaining whole meshes; write USD reuse metadata and compact index
    L->>T: Output USD stage with rewritten references and dependencies
    T->>T: Check authored composition, ownership, animation and interfaces
    T->>T: Profile final output USD stage and report results by asset definition
    T-->>A: Measured changes, coverage and unresolved work
    T-->>D: Final verdict and report/library paths

Use the provided tools for traversal, native operations, authoring and checks; the agent supplies engineering judgments. Preserve current variant selections, authored animation, required materials and interfaces. Trust supported USD Optimize operations with valid settings and scopes. Deep geometric comparisons and whole-scene edit trials belong in development tests, not ordinary execution.

Complete when every unique definition has an executed or evidenced unchanged outcome, every asset has justified ownership and structure, and the written consumer passes composition checks. Retain native failures, unresolved judgments and missing required capabilities as incomplete work. Repeat only affected work when evidence changes.

Scope and authorization

  • Diagnosis and validation requests remain read-only. An optimization request authorizes work in a separate output workspace within its stated preservation limits.

  • Never overwrite source layers or inherited libraries without explicit authorization.

  • Reuse authorization already given. Ask only for a missing decision that changes identity, required appearance or a loss budget; explain the affected component and consequence.

  • Report only observed changes. Measure rendering before claiming higher FPS or lower GPU use.

Load only the relevant guidance

RequestRead
Validation onlySetup, then the validation section of operations
Approved operation chainSetup, operations, verification
Existing or persistent asset libraryAdd the library index requirements to the assessment
Missing standalone runtimeInstallation
Remote stageRemote access before the first open
Report from completed evidenceVerification

Use upstream package guidance for selected operation mechanics and proxy workflows. Keep large logs on disk as specified in setup.

Limitations

Convert CAD input with the source converter's workflow and NVIDIA's CAD conversion guidance. Render profiling requires NVIDIA/omniperf or the user's available profiler; USD open and traversal timings alone do not establish rendering improvements.

Troubleshooting

For unavailable imports, operations or remote assets, follow setup. For incomplete execution or failed composition checks, follow verification; retain the failed artifacts and report the missing capability or failed check.

Examples

After runtime preflight, use the verified Python interpreter from setup to inspect a stage:

python scripts/successor_assessment.py inspect --source /data/factory.usdc --workspace /data/factory-review

Review the generated candidates using boundary guidance, fill the generated decision template, then submit it:

python scripts/successor_assessment.py decide --workspace /data/factory-review --decisions /data/factory-review/decisions.json

These commands perform assessment; continue through the instructions above only when review is complete. Run from the skill directory; generated data stays in the workspace.

Output Format

Maintain live progress and editable steering throughout execution.

For end-to-end optimization, provide the written USD assembly, validated report JSON, and generated Markdown and HTML reports. State the runtime, operations actually executed, preservation and coverage results, measured changes, source-write status, and artifact paths. Diagnosis-only work may return a findings summary stating that no optimized stage was written.

Files

references/usd-validation-runner/scripts/usd_validation_executor.py

# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
"""Canonical validation reference executor for the USD performance-tuning skill.

This is the ONE supported way to run validators inside the skill. Agents call
this API with **canonical concept names** (e.g. ``primvar_indexability``); they
never enumerate rules, guess class names, or shell out to a CLI.

Why this exists
---------------
Bare rule names are not unique. Before usd-optimize 1.3, ``IndexedPrimvarChecker``
was registered by both Usd Optimize (0.3 s triage) and usd-validation-nvidia (376 s
full audit). A name-only lookup picks one by registry order, so the same scope note
produces different work and wildly different runtimes on different hosts. That is
the root cause of "every run finds a different solution and it takes forever."
From 1.3, Usd Optimize registers its rules as ``UsdOptimize<Name>`` and
``validator-concepts.json`` names those classes; a bare 1.1-era name resolves to
nothing. Identity stays ``(family, class_name)`` regardless, so a future collision
cannot reintroduce the problem.

Contract (no ambiguity, no fallbacks)
-------------------------------------
1. Identity is ``(package family of module, class_name)``, sourced from
   ``validator-concepts.json``. Concept -> implementation -> rule class is
   resolved by identity, never by bare name. The family is the stable part:
   ``usd_validation_nvidia`` and ``omni.asset_validator`` are one provider
   family, ``usd_optimize`` and ``omni.scene.optimizer`` are the other, so an
   upstream module rename inside a family still resolves. That is what kept
   the two ``IndexedPrimvarChecker`` classes apart before 1.3 while tolerating
   drift.
2. Resolution is fail-closed: zero matches raises, more than one *distinct*
   class matches raises. The executor never "best-guesses" a rule.
3. The Python validation runtime is required. If it cannot be imported, the
   executor raises ``ValidationRuntimeUnavailable`` and the caller records
   ``blocked_validation_runtime`` in the coverage ledger. There is no CLI path.
4. Scoping is mandatory for non-whole-stage policies: callers pass ``paths`` /
   ``mask_paths`` and the stage is opened with ``Usd.Stage.OpenMasked()``.

The validator runtime packages (``omni.asset_validator`` / ``pxr``) only import
inside a Kit/AV environment, so every runtime import is deferred into the
function that needs it. Importing this module is always safe (and unit-testable)
without those packages present.
"""
from __future__ import annotations

import importlib
import json
import subprocess
from dataclasses import dataclass, field
from pathlib import Path
from typing import Any, Callable, Iterable

#: Every ledger disposition is an explicit "resolved" outcome. The completion
#: gate is satisfied only when every planned (target, concept) has one of these.
RESOLVED_STATUSES = frozenset(
    {
        "probed_with_findings",
        "probed_clean",
        "user_declined",
        "timeout_recorded",
        "blocked_validation_runtime",
    }
)

#: The subset of ``RESOLVED_STATUSES`` where a validator actually ran against the
#: stage. The other three -- ``user_declined``, ``timeout_recorded`` and
#: ``blocked_validation_runtime`` -- are resolved in the sense that we know what
#: happened, and they all mean the same thing about the asset: nothing was
#: checked. Keeping the two sets apart is what stops "we know we did not look"
#: from being reported as "we looked and it was fine".
VALIDATED_STATUSES = frozenset({"probed_with_findings", "probed_clean"})

DEFAULT_REGISTRY_PATH = (
    Path(__file__).resolve().parent.parent / "references" / "validator-concepts.json"
)


class ConceptResolutionError(RuntimeError):
    """A concept name or its identity could not be resolved unambiguously."""


class ScopeNoteContractError(RuntimeError):
    """A scope note is internally inconsistent, so it cannot be executed as written."""


class ValidationRuntimeUnavailable(RuntimeError):
    """The Python validation runtime is not importable. No CLI fallback exists."""


#: Single message for every "runtime missing" condition. Callers record
#: ``blocked_validation_runtime`` in the coverage ledger; there is no CLI path.
_RUNTIME_UNAVAILABLE = (
    "No USD validation runtime (omni.asset_validator[.core]) is importable. "
    "Record 'blocked_validation_runtime'; there is no CLI fallback."
)


#: Package families. Both the current and the pre-rename package roots of a
#: provider map to the same family key, which is the part of rule identity that
#: has survived every upstream rename so far (``omni.asset_validator.*`` ->
#: ``usd_validation_nvidia.rules.*``, ``omni.scene.optimizer.validators.*`` ->
#: ``usd_optimize.validators.*``). Matching on (family, class_name) is therefore
#: version-tolerant while still telling the two providers apart — which is the
#: whole point: before usd-optimize 1.3, ``IndexedPrimvarChecker`` was registered by both.
#: Longest prefix wins, so a new root can be added without reordering.
_MODULE_FAMILIES: dict[str, str] = {
    "usd_validation_nvidia": "oav",
    "omni.asset_validator": "oav",
    "usd_optimize": "so",
    "omni.scene": "so",
}


def module_family(module: str) -> str | None:
    """Return the provider family (``oav`` / ``so``) owning ``module``.

    ``None`` for a module outside every known family; callers then fall back to
    exact-module matching rather than widening the match.
    """
    best: tuple[int, str | None] = (0, None)
    for prefix, family in _MODULE_FAMILIES.items():
        if (module == prefix or module.startswith(prefix + ".")) and len(prefix) > best[0]:
            best = (len(prefix), family)
    return best[1]


@dataclass(frozen=True)
class ResolvedImplementation:
    """A concept resolved to a single runtime rule identity."""

    canonical_name: str
    provider: str
    module: str
    class_name: str
    tier: int
    scope_policy: str
    backing_op: str | None
    gpu_bound: bool
    #: Pre-rename module paths for the same class, accepted as equal identities
    #: so an older runtime still resolves. Never used to widen across families.
    module_aliases: tuple[str, ...] = field(default=())


# --------------------------------------------------------------------------- #
# Registry                                                                     #
# --------------------------------------------------------------------------- #
def load_registry(path: str | Path | None = None) -> dict[str, Any]:
    """Load and index the canonical validator-concept registry.

    Returns a dict with the raw ``concepts`` list plus a ``by_name`` index.
    Raises ``ConceptResolutionError`` if a canonical name is duplicated.
    """
    registry_path = Path(path) if path is not None else DEFAULT_REGISTRY_PATH
    data = json.loads(Path(registry_path).read_text(encoding="utf-8"))
    by_name: dict[str, dict[str, Any]] = {}
    for concept in data["concepts"]:
        name = concept["canonical_name"]
        if name in by_name:
            raise ConceptResolutionError(f"Duplicate canonical_name in registry: {name}")
        by_name[name] = concept
    data["by_name"] = by_name
    return data


def resolve_implementation(
    registry: dict[str, Any],
    canonical_name: str,
    *,
    provider: str | None = None,
) -> ResolvedImplementation:
    """Resolve a canonical concept name to a single ``(module, class_name)``.

    ``provider`` defaults to the concept's ``preferred_provider`` (``so`` for
    performance tuning). Fail-closed: an unknown concept or a provider with no
    implementation raises ``ConceptResolutionError``.
    """
    concept = registry.get("by_name", {}).get(canonical_name)
    if concept is None:
        raise ConceptResolutionError(
            f"Unknown concept '{canonical_name}'. Concepts must come from "
            f"validator-concepts.json; do not synthesize names."
        )
    chosen_provider = provider or concept["preferred_provider"]
    impls = [im for im in concept["implementations"] if im["provider"] == chosen_provider]
    if not impls:
        raise ConceptResolutionError(
            f"Concept '{canonical_name}' has no '{chosen_provider}' implementation."
        )
    if len(impls) > 1:
        raise ConceptResolutionError(
            f"Concept '{canonical_name}' has ambiguous '{chosen_provider}' implementations."
        )
    impl = impls[0]
    return ResolvedImplementation(
        canonical_name=canonical_name,
        provider=impl["provider"],
        module=impl["module"],
        class_name=impl["class_name"],
        tier=int(impl.get("tier", concept["tier"])),
        scope_policy=concept["scope_policy"],
        backing_op=concept["backing_op"],
        gpu_bound=bool(concept["gpu_bound"]),
        module_aliases=tuple(impl.get("module_aliases", ())),
    )


# --------------------------------------------------------------------------- #
# Runtime                                                                      #
# --------------------------------------------------------------------------- #
def get_rule_registry() -> Any:
    """Return the validator runtime's rule registry, or fail closed.

    Tries the Kit core package first, then the standalone package. Raises
    ``ValidationRuntimeUnavailable`` if neither imports — there is no CLI path.
    """
    try:
        from omni.asset_validator.core import ValidationRulesRegistry  # type: ignore

        return ValidationRulesRegistry
    except ImportError:
        pass
    try:
        from omni.asset_validator import CategoryRuleRegistry  # type: ignore

        return CategoryRuleRegistry()
    except ImportError as exc:  # pragma: no cover - environment dependent
        raise ValidationRuntimeUnavailable(_RUNTIME_UNAVAILABLE) from exc


def get_validation_engine_cls() -> Any:
    """Return the ``ValidationEngine`` class, or fail closed.

    Kit exposes it at ``omni.asset_validator.core``; the standalone package
    exposes it at ``omni.asset_validator`` (no ``.core``). Try both so the same
    executor works in either runtime.
    """
    try:
        from omni.asset_validator.core import ValidationEngine  # type: ignore

        return ValidationEngine
    except ImportError:
        pass
    try:
        from omni.asset_validator import ValidationEngine  # type: ignore

        return ValidationEngine
    except ImportError as exc:  # pragma: no cover - environment dependent
        raise ValidationRuntimeUnavailable(_RUNTIME_UNAVAILABLE) from exc


def _shape_registered_rules(reg: Any) -> Any:
    """Kit core ``ValidationRulesRegistry`` shape (iterable or callable)."""
    try:
        registered = reg.registered_rules
    except AttributeError:
        return None
    return registered() if callable(registered) else registered


def _shape_rules_by_name(reg: Any) -> Any:
    """Older ``name -> rule`` map shape; yields the map's values."""
    try:
        mapping = reg.rules_by_name
    except AttributeError:
        return None
    return mapping.values() if isinstance(mapping, dict) else None


def _shape_rules(reg: Any) -> Any:
    """OAV 1.18.0 ``CategoryRuleRegistry.rules`` shape (iterable/dict/callable)."""
    try:
        direct = reg.rules
    except AttributeError:
        return None
    if callable(direct):
        direct = direct()
    if isinstance(direct, dict):
        direct = direct.values()
    return direct


#: Allowlist of the only registry entry points the enumerator may consult, each
#: mapped to an accessor that normalizes that runtime's shape to an iterable of
#: rule objects. Using an explicit static mapping (instead of dynamic
#: ``getattr``) guarantees no externally-influenced name can select an
#: attribute — only these three known, hand-vetted registry shapes are ever
#: read, and each accessor uses direct attribute access. This is a runtime
#: adapter, not a correctness fallback: extend it only with a new entry point
#: that yields rule classes carrying real ``__module__`` / ``__name__`` identity.
_REGISTRY_SHAPE_ACCESSORS: dict[str, Callable[[Any], Any]] = {
    "registered_rules": _shape_registered_rules,
    "rules_by_name": _shape_rules_by_name,
    "rules": _shape_rules,
}


#: Module names to try when registering the Usd Optimize rule set, current path
#: first. Both names resolve to the same module object on 1.0.4.
_USD_OPTIMIZE_VALIDATOR_MODULES = ("usd_optimize.validators", "omni.scene.optimizer.validators")


def _register_usd_optimize_rules() -> str | None:
    """Register the Usd Optimize rules into the shared rule registry.

    Importing the package does **not** register anything: the ``@register_rule``
    decorators are applied inside ``register_all()`` (verified on usd-optimize
    1.0.4 — the module body is plain re-exports plus a ``_RULE_CATEGORIES``
    tuple). Without this call the registry holds only the 40 usd-validation-nvidia
    rules and every Usd Optimize concept fails to resolve.

    Entry points do not cover this deployment. usd-validation-nvidia does ship a
    plugin system (``usd_validation_nvidia/_plugins.py``, entry-point group
    ``usd_validation_nvidia``, objects with ``on_startup()``/``on_shutdown()``),
    but it discovers plugins through ``importlib.metadata``, which reads
    *installed distribution* metadata. The skill consumes Usd Optimize as an
    extracted release zip on ``PYTHONPATH`` with no dist-info, egg-info, or
    entry_points.txt, so it is structurally invisible to that discovery no matter
    what upstream declares. Explicit registration is the only mechanism
    available in this deployment shape.

    ``register_all()`` is idempotent (it skips rules that already have a
    category), so calling it on every enumeration is safe. Returns the module
    name that registered, or ``None`` when Usd Optimize is not installed.
    """
    for module_name in _USD_OPTIMIZE_VALIDATOR_MODULES:
        try:
            importlib.import_module(module_name).register_all()
            return module_name
        except (ImportError, AttributeError):
            continue
    return None


def iter_registered_rules(rule_registry: Any) -> Iterable[type]:
    """Yield every registered rule *class* (collision-aware enumeration).

    Identity lives on the class as ``__module__`` and ``__name__``. This adapts
    to the differing registry shapes across runtimes but never collapses rules
    to bare names. Fail-closed: if no enumeration entry point is found, raises.
    """
    _register_usd_optimize_rules()

    # Probe the known registry shapes in order via the explicit allowlist above;
    # the first accessor to yield a non-None result wins. Matching stays
    # identity-based below (never collapsed to bare names).
    rules = None
    for accessor in _REGISTRY_SHAPE_ACCESSORS.values():
        rules = accessor(rule_registry)
        if rules is not None:
            break
    if rules is None:
        raise ValidationRuntimeUnavailable(
            "Could not enumerate registered rules from the runtime registry; the "
            "registry API shape is unrecognized. Record the gap rather than guessing."
        )

    for rule in rules:
        try:
            rule_cls = rule.rule  # unwrap registration wrappers
        except AttributeError:
            rule_cls = rule
        if isinstance(rule_cls, type):
            yield rule_cls


def resolve_rule_class(
    rule_registry: Any,
    module: str,
    class_name: str,
    *,
    module_aliases: Iterable[str] = (),
) -> type:
    """Resolve ``(module, class_name)`` to exactly one registered rule class.

    This is the collision-safe core. Before usd-optimize 1.3,
    ``IndexedPrimvarChecker`` existed twice by bare name; such a pair is
    disambiguated here by the *provider family* of ``module``, never by bare
    name.

    Matching is deliberately version-tolerant. An exact ``__module__`` hit wins.
    Failing that, any registered class of the same name whose module belongs to
    the same provider family as the requested one is accepted — so a submodule
    reshuffle or a package rename inside a family (``omni.asset_validator._base_rules``
    -> ``usd_validation_nvidia.rules._basic``) resolves without a registry edit,
    while a *cross-family* class of the same name never does. A module outside
    every known family falls back to exact matching only.

    Fail-closed: zero matches raises, and more than one distinct class raises.
    """
    accepted_modules = {module, *module_aliases}
    accepted_families = {f for f in map(module_family, accepted_modules) if f}

    same_name = [
        rule_cls
        for rule_cls in iter_registered_rules(rule_registry)
        if rule_cls.__name__ == class_name
    ]
    matches: list[type] = []
    for rule_cls in same_name:
        if rule_cls.__module__ in accepted_modules or (
            accepted_families and module_family(rule_cls.__module__) in accepted_families
        ):
            if not any(rule_cls is seen for seen in matches):
                matches.append(rule_cls)

    if not matches:
        near = sorted(f"{c.__module__}.{c.__name__}" for c in same_name)
        raise ConceptResolutionError(
            f"Rule not registered in this runtime: {module}.{class_name}. "
            f"Registered classes named '{class_name}': {near or 'none'}. "
            f"If the list is empty the providing package was never imported "
            f"(Usd Optimize rules need register_all(), not a bare import); if it "
            f"is non-empty the registry's module identity has drifted out of the "
            f"'{module_family(module) or 'unknown'}' provider family — update "
            f"validator-concepts.json 'module' and keep the old path in "
            f"'module_aliases'."
        )
    if len(matches) > 1:
        found = sorted(f"{c.__module__}.{c.__name__}" for c in matches)
        raise ConceptResolutionError(
            f"Ambiguous rule identity: {module}.{class_name} matched "
            f"{len(matches)} registered classes: {found}."
        )
    return matches[0]


# --------------------------------------------------------------------------- #
# Scoped stage open                                                            #
# --------------------------------------------------------------------------- #
def open_scoped_stage(stage_path: str, mask_paths: list[str] | None = None) -> Any:
    """Open a stage, optionally masked to exactly ``mask_paths`` and their ancestors.

    ``Usd.Stage.OpenMasked()`` is the only reliable scoping mechanism for the
    usd-validation-nvidia (it discards caller ``StageLoadRules`` but preserves the
    population mask). Rejects an empty masked sample so the caller never reports
    a misleading "0 findings".
    """
    from pxr import Sdf, Usd, UsdGeom  # deferred runtime import

    if not mask_paths:
        return Usd.Stage.Open(stage_path)

    root_layer = Sdf.Layer.FindOrOpen(stage_path)
    mask = Usd.StagePopulationMask()
    # USD includes ancestors of requested paths. Adding defaultPrim would
    # include its entire subtree and silently turn this into a whole-stage scan.
    for path in mask_paths:
        if path:
            mask.Add(path)

    stage = Usd.Stage.OpenMasked(root_layer, mask)

    mesh_count = sum(
        1
        for prim in Usd.PrimRange.Stage(
            stage, Usd.TraverseInstanceProxies(Usd.PrimDefaultPredicate)
        )
        if prim.IsA(UsdGeom.Mesh)
    )
    if mesh_count == 0:
        raise RuntimeError("masked validation sample contains no meshes")
    return stage


# --------------------------------------------------------------------------- #
# Selected validation                                                          #
# --------------------------------------------------------------------------- #
def validate_concepts(
    stage_path: str,
    concepts: list[str],
    *,
    registry: dict[str, Any] | None = None,
    mask_paths: list[str] | None = None,
    provider: str | None = None,
) -> list[Any]:
    """Run the named canonical concepts on a (optionally masked) stage.

    Enables exactly the resolved rule classes — never ``init_rules=True`` — so
    only the selected concepts execute. Intended to be invoked once per Tier 1
    batch, and from a bounded ``subprocess`` per target for Tier 2 / Tier 3 so
    a slow C++ rule can be killed by the parent (see the runner README).

    Returns the list of issues. Resolution failures fail closed; a missing
    runtime raises ``ValidationRuntimeUnavailable``.
    """
    reg = registry if registry is not None else load_registry()
    rule_registry = get_rule_registry()
    engine_cls = get_validation_engine_cls()

    engine = engine_cls(init_rules=False)
    for canonical_name in concepts:
        impl = resolve_implementation(reg, canonical_name, provider=provider)
        rule_cls = resolve_rule_class(
            rule_registry,
            impl.module,
            impl.class_name,
            module_aliases=impl.module_aliases,
        )
        engine.enable_rule(rule_cls)

    stage = open_scoped_stage(stage_path, mask_paths)
    return list(engine.validate(stage).issues())


# --------------------------------------------------------------------------- #
# Coverage ledger + completion gate                                           #
# --------------------------------------------------------------------------- #
def coverage_complete(
    planned_targets: list[dict[str, Any]],
    ledger_entries: list[dict[str, Any]],
) -> bool:
    """The completion gate.

    Returns True only when every planned ``(target, concept)`` has a ledger
    entry with a resolved status. This is what prevents an agent from declaring
    victory while a flagged Tier 3 probe was silently skipped: an unresolved
    target has no entry, so the gate stays closed and the report's
    ``coverage_ledger.complete`` is False.
    """
    planned = {
        (t["target"], t["concept"])
        for tgt in planned_targets
        for t in _expand_target(tgt)
    }
    covered = {
        (e["target"], e["concept"])
        for e in ledger_entries
        if e["status"] in RESOLVED_STATUSES
    }
    return planned.issubset(covered)


def _iter_execution_units(
    target: dict[str, Any],
) -> Iterable[tuple[dict[str, str], list[str]]]:
    """Yield ``(ledger_unit, mask_paths)`` for each concrete path/pair in a target.

    The mask is built **per unit** so every probe is scoped to exactly its own
    geometry — and, critically, a ``pairs`` entry contributes *both* prim paths
    to the mask. (The earlier code derived the mask from ``paths``/``mask_paths``
    only, so a pairs-only spatial target produced an empty mask and silently ran
    the approval-gated full stage while the ledger logged it as a scoped probe.)

    A target with no concrete paths/pairs yields a single whole-stage unit with
    an empty mask; ``run_scope_note`` permits that only for ``whole_stage``
    concepts and otherwise fails closed.
    """
    concept = target["concept"]
    singles = list(target.get("paths", [])) + list(target.get("mask_paths", []))
    pairs = [list(p) for p in target.get("pairs", [])]
    produced = False
    for path in singles:
        produced = True
        yield {"target": path, "concept": concept}, [path]
    for pair in pairs:
        produced = True
        yield {"target": "::".join(pair), "concept": concept}, list(pair)
    if not produced:
        yield {"target": "<whole_stage>", "concept": concept}, []


def assert_targets_cover_concepts(scope_note: dict[str, Any]) -> None:
    """Fail closed when a selected concept has no ``targets[]`` entry to execute it.

    ``concepts[]`` is what Deterministic Selection produced; ``targets[]`` is the
    only list the executor iterates. Nothing else ties them together, so a scope
    note that lists all 15 whole-stage safety gates under ``concepts[]`` and
    writes one target used to execute one gate and still report
    ``coverage_ledger.complete: true`` / ``summary.status: PASS`` — silently, with
    14 correctness preconditions never run. The completion gate only counts what
    was planned as a target, so it cannot see the gap; this check can.

    Raises ``ScopeNoteContractError`` naming every unexecuted concept.
    """
    selected = list(scope_note.get("concepts", []))
    targeted = {t["concept"] for t in scope_note.get("targets", [])}
    missing = sorted(set(selected) - targeted)
    if missing:
        raise ScopeNoteContractError(
            f"Scope note selects {len(selected)} concept(s) but "
            f"{len(missing)} of them have no targets[] entry, so they would "
            f"never execute while the coverage ledger still reported complete: "
            f"{', '.join(missing)}. Add one targets[] entry per selected concept "
            f"(whole-stage concepts need only {{'concept': '<name>'}}), or drop "
            f"the concept from concepts[] with the reason in selection_reason."
        )


def _expand_target(target: dict[str, Any]) -> Iterable[dict[str, str]]:
    """Yield one ``{target, concept}`` per concrete path/pair (ledger identity).

    Shares its expansion with execution via ``_iter_execution_units`` so the
    completion gate and the executor can never disagree about what was planned.
    """
    for unit, _mask in _iter_execution_units(target):
        yield unit


def run_scope_note(
    stage_path: str,
    scope_note: dict[str, Any],
    *,
    registry: dict[str, Any] | None = None,
    concept_runner: Callable[..., list[Any]] | None = None,
    phase: str = "baseline",
    provider: str | None = None,
) -> dict[str, Any]:
    """Execute a scope note tier-by-tier and build a schema-valid report.

    ``concept_runner(stage_path, concept, mask_paths=...) -> issues`` is
    injectable so Tier 2/3 work can be wrapped in a killable subprocess (see the
    runner README's driver section). The default runs in-process via
    ``validate_concepts``; for Tier 2/3 the caller should pass a subprocess
    driver so one slow C++ rule cannot hang the batch.

    Each target's disposition is recorded in the coverage ledger:
      - issues found        -> ``probed_with_findings``
      - clean               -> ``probed_clean``
      - subprocess timeout  -> ``timeout_recorded`` (retry masked/standalone)
      - runtime unavailable -> ``blocked_validation_runtime``
    Resolution failures (unknown/ambiguous concept) are NOT swallowed — they
    raise, because they indicate a malformed plan, not a runtime condition. So
    does a scope note whose ``concepts[]`` selection is not fully covered by
    ``targets[]`` (see ``assert_targets_cover_concepts``); that check runs before
    any validator, so a note that would under-execute never produces a report.
    """
    assert_targets_cover_concepts(scope_note)
    reg = registry if registry is not None else load_registry()
    run = concept_runner if concept_runner is not None else validate_concepts

    validators: list[dict[str, Any]] = []
    ledger: list[dict[str, Any]] = []
    error_count = 0

    for target in scope_note.get("targets", []):
        concept = target["concept"]
        impl = resolve_implementation(reg, concept, provider=provider)  # fail-closed
        base_entry = {
            "name": concept,
            "kind": "rule",
            "canonical_name": concept,
            "module": impl.module,
            "class_name": impl.class_name,
        }
        for unit, mask_paths in _iter_execution_units(target):
            if impl.scope_policy != "whole_stage" and not mask_paths:
                raise ConceptResolutionError(
                    f"Concept '{concept}' has scope_policy '{impl.scope_policy}' but its "
                    f"target supplied no paths or pairs to scope to. A scoped concept "
                    f"must never fall back to an implicit full-stage run; fix the scope "
                    f"note (provide paths/pairs, or use the approved full-sweep path)."
                )
            try:
                issues = run(stage_path, [concept], registry=reg, mask_paths=mask_paths)
            except subprocess.TimeoutExpired:
                validators.append({**base_entry, "status": "TIMEOUT"})
                ledger.append({**unit, "tier": impl.tier, "status": "timeout_recorded"})
                continue
            except ValidationRuntimeUnavailable as exc:
                validators.append({**base_entry, "status": "BLOCKED", "notes": str(exc)})
                ledger.append({**unit, "tier": impl.tier, "status": "blocked_validation_runtime"})
                continue
            count = len(issues)
            error_count += count
            validators.append({**base_entry, "status": "FAIL" if count else "PASS", "issues": count})
            ledger.append({
                **unit,
                "tier": impl.tier,
                "status": "probed_with_findings" if count else "probed_clean",
            })

    complete = coverage_complete(scope_note.get("targets", []), ledger)
    # A planned unit that never ran cannot contribute a finding, so error_count
    # stays 0 and every clean-looking aggregate would read PASS. Gate on what was
    # actually validated, not merely on what was dispositioned.
    all_validated = bool(ledger) and all(e["status"] in VALIDATED_STATUSES for e in ledger)
    return {
        "schemaVersion": "1.0.0",
        "phase": phase,
        "stage": {"identifier": stage_path},
        "validators": validators,
        "summary": {
            "status": (
                "BLOCKED"
                if not complete or not all_validated
                else ("FAIL" if error_count else "PASS")
            ),
            "errorCount": error_count,
            "warningCount": 0,
        },
        "coverage_ledger": {"complete": complete, "entries": ledger},
    }


# --------------------------------------------------------------------------- #
# Subprocess runner (killable Tier 2 / Tier 3)                                 #
# --------------------------------------------------------------------------- #
def subprocess_concept_runner(
    *,
    timeout_seconds: int = 120,
    python_executable: str | None = None,
    registry_path: str | Path | None = None,
) -> Callable[..., list[Any]]:
    """Build a ``concept_runner`` that runs each concept in a child process.

    Tier 2 / Tier 3 rules are C++-heavy and can hang; Python ``signal``/threads
    cannot interrupt them. Running each concept in a child process means the
    parent can kill it on timeout. Pass the returned callable as
    ``run_scope_note(..., concept_runner=subprocess_concept_runner())``.

    The child is invoked as ``python <this file>`` with a JSON job on stdin and
    a JSON result on stdout — an internal worker protocol, not a CLI: there are
    no rule-selection flags. On timeout, ``subprocess.TimeoutExpired`` propagates
    (``run_scope_note`` records ``timeout_recorded``). A child that reports the
    runtime missing raises ``ValidationRuntimeUnavailable``.
    """
    import os
    import sys

    # Pin the child command so neither the interpreter nor the script can be
    # redirected by external (job) input. The interpreter defaults to the
    # current ``sys.executable``; the worker is *always* this executor module's
    # own resolved path — it never derives from the job payload. Validate both
    # up front so ``[executable, worker]`` passed to ``subprocess.run`` is a
    # fixed, vetted command.
    executable = python_executable or sys.executable
    if not isinstance(executable, str) or not executable:
        raise ValueError("python_executable must be a non-empty path string")
    # The worker is always this executor module's own resolved path; it is never
    # job-derived, so the command stays fixed regardless of stdin input.
    worker_path = Path(__file__).resolve()
    if not worker_path.is_file():  # pragma: no cover - defensive
        raise RuntimeError(f"validation worker path does not resolve to a file: {worker_path}")
    worker = str(worker_path)

    def _runner(stage_path, concepts, *, registry=None, mask_paths=None):
        request_payload = json.dumps(
            {
                "stage_path": stage_path,
                "concept": concepts[0],
                "mask_paths": mask_paths or [],
                "registry_path": str(registry_path) if registry_path else None,
            }
        )
        # Build the child environment from an explicit allowlist rather than
        # copying os.environ wholesale. Bulk environment copies sweep up every
        # unrelated credential in the parent process, and the NVSkills Tier 1
        # scan blocks on them (E2, "Env Variable Harvesting") -- correctly, since
        # this worker has no need for anything outside the names below.
        #
        # Each entry is here because something downstream reads it: USD_OPTIMIZE_ROOT
        # resolves the extracted release package, LD_LIBRARY_PATH and PYTHONHOME
        # keep a relocated interpreter able to find its own runtime, PATH and the
        # temp-dir trio are needed by USD's plugin discovery and scratch writes,
        # and PYTHONPATH is rewritten below regardless. Add names deliberately;
        # do not reinstate a blanket copy.
        #
        # The Windows block is not optional padding. CPython initialises Winsock
        # while importing ``asyncio``, and without SYSTEMROOT the provider cannot
        # be located: the child dies in ``asyncio/_overlapped`` with WinError
        # 10106 before it reads its job, every concept is recorded as
        # ``blocked_validation_runtime``, and no validator runs at all. The first
        # version of this allowlist carried only the POSIX names above and did
        # exactly that on every Windows host.
        env = {
            name: os.environ[name]
            for name in (
                "PATH",
                "HOME",
                "TMPDIR",
                "TEMP",
                "TMP",
                "LD_LIBRARY_PATH",
                "PYTHONHOME",
                "PYTHONPATH",
                "USD_OPTIMIZE_ROOT",
                # Windows: required for interpreter start-up and Winsock init.
                "SYSTEMROOT",
                "SYSTEMDRIVE",
                "WINDIR",
                "COMSPEC",
                "PATHEXT",
                "PROCESSOR_ARCHITECTURE",
                "NUMBER_OF_PROCESSORS",
            )
            if name in os.environ
        }
        env["PYTHONPATH"] = os.pathsep.join(
            [str(Path(worker).parent), env.get("PYTHONPATH", "")]
        )
        completed = subprocess.run(
            [executable, worker],
            input=request_payload,
            capture_output=True,
            text=True,
            timeout=timeout_seconds,
            env=env,
        )
        if completed.returncode != 0:
            raise RuntimeError(
                f"validation worker failed (rc={completed.returncode}): "
                f"{completed.stderr.strip()[:500]}"
            )
        result = json.loads(completed.stdout.strip().splitlines()[-1])
        if result.get("status") == "blocked_validation_runtime":
            raise ValidationRuntimeUnavailable(result.get("detail", "runtime unavailable"))
        return list(result.get("issues", []))

    return _runner


#: The exact set of fields the internal worker job may carry. The stdin payload
#: is an internal protocol, but the input is still untrusted, so ``_validate_job``
#: rejects anything outside this schema before any value is used.
_JOB_ALLOWED_KEYS = frozenset({"stage_path", "concept", "mask_paths", "registry_path"})


def _validate_job(job: Any) -> dict[str, Any]:
    """Validate/normalize the untrusted stdin job against the worker schema.

    Fail-closed on shape, unexpected/missing fields, and wrong types. Returns a
    normalized dict with exactly the four known keys so the caller can index it
    directly. This is the trust boundary for the child process (the job arrives
    as JSON on stdin from ``subprocess_concept_runner``).
    """
    if not isinstance(job, dict):
        raise ValueError(f"job must be a JSON object, got {type(job).__name__}")
    unexpected = set(job) - _JOB_ALLOWED_KEYS
    if unexpected:
        raise ValueError(f"job has unexpected field(s): {sorted(unexpected)}")

    stage_path = job.get("stage_path")
    if not isinstance(stage_path, str) or not stage_path:
        raise ValueError("job['stage_path'] must be a non-empty string")

    concept = job.get("concept")
    if not isinstance(concept, str) or not concept:
        raise ValueError("job['concept'] must be a non-empty string")

    mask_paths = job.get("mask_paths", [])
    if mask_paths is None:
        mask_paths = []
    if not isinstance(mask_paths, list) or not all(
        isinstance(p, str) and p for p in mask_paths
    ):
        raise ValueError("job['mask_paths'] must be a list of non-empty strings")

    registry_path = job.get("registry_path")
    if registry_path is not None and (not isinstance(registry_path, str) or not registry_path):
        raise ValueError("job['registry_path'] must be a non-empty string or null")

    return {
        "stage_path": stage_path,
        "concept": concept,
        "mask_paths": mask_paths,
        "registry_path": registry_path,
    }


def _worker_main() -> int:
    """Child entrypoint: read one JSON job from stdin, print a JSON result.

    Internal protocol used by ``subprocess_concept_runner`` — not a user CLI.
    """
    import sys

    job = _validate_job(json.loads(sys.stdin.read()))
    registry = load_registry(job["registry_path"])
    try:
        issues = validate_concepts(
            job["stage_path"],
            [job["concept"]],
            registry=registry,
            mask_paths=job["mask_paths"] or None,
        )
    except ValidationRuntimeUnavailable as exc:
        print(json.dumps({"status": "blocked_validation_runtime", "detail": str(exc)}))
        return 0
    print(json.dumps({"status": "ok", "issues": [str(i) for i in issues]}))
    return 0


if __name__ == "__main__":
    raise SystemExit(_worker_main())

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs Python, Needs Node.js

The author says: Requires a verified standalone Usd Optimize/OpenUSD runtime for operations, usd-validation-nvidia for supported checks, and a writable output workspace. Remote assets require a working resolver. Render profiling is an external handoff.

Security

What our scanner noticed· Medium risk

  • Large base64-encoded blobs
  • Scripts that your agent may run

This skill includes scripts that your agent may run. Read them before you use it.

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
NVIDIA Omniverse
Publisher
NVIDIA (Official)
Source
NVIDIA/skills · skills/omniverse-usd-performance-tuning · commit fce3cca
Licence
Apache License 2.0 (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE-APACHE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by NVIDIA Omniverse or NVIDIA.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download omniverse-usd-performance-tuning.zip