Eve library

ISIS v2 Weapon Pack Canonical Requirements Brief

Guide

Revision 1

On this page

Generated: 2026-02-28T22:18:56.105Z Checklist: MXA-0235 (ISIS2-00433) Asset Family: weapon-pack Phase: Phase 4 | Milestone: M3 Launch (2026-07-27 to 2026-10-30)

Objective#

Define a canonical implementation contract for weapon-pack so workflow design, contract exposure, operational rollout, and quality certification execute with measurable, release-gated criteria.

Scope#

In Scope#

  • Workflow family requirements spanning baseline, conditioned, and consistency-locked variants.
  • Control, consistency, output package, and surface parity requirements.
  • Success metrics and explicit failure criteria tied to Matrix A delivery tickets.

Out of Scope#

  • Implementation details for non-prop-pack asset families.
  • Provider-specific low-level node wiring beyond declared dependency/control contracts.

Baseline Assessment#

  • Related baseline workflow count: 5
  • Missing required controls in related baseline: ipadapter-style, ipadapter-composition, controlnet-canny, controlnet-lineart
  • Current control-mode pass rate (global baseline): 0.00%
  • Current required control quality average (selected controls): 0.306
Workflow ID Asset Family Output Profile Controls
sfx-sound-designer film-vfx-element-library audio-master-profile seed-lock, sampler-scheduler-lock, model-lock, prompt-template-lock, style-lock, color-script-lock
mandala-3d game-pbr-texture-material-set game-ready-3d-profile seed-lock, sampler-scheduler-lock, model-lock, prompt-template-lock, controlnet-depth, controlnet-normal, controlnet-tile, lens-profile-lock, style-lock, color-script-lock
3d-texture game-pbr-texture-material-set game-ready-3d-profile seed-lock, sampler-scheduler-lock, model-lock, prompt-template-lock, controlnet-depth, controlnet-normal, controlnet-tile, style-lock, color-script-lock
environment-map game-skybox-hdri-pack game-ready-3d-profile seed-lock, sampler-scheduler-lock, model-lock, prompt-template-lock, controlnet-depth, lens-profile-lock, style-lock, color-script-lock
animatediff-controlnet film-previs-blocking-reel video-master-profile seed-lock, sampler-scheduler-lock, model-lock, prompt-template-lock, controlnet-pose, controlnet-depth, controlnet-segmentation, camera-path-guide, motion-vector-lock, temporal-lock, keyframe-anchor-lock, style-lock, identity-lock, color-script-lock

Canonical Requirements#

Output Package Contract Baseline#

Output Class Required Package Classes
preview_image preview, metadata, manifest
source_frames source-frames, metadata, manifest
metadata_manifest metadata, manifest

Required Controls#

Control Category Coverage Baseline Quality Baseline
seed-lock determinism 5 workflows 0.420
sampler-scheduler-lock determinism 5 workflows 0.450
model-lock determinism 5 workflows 0.420
prompt-template-lock determinism 5 workflows 0.425
style-lock style-and-identity 5 workflows 0.450
color-script-lock style-and-identity 5 workflows 0.450
ipadapter-style reference-guidance 0 workflows 0.050
ipadapter-composition reference-guidance 0 workflows 0.300
controlnet-depth spatial-guidance 4 workflows 0.150
controlnet-segmentation spatial-guidance 1 workflows 0.150
controlnet-normal spatial-guidance 2 workflows 0.150
controlnet-canny spatial-guidance 0 workflows 0.400
controlnet-lineart spatial-guidance 0 workflows 0.400
lens-profile-lock camera-and-motion 2 workflows 0.075

Functional Requirements#

ID Checklist Requirement
F-000 MXA-0235 Publish a canonical, machine-readable requirements brief for weapon-pack that defines scope, constraints, success metrics, and failure criteria.
F-001 MXA-0236 Design baseline workflow graph for weapon-pack with deterministic defaults.
F-002 MXA-0237 Design image-conditioned variant workflow for weapon-pack.
F-003 MXA-0238 Design control-conditioned variant workflow for weapon-pack (pose/depth/segmentation where applicable).
F-004 MXA-0239 Design consistency-locked variant workflow for weapon-pack with continuity profile support.
F-005 MXA-0240 Define model/node dependency manifest for weapon-pack workflows.
F-006 MXA-0241 Define output package contract for weapon-pack including file naming and metadata manifest.
F-007 MXA-0242 Add workflow templates and presets for weapon-pack production tiers (draft/final/hero).
F-008 MXA-0243 Expose weapon-pack workflows via generation API with typed request contracts.
F-009 MXA-0244 Expose weapon-pack workflows via SDK with end-to-end examples.
F-010 MXA-0245 Expose weapon-pack workflows in web UI with ergonomic form controls and validation.
F-011 MXA-0246 Implement side-by-side comparison tools for weapon-pack outputs.
F-012 MXA-0247 Map weapon-pack workflows to RunPod endpoint classes and sizing policies.
F-013 MXA-0248 Add weapon-pack cost estimation and budget guardrails.
F-014 MXA-0249 Add weapon-pack quality evaluator and threshold-based acceptance gate.
F-015 MXA-0250 Add weapon-pack regression tests and golden datasets.
F-016 MXA-0251 Add weapon-pack external integration recipe for downstream tools/systems.
F-017 MXA-0252 Publish weapon-pack operator and creator documentation with troubleshooting.

Non-Functional Requirements#

ID Title Verification
NF-001 Deterministic replay reliability Replay the approved golden set over two independent runs and compute reproducibility pass ratio.
NF-002 Control coverage completeness Run contract and UX coverage checks against control IDs: seed-lock, style-lock, color-script-lock, ipadapter-style, ipadapter-composition, controlnet-depth, controlnet-segmentation, controlnet-normal, controlnet-canny, controlnet-lineart, lens-profile-lock.
NF-003 Output package integrity Validate output package contract and checksum manifest presence for each golden output.
NF-004 Operational budget guardrails Evaluate p95 runtime/cost telemetry against policy thresholds and enforce rejection when guardrails fail.
NF-005 External integration readiness Pass external integration cookbook examples and operator runbook smoke checks.

Success Metrics#

Metric Target Baseline Linked Checklist IDs
SM-001 >= 4 certified workflows (baseline, image-conditioned, control-conditioned, consistency-locked). 0 workflows currently mapped to weapon-pack. MXA-0236, MXA-0237, MXA-0238, MXA-0239, MXA-0250
SM-002 17/17 downstream tickets DONE by milestone end date. 0/17 downstream tickets are DONE at report generation. MXA-0236, MXA-0237, MXA-0238, MXA-0239, MXA-0240, MXA-0241, MXA-0242, MXA-0243, MXA-0244, MXA-0245, MXA-0246, MXA-0247, MXA-0248, MXA-0249, MXA-0250, MXA-0251, MXA-0252
SM-003 14/14 required controls implemented and exposed. 10/14 controls currently evidenced in related baseline workflows. MXA-0238, MXA-0243, MXA-0244, MXA-0245
SM-004 Average required-control quality score >= 0.75. Current benchmark baseline: 0.306. MXA-0249, MXA-0250
SM-005 silhouette_iou >= 0.78 and topology_drift_ratio <= 0.12. Not yet measured for weapon-pack baseline (family not implemented). MXA-0239, MXA-0249, MXA-0250
SM-006 material_match_ratio >= 0.90 and surface_detail_delta <= 0.10. Not yet measured for weapon-pack baseline (family not implemented). MXA-0239, MXA-0249, MXA-0250
SM-007 100% of outputs include package classes required by preview_image, source_frames, and metadata_manifest mappings. No dedicated weapon-pack output package contract is currently published. MXA-0241, MXA-0250
SM-008 Typed request/response support and user-facing controls available across generation API, SDK, and web UI with zero schema drift. Prop-pack-general family not yet exposed on API/SDK/UI surfaces. MXA-0243, MXA-0244, MXA-0245

Failure Criteria#

Criterion Trigger Severity Required Response
FC-001 Any of baseline, image-conditioned, control-conditioned, or consistency-locked variants is absent or uncertified. high Block promotion and complete missing variant tickets before reopening certification.
FC-002 Any required control ID is missing from workflow metadata or is not exposed consistently in API/SDK/UI. high Fail contract parity checks and block release until missing control contracts and UI exposure are restored.
FC-003 Environment, lighting, lens, or color-script continuity metrics fail taxonomy thresholds across approved golden datasets. high Reject quality gate, retune workflows/models, and rerun regression benchmark until thresholds pass.
FC-004 Generated outputs are missing required package classes or manifest/checksum artifacts. high Fail output package validation and block external integrations until packaging contract is restored.
FC-005 Cost estimation or runtime sizing exceeds approved guardrails without explicit override policy. medium Apply hard-fail guardrail behavior and reclassify endpoint sizing before allowing additional runs.
FC-006 Golden dataset or regression suite detects perceptual drift above accepted threshold. high Mark build as non-releasable, investigate drift root cause, and refresh certification evidence only after pass.

Downstream Delivery Map#

Ticket Checklist Status Title
ISIS2-00434 MXA-0236 TODO Design baseline workflow graph for weapon-pack with deterministic defaults.
ISIS2-00435 MXA-0237 TODO Design image-conditioned variant workflow for weapon-pack.
ISIS2-00436 MXA-0238 TODO Design control-conditioned variant workflow for weapon-pack (pose/depth/segmentation where applicable).
ISIS2-00437 MXA-0239 TODO Design consistency-locked variant workflow for weapon-pack with continuity profile support.
ISIS2-00438 MXA-0240 TODO Define model/node dependency manifest for weapon-pack workflows.
ISIS2-00439 MXA-0241 TODO Define output package contract for weapon-pack including file naming and metadata manifest.
ISIS2-00440 MXA-0242 TODO Add workflow templates and presets for weapon-pack production tiers (draft/final/hero).
ISIS2-00441 MXA-0243 TODO Expose weapon-pack workflows via generation API with typed request contracts.
ISIS2-00442 MXA-0244 TODO Expose weapon-pack workflows via SDK with end-to-end examples.
ISIS2-00443 MXA-0245 TODO Expose weapon-pack workflows in web UI with ergonomic form controls and validation.
ISIS2-00444 MXA-0246 TODO Implement side-by-side comparison tools for weapon-pack outputs.
ISIS2-00445 MXA-0247 TODO Map weapon-pack workflows to RunPod endpoint classes and sizing policies.
ISIS2-00446 MXA-0248 TODO Add weapon-pack cost estimation and budget guardrails.
ISIS2-00447 MXA-0249 TODO Add weapon-pack quality evaluator and threshold-based acceptance gate.
ISIS2-00448 MXA-0250 TODO Add weapon-pack regression tests and golden datasets.
ISIS2-00449 MXA-0251 TODO Add weapon-pack external integration recipe for downstream tools/systems.
ISIS2-00450 MXA-0252 TODO Publish weapon-pack operator and creator documentation with troubleshooting.

Traceability#

  • Checklist item: MXA-0235
  • Ticket key: ISIS2-00433
  • Source references:
    • docs/domains/isis/remediation-v2/ISIS_REMEDIATION_V2_TICKETS.json
    • docs/domains/isis/remediation-v2/ISIS_V2_ASSET_TAXONOMY.json
    • docs/domains/isis/remediation-v2/ISIS_V2_CONTROL_TAXONOMY.json
    • docs/domains/isis/remediation-v2/ISIS_V2_CONSISTENCY_TAXONOMY.json
    • docs/domains/isis/remediation-v2/ISIS_V2_OUTPUT_PACKAGE_TAXONOMY.json
    • libs/isis/workflows/src/metadata/workflow-taxonomy-registry.json
    • docs/domains/isis/remediation-v2/ISIS_V2_BENCHMARK_DASHBOARD.json
    • ISIS_TODOS_2.md