Nv Generate Vae Finetune
NVIDIAOfficialCreated by NVIDIA MedTech Team
- Skill
- Workflow
- Software development
- Apache-2.0
- Medium risk
- Has scripts
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides a wrapper for finetuning the NV-Generate-CTMR MAISI VAE/autoencoder. It manages the configuration and execution flow by staging required JSON files and providing a CLI interface to interact with upstream helper APIs. It supports preflight validation of datalists and GPU-based training, while handling output bookkeeping for checkpoints and TensorBoard logs. This tool is intended for research and development workflows and is not for clinical or production data approval.
What it does
- Stages configuration and environment files for VAE finetuning.
- Validates input datalists and data directories via a preflight check.
- Executes GPU-based finetuning of the MAISI VAE model.
- Exposes configurable hyperparameters for training, such as epochs, patch size, and loss weights.
- Generates TensorBoard logs and summary JSON files for training monitoring.
- Saves autoencoder and discriminator checkpoints for downstream evaluation.
When to use it
- When you need to finetune a MAISI VAE model on custom CT or MRI NIfTI datasets.
- When you need to validate the structure of a training datalist before initiating a training run.
- When you need to monitor training progress through TensorBoard scalars and loss history.
- When you need to adjust training parameters like perceptual weight or learning rate for specific data.
Advantages
- Simplifies the configuration process by automating the staging of upstream JSON files.
- Provides a consistent CLI interface for both preflight checks and full training runs.
- Integrates with TensorBoard for tracking loss metrics and validation performance.
- Allows for flexible hyperparameter tuning to address common issues like reconstruction blurriness.
Usage examples
- “Run a preflight check on my MRI dataset located in /data/mri_bundle.”
- The skill validates the datalist and dataset structure without starting a GPU training job.
- “Finetune the VAE model on my CT data for 5 epochs.”
- The skill initiates the training process using the provided datalist, saving checkpoints and logs to the specified output directory.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/nvidia/nv-generate-vae-finetune/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip nv-generate-vae-finetune.zip -d .agents/skills
Documentation by NVIDIA MedTech Team
NV-Generate-VAE-Finetune
Purpose
Used for finetuning the NV-Generate-CTMR MAISI VAE/autoencoder from user-supplied CT or MRI NIfTI training volumes.
Not for clinical interpretation, regulatory use, or approving synthetic data for production training.
Upstream currently documents VAE training in
train_vae_tutorial.ipynband provides configs/helpers, but not ascripts.train_vaeCLI. This skill does not execute the notebook; it stages the required config/datalist glue locally and uses upstream helper APIs.Manifest I/O: inputs are
datalistanddata_base_dir; outputs areautoencoder_checkpoint,discriminator_checkpoint, andresult_json.The underlying training contract is the upstream config/env JSON (
config_maisi_vae_train.json+environment_maisi_vae_train.json, as used intrain_vae_tutorial.ipynb). The wrapper stages those JSON files for you and exposes the most-tuned fields as CLI flags; the sections below document the fields, their defaults, and how to monitor/tune a run.
Instructions
Read
skill_manifest.yamlbefore changing arguments, side effects, or validation gates.Run
scripts/run_vae_finetune.pyfrom the Medical AI Skills repo root.If a host agent exposes
run_script, userun_script("scripts/run_vae_finetune.py", args=[...]); otherwise run the Bash/Python command below.Use
--preflightfirst when checking a new datalist; remove--preflightonly when the user explicitly wants to launch GPU finetuning.For a staged preflight input bundle directory, use
BUNDLE/preflight_datalist.jsonas the datalist andBUNDLE/preflight_datasetas--data-base-dirwhen those files are present.
Examples
Validate and stage a preflight finetune check from an input bundle (the recommended first step — no GPU, no training). This is the single canonical command; replace INPUT_BUNDLE and OUT_DIR with your paths:
export NV_GENERATE_ROOT="${NV_GENERATE_ROOT:-$HOME/.cache/nvidia-skills/upstreams/NV-Generate-CTMR-61c4ec7}" && \
python skills/nv-generate-vae-finetune/scripts/run_vae_finetune.py \
INPUT_BUNDLE/preflight_datalist.json \
--data-base-dir INPUT_BUNDLE/preflight_dataset \
--output-dir OUT_DIR \
--modality mri \
--preflightFor real GPU finetuning and other variations, see Usage below.
Available Scripts
| Script | Purpose | Arguments |
|---|---|---|
scripts/run_vae_finetune.py | Primary entrypoint declared by skill_manifest.yaml. | DATALIST.json --data-base-dir DATA_DIR --output-dir OUT_DIR [--epochs N] [--modality mri] [--patch-size 64,64,64] [--preflight] |
Prerequisites
An explicit
NV_GENERATE_ROOTmay point to the caller's local checkout and must containconfigs/config_maisi_vae_train.json,scripts/transforms.py, andscripts/utils.py. The result records its current commit.If
NV_GENERATE_ROOTis unset, the wrapper searches.workbench_data/upstreams/NV-Generate-CTMR.CUDA_VISIBLE_DEVICESis optional and can be used to select the GPU for real training.Runtime requirements: NVIDIA CUDA GPU for real training, Python packages from the upstream
requirements.txt,lpips, and downloaded VAE weights unless using--train-from-scratch.Side effects: writes staged configs, checkpoints, TensorBoard logs, and run summaries under the caller-provided
--output-dir; may write model caches under the upstream checkout,~/.cache/huggingface/, and~/.cache/torch/; may contacthttps://huggingface.co,https://github.com, andhttps://download.pytorch.org.The datalist is a MONAI-style JSON object with non-empty
training[]andvalidation[]ortesting[]. Each entry has animagepath relative to--data-base-dirand optionalclassormodalityofctormri.
When no local checkout is supplied, create the recommended pinned default checkout once:
if [ -z "${NV_GENERATE_ROOT:-}" ]; then
export NV_GENERATE_COMMIT=61c4ec709b84cad468852243c48e250bec732074
export NV_GENERATE_ROOT="$HOME/.cache/nvidia-skills/upstreams/NV-Generate-CTMR-61c4ec7"
if [ ! -d "$NV_GENERATE_ROOT/.git" ]; then
git clone https://github.com/NVIDIA-Medtech/NV-Generate-CTMR.git "$NV_GENERATE_ROOT"
git -C "$NV_GENERATE_ROOT" checkout --detach "$NV_GENERATE_COMMIT"
fi
fi1. Config and environment JSON (adapt to your data)
The wrapper copies the upstream VAE config/env JSON from $NV_GENERATE_ROOT/configs, rewrites the fields below, and writes the staged copies under OUT_DIR/workflow/configs/. You normally only set your datalist and data root; the listed CLI flags override individual fields when you need to.
Environment JSON (environment_maisi_vae_train.json):
| Field | Set from | Notes |
|---|---|---|
model_dir | --output-dir | Where autoencoder.pt/discriminator.pt and best checkpoints are saved. |
tfevent_path | --output-dir | TensorBoard event directory. |
finetune | --train-from-scratch | true (default) loads trained_autoencoder_path; the flag sets it false. |
trained_autoencoder_path | upstream weights / --trained-autoencoder-path | Starting VAE checkpoint when finetuning. |
Training fields (config_maisi_vae_train.json):
| Field | Flag | Type | Default | Notes |
|---|---|---|---|---|
autoencoder_train.n_epochs | --epochs | int | 1 | |
autoencoder_train.batch_size | --batch-size | int | 1 | Per-GPU (single-GPU runner). |
autoencoder_train.patch_size | --patch-size | int,int,int | 64,64,64 | Training crop. |
autoencoder_train.val_batch_size | --val-batch-size | int | 1 | |
autoencoder_train.val_sliding_window_patch_size | --val-sliding-window-patch-size | int,int,int | 96,96,64 | Sliding-window validation ROI. |
autoencoder_train.lr | --lr | float | 1e-4 | |
autoencoder_train.perceptual_weight | --perceptual-weight | float | 0.3 | LPIPS term. |
autoencoder_train.kl_weight | --kl-weight | float | 1e-7 | KL term. |
autoencoder_train.adv_weight | --adv-weight | float | 0.1 | Adversarial term. |
autoencoder_train.recon_loss | --recon-loss | l1|l2 | l1 | |
autoencoder_train.val_interval | --val-interval | int | 1 | Epochs between validation passes. |
autoencoder_train.cache | --cache-rate | float | 0.0 | MONAI CacheDataset fraction. |
autoencoder_train.amp | --no-amp | flag | on | Mixed precision; flag disables it. |
data_option.random_aug | --no-random-aug | flag | on | Random augmentation; flag disables it. |
data_option.spacing_type | --spacing-type | original|fixed|rand_zoom | original | |
data_option.spacing | --spacing | float,float,float | unset | Required when spacing_type is fixed/rand_zoom. |
data_option.select_channel | --select-channel | int | 0 | Channel for multi-channel inputs. |
--modality (ct or mri, default mri) fills the per-entry class for datalist items missing one. Validation/testing entries are required because the training loop runs a validation pass.
For an end-to-end reference including example data download, see the upstream tutorial train_vae_tutorial.ipynb.
2. Usage (one-line training)
Preflight only:
export NV_GENERATE_ROOT="${NV_GENERATE_ROOT:-$HOME/.cache/nvidia-skills/upstreams/NV-Generate-CTMR-61c4ec7}" && \
python skills/nv-generate-vae-finetune/scripts/run_vae_finetune.py \
PATH_TO_DATALIST.json \
--data-base-dir PATH_TO_DATA_ROOT \
--output-dir runs/nv_generate_vae_finetune_preflight \
--preflightPreflight bundle input:
export NV_GENERATE_ROOT="${NV_GENERATE_ROOT:-$HOME/.cache/nvidia-skills/upstreams/NV-Generate-CTMR-61c4ec7}" && \
python skills/nv-generate-vae-finetune/scripts/run_vae_finetune.py \
PATH_TO_INPUT_BUNDLE/preflight_datalist.json \
--data-base-dir PATH_TO_INPUT_BUNDLE/preflight_dataset \
--output-dir runs/nv_generate_vae_finetune_preflight \
--preflightGPU finetuning:
export NV_GENERATE_ROOT="${NV_GENERATE_ROOT:-$HOME/.cache/nvidia-skills/upstreams/NV-Generate-CTMR-61c4ec7}" && \
python -m pip install -r "$NV_GENERATE_ROOT/requirements.txt" && \
python -m pip install lpips tensorboard && \
python skills/nv-generate-vae-finetune/scripts/run_vae_finetune.py \
PATH_TO_DATALIST.json \
--data-base-dir PATH_TO_DATA_ROOT \
--output-dir runs/nv_generate_vae_finetune \
--epochs 1 \
--modality mri \
--patch-size 64,64,64 \
--download-model-dataReplace PATH_TO_DATALIST.json and PATH_TO_DATA_ROOT with the user's actual paths. Do not use the fixture datalist for real training; it is a preflight-only placeholder.
3. Monitor training (TensorBoard)
The runner writes TensorBoard scalars (per-iteration and per-epoch recons_loss, kl_loss, p_loss, adversarial/real/fake losses, and a validation scale_factor) under OUT_DIR/artifacts/tfevent/autoencoder. Launch TensorBoard against the output directory:
python -m pip install tensorboard && \
tensorboard --logdir runs/nv_generate_vae_finetune/artifacts/tfeventThe same per-epoch loss history is also captured in OUT_DIR/artifacts/workflow_summary.json and echoed in the JSON the wrapper prints to stdout (loss_history, best-checkpoint paths, exit_code, stderr_tail).
4. Hyperparameter tuning and common pitfalls
Reconstructions blurry — raise
--perceptual-weight(default0.3); try--recon-loss l2if edges look washed out.Posterior collapse / over-regularized latents —
--kl-weightis intentionally tiny (1e-7); increasing it too much degrades reconstruction.Adversarial training unstable — lower
--adv-weight(default0.1) or--lr; a warmup schedule already ramps the LR over the first 20 epochs.Out-of-memory — reduce
--patch-size(e.g.48,48,48) and--val-sliding-window-patch-size, keep--batch-size 1, and lower--cache-rate.datalist must include non-empty validation[] or testing[]— the validation loop is mandatory; addvalidation[](ortesting[]) entries.Single-GPU only — the runner asserts exactly one CUDA GPU; set
CUDA_VISIBLE_DEVICESto pick which one.
5. Evaluate the finetuned VAE
Validation reconstruction loss (lowest-val_weighted_loss epoch) is tracked automatically and the best autoencoder is saved as autoencoder_epochN.pt under OUT_DIR/artifacts/models. To evaluate downstream:
Compare validation
recons_loss/p_losscurves across runs in TensorBoard, andPlug the finetuned autoencoder into a diffusion finetune/generation run (e.g.
nv-generate-mr-brain-finetunevia--trained-autoencoder-path) to confirm latents still decode to usable volumes.
This skill gates file accounting and reconstruction bookkeeping only — image quality and downstream utility must be judged by a domain expert.
Limitations
Requires a current upstream
NV-Generate-CTMRcheckout with VAE configs and helper APIs. The skill owns the runner glue and does not depend on the notebook.Full training can be expensive and is not deterministic across hardware, CUDA, and package versions.
The wrapper gates file accounting and command provenance, not anatomical realism, reconstruction quality, or downstream model utility.
Not for clinical deployment, clinical interpretation, autonomous diagnosis, regulatory submission, or production training-data approval.
Troubleshooting
| Error | Cause | Fix |
|---|---|---|
VAE configs/helpers were not found | NV_GENERATE_ROOT does not point at a current NV-Generate-CTMR checkout. | Clone or update https://github.com/NVIDIA-Medtech/NV-Generate-CTMR and set NV_GENERATE_ROOT. |
datalist must include non-empty validation[] or testing[] | VAE training requires validation data for the configured validation loop. | Add validation[] or testing[] entries with relative image paths. |
| CUDA, MONAI, or LPIPS import failure | Runtime environment lacks upstream dependencies. | Install "$NV_GENERATE_ROOT/requirements.txt" plus lpips tensorboard in the selected environment. |
Files
- ATTRIBUTION.mdAdded by AutoGineer943 B
- BENCHMARK.md4.0 KiB
- LICENSELicence file added by AutoGineer11.2 KiB
- SKILL.md12.2 KiB
- evals/evals.json1.2 KiB
- fixtures/README.md232 B
- fixtures/preflight_datalist.json221 B
- fixtures/preflight_dataset/imagesTr/placeholder_mri_train.txt37 B
- fixtures/preflight_dataset/imagesVal/placeholder_mri_val.txt37 B
- scripts/run_vae_finetune.pyScript32.1 KiB
- skill-card.md4.0 KiB
- skill.oms.sig6.4 KiB
- skill_manifest.yaml6.2 KiB
- tests/test_run_vae_finetune.pyScript5.6 KiB
- validators/output_schema.json4.0 KiB
scripts/run_vae_finetune.py
#!/usr/bin/env python3
# SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Wrapper for NV-Generate-CTMR VAE finetuning.
The upstream repository documents VAE training in ``train_vae_tutorial.ipynb``
and provides reusable configs/transforms/utilities, but no dedicated
``scripts.train_vae`` entrypoint. This wrapper stages the same config and
datalist contract into deterministic files, then runs the VAE training loop
against existing upstream helper APIs. It does not execute the notebook.
Engineering verification only. Outputs are not clinically meaningful.
"""
from __future__ import annotations
import argparse
import copy
import json
import os
import subprocess
import sys
import time
from pathlib import Path
from typing import Any
SKILL_NAME = "nv_generate_vae_finetune"
MODEL_NAME = "maisi-vae"
UPSTREAM_REPO = "https://github.com/NVIDIA-Medtech/NV-Generate-CTMR"
UPSTREAM_ENTRYPOINT = "python skills/nv-generate-vae-finetune/scripts/run_vae_finetune.py"
REPO_ROOT = Path(__file__).resolve().parents[3]
DEFAULT_UPSTREAM = REPO_ROOT / ".workbench_data" / "upstreams" / "NV-Generate-CTMR"
REQUIRED_UPSTREAM_FILES = (
"scripts/download_model_data.py",
"scripts/transforms.py",
"scripts/utils.py",
"configs/config_network_rflow.json",
"configs/environment_maisi_vae_train.json",
"configs/config_maisi_vae_train.json",
)
SUPPORTED_MODALITIES = ("ct", "mri")
def _emit(payload: dict[str, Any]) -> None:
sys.stdout.write(json.dumps(payload, indent=2))
sys.stdout.flush()
def _tail(text: str, n_chars: int = 4000) -> str:
return text if len(text) <= n_chars else "..." + text[-n_chars:]
def _load_json(path: Path) -> Any:
return json.loads(path.read_text())
def _write_json(path: Path, payload: dict[str, Any]) -> Path:
path.parent.mkdir(parents=True, exist_ok=True)
path.write_text(json.dumps(payload, indent=2, sort_keys=True) + "\n")
return path
def _parse_triplet(value: str, cast: type = int) -> list[Any]:
parts = [cast(v.strip()) for v in value.split(",")]
if len(parts) != 3:
raise argparse.ArgumentTypeError("expected three comma-separated values")
return parts
def _normalize_modality(value: str) -> str:
lower = value.lower()
if lower == "ct":
return "ct"
if lower == "mri" or lower.startswith("mri_"):
return "mri"
raise ValueError(f"unsupported modality {value!r}; expected ct or mri")
def _resolve_upstream_root(explicit: str | None = None) -> tuple[Path | None, list[str]]:
candidates: list[Path] = []
if explicit:
candidates.append(Path(explicit).expanduser())
env_root = os.environ.get("NV_GENERATE_ROOT")
if env_root:
candidates.append(Path(env_root).expanduser())
candidates.extend([DEFAULT_UPSTREAM, Path.home() / "NV-Generate-CTMR"])
checked: list[str] = []
seen: set[str] = set()
for candidate in candidates:
resolved = candidate.resolve()
key = str(resolved)
if key in seen:
continue
seen.add(key)
checked.append(key)
if all((resolved / rel).is_file() for rel in REQUIRED_UPSTREAM_FILES):
return resolved, checked
return None, checked
def _resolve_data_path(data_base_dir: Path, image: str) -> Path:
image_path = Path(image)
if image_path.is_absolute():
raise ValueError("datalist image paths must be relative to --data-base-dir")
return data_base_dir / image_path
def _split_entries(raw: dict[str, Any]) -> tuple[list[dict[str, Any]], list[dict[str, Any]]]:
training = raw.get("training")
validation = raw.get("validation", raw.get("testing", raw.get("val", [])))
if not isinstance(training, list) or not training:
raise ValueError("datalist.training must be a non-empty list")
if not isinstance(validation, list) or not validation:
raise ValueError("datalist must include non-empty validation[] or testing[] entries")
return training, validation
def _validate_datalist(
data_base_dir: Path, datalist: Path, default_modality: str
) -> dict[str, Any]:
default_class = _normalize_modality(default_modality)
raw = _load_json(datalist)
if not isinstance(raw, dict):
raise ValueError("datalist must be a JSON object")
training, validation = _split_entries(raw)
missing: list[str] = []
classes: set[str] = set()
for split_name, entries in (("training", training), ("validation", validation)):
for i, item in enumerate(entries):
if not isinstance(item, dict) or "image" not in item:
raise ValueError(f"{split_name}[{i}] must contain image")
modality = _normalize_modality(
str(item.get("class", item.get("modality", default_class)))
)
image_path = _resolve_data_path(data_base_dir, str(item["image"]))
if not image_path.is_file():
missing.append(str(image_path))
classes.add(modality)
if missing:
raise FileNotFoundError(f"missing datalist image(s): {missing[:5]}")
return {
"data_base_dir": str(data_base_dir),
"datalist": str(datalist),
"training_cases": len(training),
"validation_cases": len(validation),
"modalities": sorted(classes),
"default_modality": default_class,
}
def _stage_entries(
data_base_dir: Path,
entries: list[dict[str, Any]],
default_modality: str,
) -> list[dict[str, Any]]:
staged: list[dict[str, Any]] = []
for item in entries:
next_item = dict(item)
next_item["image"] = str(
_resolve_data_path(data_base_dir, str(next_item["image"])).resolve()
)
next_item["class"] = _normalize_modality(
str(next_item.get("class", next_item.get("modality", default_modality)))
)
next_item.pop("modality", None)
staged.append(next_item)
return staged
def _stage_datalist(
data_base_dir: Path,
input_path: Path,
output_path: Path,
default_modality: str,
) -> tuple[Path, dict[str, Any]]:
raw = _load_json(input_path)
training, validation = _split_entries(raw)
staged = {
"training": _stage_entries(data_base_dir, training, default_modality),
"validation": _stage_entries(data_base_dir, validation, default_modality),
}
return _write_json(output_path, staged), staged
def _git_commit(root: Path) -> str:
try:
proc = subprocess.run(
["git", "rev-parse", "HEAD"],
cwd=str(root),
check=False,
capture_output=True,
text=True,
timeout=10,
)
except Exception:
return ""
return proc.stdout.strip() if proc.returncode == 0 else ""
def _resolve_from_upstream(upstream_root: Path, value: str | None) -> str | None:
if value in (None, ""):
return value
path = Path(str(value)).expanduser()
if path.is_absolute():
return str(path)
return str((upstream_root / path).resolve())
def _stage_configs(args: argparse.Namespace, upstream_root: Path) -> dict[str, Any]:
model_def_src = upstream_root / "configs" / "config_network_rflow.json"
env_src = upstream_root / "configs" / "environment_maisi_vae_train.json"
train_src = upstream_root / "configs" / "config_maisi_vae_train.json"
for path in (model_def_src, env_src, train_src):
if not path.is_file():
raise FileNotFoundError(path)
work_dir = args.output_dir.resolve() / "workflow"
artifacts_dir = args.output_dir.resolve() / "artifacts"
config_dir = work_dir / "configs"
model_dir = artifacts_dir / "models"
tfevent_path = artifacts_dir / "tfevent"
staged_datalist_path, staged_datalist = _stage_datalist(
args.data_base_dir.resolve(),
args.datalist.resolve(),
work_dir / "dataset.json",
args.modality,
)
model_def = copy.deepcopy(_load_json(model_def_src))
env_config = copy.deepcopy(_load_json(env_src))
train_config = copy.deepcopy(_load_json(train_src))
env_config["model_dir"] = str(model_dir)
env_config["tfevent_path"] = str(tfevent_path)
env_config["finetune"] = not args.train_from_scratch
env_config["trained_autoencoder_path"] = (
str(args.trained_autoencoder_path.resolve())
if args.trained_autoencoder_path
else _resolve_from_upstream(upstream_root, env_config.get("trained_autoencoder_path"))
)
data_option = train_config.setdefault("data_option", {})
data_option["random_aug"] = args.random_aug
data_option["spacing_type"] = args.spacing_type
data_option["spacing"] = args.spacing
data_option["select_channel"] = args.select_channel
auto_train = train_config.setdefault("autoencoder_train", {})
auto_train["batch_size"] = args.batch_size
auto_train["patch_size"] = args.patch_size
auto_train["val_batch_size"] = args.val_batch_size
auto_train["val_patch_size"] = args.val_patch_size
auto_train["val_sliding_window_patch_size"] = args.val_sliding_window_patch_size
auto_train["lr"] = args.lr
auto_train["perceptual_weight"] = args.perceptual_weight
auto_train["kl_weight"] = args.kl_weight
auto_train["adv_weight"] = args.adv_weight
auto_train["recon_loss"] = args.recon_loss
auto_train["val_interval"] = args.val_interval
auto_train["cache"] = args.cache_rate
auto_train["amp"] = not args.no_amp
auto_train["n_epochs"] = args.epochs
if "autoencoder_def" in model_def and args.autoencoder_num_splits is not None:
model_def["autoencoder_def"]["num_splits"] = args.autoencoder_num_splits
artifacts_dir.mkdir(parents=True, exist_ok=True)
return {
"env_config": _write_json(config_dir / "environment_maisi_vae_train.json", env_config),
"model_config": _write_json(config_dir / "config_maisi_vae_train.json", train_config),
"model_def": _write_json(config_dir / "config_network_rflow.json", model_def),
"datalist": _write_json(config_dir / "datalist_staged.json", staged_datalist),
"staged_datalist": staged_datalist,
"artifacts_dir": artifacts_dir,
"model_dir": model_dir,
"tfevent_path": tfevent_path,
}
def _namespace_from_staged(staged: dict[str, Any]) -> argparse.Namespace:
ns = argparse.Namespace()
for path_key in ("env_config", "model_def"):
for key, value in _load_json(staged[path_key]).items():
setattr(ns, key, value)
train_config = _load_json(staged["model_config"])
for section in ("data_option", "autoencoder_train"):
for key, value in train_config.get(section, {}).items():
setattr(ns, key, value)
return ns
def _warmup_rule(epoch: int) -> float:
if epoch < 10:
return 0.01
if epoch < 20:
return 0.1
return 1.0
def _loss_weighted_sum(args: argparse.Namespace, losses: dict[str, float]) -> float:
return (
losses["recons_loss"]
+ args.kl_weight * losses["kl_loss"]
+ args.perceptual_weight * losses["p_loss"]
)
def _run_training(
args: argparse.Namespace, upstream_root: Path, staged: dict[str, Any]
) -> dict[str, Any]:
if args.num_gpus != 1:
raise ValueError("VAE finetuning runner currently supports exactly one CUDA GPU")
sys.path.insert(0, str(upstream_root))
import torch
from monai.data import CacheDataset, DataLoader
from monai.inferers.inferer import SimpleInferer, SlidingWindowInferer
from monai.losses.adversarial_loss import PatchAdversarialLoss
from monai.losses.perceptual import PerceptualLoss
from monai.networks.nets import PatchDiscriminator
from monai.utils import set_determinism
from scripts.download_model_data import download_model_data
from scripts.transforms import VAE_Transform
from scripts.utils import KL_loss, define_instance, dynamic_infer
from torch.amp import GradScaler, autocast
from torch.nn import L1Loss, MSELoss
from torch.optim import lr_scheduler
from torch.utils.tensorboard import SummaryWriter
if args.download_model_data:
previous_cwd = os.getcwd()
try:
os.chdir(upstream_root)
download_model_data("rflow-ct", str(upstream_root), model_only=True)
finally:
os.chdir(previous_cwd)
set_determinism(seed=args.random_seed)
cfg = _namespace_from_staged(staged)
device = torch.device("cuda")
train_transform = VAE_Transform(
is_train=True,
random_aug=cfg.random_aug,
k=4,
patch_size=cfg.patch_size,
val_patch_size=cfg.val_patch_size,
output_dtype=torch.float16,
spacing_type=cfg.spacing_type,
spacing=cfg.spacing,
image_keys=["image"],
label_keys=[],
additional_keys=[],
select_channel=cfg.select_channel,
)
val_transform = VAE_Transform(
is_train=False,
random_aug=False,
k=4,
val_patch_size=cfg.val_patch_size,
output_dtype=torch.float16,
image_keys=["image"],
label_keys=[],
additional_keys=[],
select_channel=cfg.select_channel,
)
staged_datalist = staged["staged_datalist"]
dataset_train = CacheDataset(
data=staged_datalist["training"],
transform=train_transform,
cache_rate=cfg.cache,
num_workers=args.cache_num_workers,
)
dataloader_train = DataLoader(
dataset_train,
batch_size=cfg.batch_size,
num_workers=args.loader_num_workers,
shuffle=True,
drop_last=True,
)
dataset_val = CacheDataset(
data=staged_datalist["validation"],
transform=val_transform,
cache_rate=cfg.cache,
num_workers=args.cache_num_workers,
)
dataloader_val = DataLoader(
dataset_val,
batch_size=cfg.val_batch_size,
num_workers=args.loader_num_workers,
shuffle=False,
)
if len(dataloader_train) == 0:
raise ValueError("training dataloader is empty; add cases or reduce batch size")
if len(dataloader_val) == 0:
raise ValueError("validation dataloader is empty; add validation/testing cases")
Path(cfg.model_dir).mkdir(parents=True, exist_ok=True)
tensorboard_path = Path(cfg.tfevent_path) / "autoencoder"
tensorboard_path.mkdir(parents=True, exist_ok=True)
writer = SummaryWriter(str(tensorboard_path))
trained_g_path = Path(cfg.model_dir) / "autoencoder.pt"
trained_d_path = Path(cfg.model_dir) / "discriminator.pt"
autoencoder = define_instance(cfg, "autoencoder_def").to(device)
discriminator = PatchDiscriminator(
spatial_dims=cfg.spatial_dims,
num_layers_d=3,
channels=32,
in_channels=1,
out_channels=1,
norm="INSTANCE",
).to(device)
if cfg.finetune:
checkpoint_autoencoder = torch.load(cfg.trained_autoencoder_path, map_location=device)
if "unet_state_dict" in checkpoint_autoencoder:
checkpoint_autoencoder = checkpoint_autoencoder["unet_state_dict"]
autoencoder.load_state_dict(checkpoint_autoencoder)
intensity_loss = MSELoss() if cfg.recon_loss == "l2" else L1Loss(reduction="mean")
adv_loss = PatchAdversarialLoss(criterion="least_squares")
loss_perceptual = (
PerceptualLoss(spatial_dims=3, network_type="squeeze", is_fake_3d=True, fake_3d_ratio=0.2)
.eval()
.to(device)
)
optimizer_g = torch.optim.Adam(
params=autoencoder.parameters(), lr=cfg.lr, eps=1e-6 if cfg.amp else 1e-8
)
optimizer_d = torch.optim.Adam(
params=discriminator.parameters(), lr=cfg.lr, eps=1e-6 if cfg.amp else 1e-8
)
scheduler_g = lr_scheduler.LambdaLR(optimizer_g, lr_lambda=_warmup_rule)
scheduler_d = lr_scheduler.LambdaLR(optimizer_d, lr_lambda=_warmup_rule)
scaler_g = GradScaler("cuda", init_scale=2.0**8, growth_factor=1.5) if cfg.amp else None
scaler_d = GradScaler("cuda", init_scale=2.0**8, growth_factor=1.5) if cfg.amp else None
val_inferer = (
SlidingWindowInferer(
roi_size=cfg.val_sliding_window_patch_size,
sw_batch_size=1,
progress=False,
overlap=0.0,
device=torch.device("cpu"),
sw_device=device,
)
if cfg.val_sliding_window_patch_size
else SimpleInferer()
)
history: list[dict[str, Any]] = []
best_val_loss = float("inf")
best_paths: list[str] = []
total_step = 0
for epoch in range(cfg.n_epochs):
autoencoder.train()
discriminator.train()
train_losses = {"recons_loss": 0.0, "kl_loss": 0.0, "p_loss": 0.0}
adv_total = 0.0
for batch in dataloader_train:
images = batch["image"].to(device).contiguous()
optimizer_g.zero_grad(set_to_none=True)
optimizer_d.zero_grad(set_to_none=True)
with autocast("cuda", enabled=cfg.amp):
reconstruction, z_mu, z_sigma = autoencoder(images)
losses = {
"recons_loss": intensity_loss(reconstruction, images),
"kl_loss": KL_loss(z_mu, z_sigma),
"p_loss": loss_perceptual(reconstruction.float(), images.float()),
}
logits_fake = discriminator(reconstruction.contiguous().float())[-1]
generator_loss = adv_loss(logits_fake, target_is_real=True, for_discriminator=False)
loss_g = (
losses["recons_loss"]
+ cfg.kl_weight * losses["kl_loss"]
+ cfg.perceptual_weight * losses["p_loss"]
+ cfg.adv_weight * generator_loss
)
if cfg.amp and scaler_g is not None:
scaler_g.scale(loss_g).backward()
scaler_g.unscale_(optimizer_g)
scaler_g.step(optimizer_g)
scaler_g.update()
else:
loss_g.backward()
optimizer_g.step()
logits_fake = discriminator(reconstruction.contiguous().detach())[-1]
loss_d_fake = adv_loss(logits_fake, target_is_real=False, for_discriminator=True)
logits_real = discriminator(images.contiguous().detach())[-1]
loss_d_real = adv_loss(logits_real, target_is_real=True, for_discriminator=True)
loss_d = (loss_d_fake + loss_d_real) * 0.5
if cfg.amp and scaler_d is not None:
scaler_d.scale(loss_d).backward()
scaler_d.step(optimizer_d)
scaler_d.update()
else:
loss_d.backward()
optimizer_d.step()
total_step += 1
for loss_name, loss_value in losses.items():
value = float(loss_value.item())
writer.add_scalar(f"train_{loss_name}_iter", value, total_step)
train_losses[loss_name] += value
adv_total += float(generator_loss.item())
writer.add_scalar("train_adv_loss_iter", float(generator_loss.item()), total_step)
writer.add_scalar("train_fake_loss_iter", float(loss_d_fake.item()), total_step)
writer.add_scalar("train_real_loss_iter", float(loss_d_real.item()), total_step)
scheduler_g.step()
scheduler_d.step()
for key in train_losses:
train_losses[key] /= len(dataloader_train)
writer.add_scalar(f"train_{key}_epoch", train_losses[key], epoch)
train_weighted = _loss_weighted_sum(cfg, train_losses)
torch.save(autoencoder.state_dict(), trained_g_path)
torch.save(discriminator.state_dict(), trained_d_path)
epoch_record: dict[str, Any] = {
"epoch": epoch,
"train_losses": train_losses,
"train_weighted_loss": train_weighted,
"train_adv_loss": adv_total / len(dataloader_train),
}
if epoch % cfg.val_interval == 0:
autoencoder.eval()
val_losses = {"recons_loss": 0.0, "kl_loss": 0.0, "p_loss": 0.0}
last_z_mu = None
for batch in dataloader_val:
with torch.no_grad(), autocast("cuda", enabled=cfg.amp):
images = batch["image"].to(device).contiguous()
reconstruction, z_mu, z_sigma = dynamic_infer(val_inferer, autoencoder, images)
reconstruction = reconstruction.to(device)
target = images
val_losses["recons_loss"] += float(
intensity_loss(reconstruction, target).item()
)
val_losses["kl_loss"] += float(KL_loss(z_mu, z_sigma).item())
val_losses["p_loss"] += float(loss_perceptual(reconstruction, target).item())
last_z_mu = z_mu
for key in val_losses:
val_losses[key] /= len(dataloader_val)
writer.add_scalar(key, val_losses[key], epoch)
val_loss = _loss_weighted_sum(cfg, val_losses)
epoch_record["val_losses"] = val_losses
epoch_record["val_weighted_loss"] = val_loss
if last_z_mu is not None:
writer.add_scalar(
"val_one_sample_scale_factor", float(1.0 / last_z_mu.flatten().std()), epoch
)
if val_loss < best_val_loss:
best_val_loss = val_loss
best_path = Path(str(trained_g_path)[:-3] + f"_epoch{epoch}.pt")
torch.save(autoencoder.state_dict(), best_path)
best_paths.append(str(best_path))
epoch_record["best_autoencoder_checkpoint"] = str(best_path)
history.append(epoch_record)
writer.close()
return {
"autoencoder_checkpoint": str(trained_g_path),
"discriminator_checkpoint": str(trained_d_path),
"best_autoencoder_checkpoints": best_paths,
"history": history,
"tensorboard_dir": str(tensorboard_path),
}
def _write_workflow_summary(staged: dict[str, Any], result: dict[str, Any]) -> Path:
summary = {
"model": MODEL_NAME,
"training_cases": len(staged["staged_datalist"].get("training", [])),
"validation_cases": len(staged["staged_datalist"].get("validation", [])),
"staged_configs": {
"env_config": str(staged["env_config"]),
"model_config": str(staged["model_config"]),
"model_def": str(staged["model_def"]),
"datalist": str(staged["datalist"]),
},
**result,
}
return _write_json(staged["artifacts_dir"] / "workflow_summary.json", summary)
def _build_command(args: argparse.Namespace) -> list[str]:
command = [
sys.executable,
str(Path(__file__).resolve()),
str(args.datalist.resolve()),
"--data-base-dir",
str(args.data_base_dir.resolve()),
"--output-dir",
str(args.output_dir.resolve()),
"--modality",
args.modality,
"--epochs",
str(args.epochs),
"--batch-size",
str(args.batch_size),
"--lr",
str(args.lr),
"--cache-rate",
str(args.cache_rate),
"--patch-size",
",".join(str(v) for v in args.patch_size),
"--num-gpus",
str(args.num_gpus),
]
if args.download_model_data:
command.append("--download-model-data")
if args.train_from_scratch:
command.append("--train-from-scratch")
if args.no_amp:
command.append("--no-amp")
if args.preflight:
command.append("--preflight")
return command
def _summarize_output(output_dir: Path) -> dict[str, Any]:
artifacts_dir = output_dir / "artifacts"
summary_path = artifacts_dir / "workflow_summary.json"
summary = _load_json(summary_path) if summary_path.is_file() else {}
autoencoder = Path(summary.get("autoencoder_checkpoint") or "")
discriminator = Path(summary.get("discriminator_checkpoint") or "")
best_paths = [Path(p) for p in summary.get("best_autoencoder_checkpoints", [])]
return {
"directory": str(output_dir),
"artifacts_dir": str(artifacts_dir),
"workflow_summary": str(summary_path) if summary_path.is_file() else None,
"autoencoder_checkpoint": str(autoencoder) if str(autoencoder) else None,
"autoencoder_checkpoint_present": autoencoder.is_file() if str(autoencoder) else False,
"discriminator_checkpoint": str(discriminator) if str(discriminator) else None,
"discriminator_checkpoint_present": (
discriminator.is_file() if str(discriminator) else False
),
"best_autoencoder_checkpoints": [str(p) for p in best_paths],
"num_best_autoencoder_checkpoints": len(best_paths),
"loss_history": summary.get("history", []),
"tensorboard_dir": summary.get("tensorboard_dir"),
}
def _empty_output(output_dir: Path) -> dict[str, Any]:
return {
"directory": str(output_dir),
"artifacts_dir": str(output_dir / "artifacts"),
"workflow_summary": None,
"autoencoder_checkpoint": None,
"autoencoder_checkpoint_present": False,
"discriminator_checkpoint": None,
"discriminator_checkpoint_present": False,
"best_autoencoder_checkpoints": [],
"num_best_autoencoder_checkpoints": 0,
"loss_history": [],
"tensorboard_dir": None,
}
def _payload(
args: argparse.Namespace,
dataset: dict[str, Any],
upstream_root: Path | None,
checked_roots: list[str],
exit_code: int,
elapsed: float,
stdout: str = "",
stderr: str = "",
) -> dict[str, Any]:
output = (
_summarize_output(args.output_dir)
if exit_code == 0 and not args.preflight
else _empty_output(args.output_dir)
)
return {
"skill": SKILL_NAME,
"model": MODEL_NAME,
"model_repo": UPSTREAM_REPO,
"license": "Apache-2.0",
"input": {
**dataset,
"epochs": args.epochs,
"batch_size": args.batch_size,
"lr": args.lr,
"cache_rate": args.cache_rate,
"patch_size": args.patch_size,
"val_patch_size": args.val_patch_size,
"num_gpus": args.num_gpus,
"finetune": not args.train_from_scratch,
"random_seed": args.random_seed,
},
"output": output,
"invocation": {
"official_entrypoint": UPSTREAM_ENTRYPOINT,
"upstream_root": str(upstream_root) if upstream_root else None,
"upstream_commit": _git_commit(upstream_root) if upstream_root else "",
"checked_upstream_roots": checked_roots,
"command": _build_command(args),
"exit_code": exit_code,
"subprocess_seconds": elapsed,
},
"runtime": {
"subprocess_seconds": elapsed,
"device": "cuda" if args.num_gpus > 0 else "cpu",
"preflight_only": bool(args.preflight),
},
"logs": {"stdout_tail": _tail(stdout), "stderr_tail": _tail(stderr)},
"intended_use_disclaimer": (
"Engineering wrapper for synthetic-imaging VAE finetuning; not for clinical "
"interpretation, regulatory use, or production training data approval."
),
}
def build_parser() -> argparse.ArgumentParser:
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument("datalist", type=Path)
parser.add_argument("--data-base-dir", type=Path, required=True)
parser.add_argument("--output-dir", type=Path, required=True)
parser.add_argument("--upstream-root")
parser.add_argument(
"--modality",
default="mri",
help="Default modality/class for entries missing class/modality: ct or mri",
)
parser.add_argument("--epochs", type=int, default=1)
parser.add_argument("--batch-size", type=int, default=1)
parser.add_argument("--val-batch-size", type=int, default=1)
parser.add_argument("--lr", type=float, default=1e-4)
parser.add_argument("--cache-rate", type=float, default=0.0)
parser.add_argument("--patch-size", type=lambda s: _parse_triplet(s, int), default=[64, 64, 64])
parser.add_argument("--val-patch-size", type=lambda s: _parse_triplet(s, int))
parser.add_argument(
"--val-sliding-window-patch-size",
type=lambda s: _parse_triplet(s, int),
default=[96, 96, 64],
)
parser.add_argument("--autoencoder-num-splits", type=int, default=1)
parser.add_argument("--num-gpus", type=int, default=1)
parser.add_argument("--perceptual-weight", type=float, default=0.3)
parser.add_argument("--kl-weight", type=float, default=1e-7)
parser.add_argument("--adv-weight", type=float, default=0.1)
parser.add_argument("--recon-loss", choices=("l1", "l2"), default="l1")
parser.add_argument("--val-interval", type=int, default=1)
parser.add_argument(
"--spacing-type", choices=("original", "fixed", "rand_zoom"), default="original"
)
parser.add_argument("--spacing", type=lambda s: _parse_triplet(s, float))
parser.add_argument("--select-channel", type=int, default=0)
parser.add_argument("--cache-num-workers", type=int, default=0)
parser.add_argument("--loader-num-workers", type=int, default=0)
parser.add_argument("--random-seed", type=int, default=0)
parser.add_argument("--trained-autoencoder-path", type=Path)
parser.add_argument("--download-model-data", action="store_true")
parser.add_argument("--train-from-scratch", action="store_true")
parser.add_argument("--no-random-aug", dest="random_aug", action="store_false")
parser.set_defaults(random_aug=True)
parser.add_argument("--no-amp", action="store_true")
parser.add_argument("--preflight", action="store_true")
return parser
def main() -> None:
args = build_parser().parse_args()
args.modality = _normalize_modality(args.modality)
args.output_dir.mkdir(parents=True, exist_ok=True)
dataset = _validate_datalist(
args.data_base_dir.resolve(), args.datalist.resolve(), args.modality
)
upstream_root, checked = _resolve_upstream_root(args.upstream_root)
start = time.time()
if upstream_root is None and args.preflight:
payload = _payload(args, dataset, None, checked, 0, time.time() - start)
payload["logs"]["stderr_tail"] = (
"Preflight did not find an NV-Generate-CTMR checkout containing VAE configs/helpers. "
"A real training run requires NV_GENERATE_ROOT to point at a current checkout."
)
_emit(payload)
return
if upstream_root is None:
payload = _payload(args, dataset, None, checked, 2, time.time() - start)
payload["logs"]["stderr_tail"] = (
"NV-Generate-CTMR checkout with VAE configs/helpers was not found. "
"Set NV_GENERATE_ROOT or pass --upstream-root."
)
_emit(payload)
raise SystemExit(2)
try:
staged = _stage_configs(args, upstream_root)
except Exception as exc:
payload = _payload(
args, dataset, upstream_root, checked, 2, time.time() - start, stderr=str(exc)
)
_emit(payload)
raise SystemExit(2)
if args.preflight:
payload = _payload(args, dataset, upstream_root, checked, 0, time.time() - start)
payload["logs"][
"stderr_tail"
] = "Preflight staged VAE configs and validated datalist paths."
_emit(payload)
return
stdout = ""
try:
result = _run_training(args, upstream_root, staged)
_write_workflow_summary(staged, result)
exit_code = 0
stderr = ""
except Exception as exc:
exit_code = 2
stderr = f"{type(exc).__name__}: {exc}"
payload = _payload(
args, dataset, upstream_root, checked, exit_code, time.time() - start, stdout, stderr
)
_emit(payload)
raise SystemExit(exit_code)
if __name__ == "__main__":
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: Declares allowed tools, Needs a command-line tool, Needs Python
Security
What our scanner noticed· Medium risk
- Large base64-encoded blobs
- Instructions that use the network
- 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 MedTech Team
- Publisher
- NVIDIA (Official)
- Source
- NVIDIA/skills · skills/nv-generate-vae-finetune · 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 MedTech Team or NVIDIA.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download nv-generate-vae-finetune.zip