update PONY training config

configs/PONY.knf.yaml

@@ -1,4 +1,8 @@
-# Pony Diffusion V6 XL config for the standard Rook LoRA subset layout.
+# ==============================================================
+# == Directories
+# ==============================================================
+
+
 # > Dataset sync derives SOURCE/, MANIFEST.knf.xlsx, and HF/<config-id>/ from this filename.
 
 # -- Map exported subset names to source subfolders in MANIFEST.knf.xlsx.
@@ -27,49 +31,108 @@ mappings:
     - "2-HEAD" # Face/head detail examples.
 
 # > Also export manifest rows marked sfw into an additional generated sfw subset.
-export_sfw_subset: false # < Add generated sfw subset from rows marked sfw.
+export_sfw_subset: false # < Keep PONY focused on the explicit mapped subsets.
 
+# ==============================================================
+# == Images
+# ==============================================================
 
-caption_outputs:
-  mode: hybrid_txt
-  formats: [tag]
-  tag_scope: all
+# Export-time mirroring writes fixed extra image/caption pairs before
+# SimpleTuner sees the dataset. flip_only keeps kneifftools from applying its
+# own random crop, rotation, or color jitter.
+augmentations:
+  mirrored_extra: true           # Add one mirrored copy per selected source image.
+  mirrored_transform: flip_only  # Exact horizontal mirror, no kneifftools crop/jitter.
+  seed: 12345                    # Makes mirrored export naming deterministic.
 
+# Export image area bounds before SimpleTuner sees the dataset.
+image_resize:
+  min_pixel_area: 512   # Upscale tiny images below roughly 512x512 area.
+  max_pixel_area: 1024  # Downscale large images above roughly 1024x1024 area.
+
+# ==============================================================
+# == Captions
+# ==============================================================
+
+# Controlled caption rendering context used by all generated sidecars.
 caption:
-  subject_sex: male
-  add_domains_to_tags: false
+  subject_sex: male           # Adds male subject wording to prose renderers.
+  add_domains_to_tags: false  # Pony tag captions should stay plain, not domain-prefixed.
 
-augmentations:
-  mirrored_extra: true
-  mirrored_transform: flip_only
-  seed: 12345
+# Pony uses classic SDXL-style tag captions. Use one .txt sidecar per image so
+# SimpleTuner's textfile strategy reads the intended caption directly.
+caption_outputs:
+  mode: hybrid_txt # One .txt sidecar per image containing selected formats.
+  formats: [tag]   # Tag-only captions for Pony/SDXL training.
+  tag_scope: all   # Keep the full tag tail, including identity and anatomy tags.
 
-image_resize:
-  min_pixel_area: 512
-  max_pixel_area: 1088
+# Optional per-subset caption output overrides. Keep commented unless a subset
+# needs different caption files or formats.
+# caption_outputs_overrides:
+#   felkin_anchor:
+#     mode: hybrid_txt
+#     formats: [tag]
+#     tag_scope: all
+#   genitals:
+#     mode: hybrid_txt
+#     formats: [tag]
+#     tag_scope: all
+#   fullbody:
+#     mode: hybrid_txt
+#     formats: [tag]
+#     tag_scope: all
+#   body_details:
+#     mode: hybrid_txt
+#     formats: [tag]
+#     tag_scope: all
+#   fur:
+#     mode: hybrid_txt
+#     formats: [tag]
+#     tag_scope: all
+#   head:
+#     mode: hybrid_txt
+#     formats: [tag]
+#     tag_scope: all
+#   sfw:
+#     mode: hybrid_txt
+#     formats: [tag]
+#     tag_scope: all
+
+# ==============================================================
+# == Publishing
+# ==============================================================
 
 publishing:
   huggingface:
-    enabled: true
-    repo_id: null
-    pretty_name: Rook Pony SDXL LoRA
-    version: null
-    optimized_for_model: Pony Diffusion V6 XL
-    license: null
-    tags: [sdxl, pony, lora]
-    provenance: null
-    adult_content: false
-    notes: null
+    enabled: true # Generate dataset-card metadata during dataset sync.
+    repo_id: null # Optional Hugging Face dataset repo id.
+    pretty_name: Rook Pony SDXL LoRA # Human-readable dataset-card base title.
+    version: null # Public dataset version label.
+    optimized_for_model: Pony Diffusion V6 XL # Rendered as [For Pony Diffusion V6 XL].
+    license: null # Optional dataset license.
+    tags: [sdxl, pony, lora] # Dataset-card tags.
+    provenance: null # Optional dataset provenance note.
+    adult_content: false # Render the adult-content notice in README.md.
+    notes: null # Optional free-form dataset-card notes.
+
+# ==============================================================
+# == LoRA Training
+# ==============================================================
 
 training:
-  enabled: true
-  backend: simpletuner
+  enabled: true        # Enables kneifftools training artifact generation.
+  backend: simpletuner # Selects the SimpleTuner LoRA backend.
+
   simpletuner:
-    enabled: true
-    config_filename: simpletuner-config.json
-    data_backend_filename: simpletuner-multidatabackend.json
-    cache_root: .simpletuner-cache
-    output_dir: _simpletuner-output
+    enabled: true # Optional backend-specific switch; defaults to enabled.
+
+    # -- Generated artifact filenames written into TRAINING/<config-id>_<run>.
+    config_filename: simpletuner-config.json                  # Top-level SimpleTuner config.
+    data_backend_filename: simpletuner-multidatabackend.json  # Multi-databackend config.
+
+    # Generated cache/output directories. Relative paths resolve below TRAINING/<config-id>_<run>.
+    cache_root: .simpletuner-cache  # Shared model, text, and VAE cache root.
+    output_dir: _simpletuner-output # Normal full-run checkpoint output dir.
 
     # Subset-specific SimpleTuner dataloader overrides. Any key here is merged
     # into the subset backend entry after the dataset defaults below.
@@ -80,7 +143,7 @@ training:
         # repeats: 0            # Optional per-subset repeat count.
         # disabled: false       # Optional per-subset on/off switch.
       fullbody:
-        probability: 8      # Sample full-body subset at high probability.
+        probability: 8          # Sample full-body subset at high probability.
         crop: false             # Preserve full-body composition.
         # repeats: 0
         # disabled: false
@@ -95,7 +158,7 @@ training:
         # repeats: 0
         # disabled: false
       head:
-        probability: 2        # Sample head/face details at extra exposure.
+        probability: 2          # Sample head/face details at extra exposure.
         crop: false             # Preserve detail framing; many samples are close crops.
       genitals:
         probability: 3          # Sample anatomy subset at normal probability.
@@ -103,57 +166,129 @@ training:
         # repeats: 0
         # disabled: false
 
-    subset_warmup:
-      enabled: false
-      subsets: [genitals, fullbody]
-      steps: 200
+    # Dataset backend defaults copied into every image subset entry.
+    dataset:
+      type: local                  # SimpleTuner local filesystem backend.
+      dataset_type: image          # Image dataset backend, not text embeds.
+      resolution: 1024             # Target area edge; pixel_area means 1024^2 area.
+      minimum_image_size: 512     # SimpleTuner lower bound for SDXL/Pony image handling.
+      maximum_image_size: 1024     # Upper bound for input image sizing.
+      target_downsample_size: 1024 # Downsample target for cache generation.
+      resolution_type: pixel_area  # Area-based buckets, not smaller-edge resize.
+      caption_strategy: textfile   # Read captions from exported .txt sidecars.
+      metadata_backend: discovery  # Discover images/captions from directories.
+      crop: false                   # Default only; every configured subset disables crop above.
+      crop_style: random           # Inert for crop:false subsets.
+      crop_aspect: preserve        # Preserve original aspect instead of square crop.
+      repeats: 0                   # Dataset-level repeat count; subset can override.
+      disabled: false              # Dataset-level backend switch.
+
+    # Optional shared text-embedding backend overrides. Commented keys show the
+    # kneifftools-owned defaults for the generated text_embeds backend.
+    text_embeds:
+      id: text-embeds       # Backend id used by SimpleTuner.
+      type: local           # Store embeddings on local filesystem.
+      dataset_type: text_embeds
+      default: true         # Marks this as the shared embedding backend.
+      # cache_dir: .simpletuner-cache/text # Override generated text cache dir.
+      disabled: false
 
+    # Generate a SimpleTuner user_prompt_library JSON from fixed Pony prompts.
+    # Manifest-derived prompts are intentionally omitted for Pony because
+    # kneifftools currently supports generated validation profiles for chroma
+    # and flux2 only.
+    validation_prompts:
+      enabled: true
+      filename: simpletuner-validation-prompts.json
+      positive_prefix: "score_9, score_8_up, score_7_up, source_furry, rating_safe, "
+      custom:
+        pony_portrait: "Rook_Kaefer, felkin, close-up portrait, detailed lighting"
+        pony_fullbody_reference: "Rook_Kaefer, felkin, full-body character reference, standing, solo"
+        # pony_body_detail: "Rook_Kaefer, felkin, body detail reference, torso, hands, legs, tail, clean anatomy"
+        # pony_fur_detail: "Rook_Kaefer, felkin, fur texture reference, ladybug markings, mane, tail, paws"
+        # pony_anatomy_reference: "Rook_Kaefer, felkin, rating_explicit, nude anatomy reference, sheath detail, clean lighting"
+
+    # Model and LoRA settings merged into the top-level SimpleTuner config.
     model:
-      model_type: lora
-      model_family: sdxl
-      model_flavour: null
-      lora_type: standard
-      lora_format: diffusers
-      lora_rank: 64
-      lora_alpha: 64
-      flux_lora_target: null
+      model_type: lora       # Train a LoRA adapter.
+      model_family: sdxl     # Use SimpleTuner's SDXL model family.
+      model_flavour: null    # Pony V6 is loaded from a single SDXL checkpoint.
+      lora_rank: 64          # LoRA rank/capacity.
+      lora_alpha: 64         # LoRA alpha scaling.
+      lora_type: standard    # Standard LoRA, not an alternate adapter type.
+      lora_format: diffusers # SDXL LoRA format expected by SimpleTuner for this run.
+      flux_lora_target: null # Remove the Flux/Chroma default from generated config.
+
+      # Base SDXL/Pony checkpoint from the WSL ComfyUI model store.
       pretrained_model_name_or_path: /mnt/wsl/comfyui-models/models/checkpoints/_base_finetunes/ponyDiffusionV6XL_v6StartWithThisOne.safetensors
       pretrained_unet_model_name_or_path: null
       pretrained_vae_model_name_or_path: null
+      pretrained_transformer_model_name_or_path: null
+      pretrained_t5_model_name_or_path: null
       pretrained_text_encoder_model_name_or_path: null
-      init_lora: null
-      lycoris_config: null
 
-    trainer:
-      mixed_precision: bf16
+      # Precision defaults for Pony/SDXL LoRA training.
       base_model_precision: no_change
       base_model_default_dtype: bf16
-      optimizer: adamw_bf16
-      learning_rate: 0.0001
-      lr_scheduler: constant_with_warmup # ramp up LR to avoid weird color biases.
+      mixed_precision: bf16
+      # init_lora: /path/to/existing.safetensors # Optional LoRA resume/init weights.
+      # lycoris_config: /path/to/lycoris.json    # Optional LyCORIS config path.
+
+    # == Curricular warmup
+    subset_warmup:
+      enabled: false
+      subsets: [genitals, fullbody]
+      steps: 200 # !! First steps of the total run are ONLY listed subsets when enabled!
+
+    # Full-run trainer config. trainer_testrun below overrides selected keys
+    # only when knf train prepare/start is called with --testrun.
+    trainer:
+      # tracker_project_name: kneifftools-lora-training # Experiment tracker project.
+      # tracker_run_name: ladybird-pony                 # Full-run tracker name.
+      # hub_model_id: ladybird-pony-lora                # Optional Hub model id if push_to_hub is enabled.
+
+      optimizer: adamw_bf16              # BF16 AdamW optimizer.
+      learning_rate: 0.0001              # Common SDXL LoRA starting point.
+      lr_scheduler: constant_with_warmup # Ramp up LR to avoid weird color biases.
       lr_warmup_steps: 100
-      gradient_checkpointing: true
-      train_batch_size: 1
-      gradient_accumulation_steps: 1
-      num_train_epochs: 0
-      max_train_steps: 4
-      checkpoint_step_interval: 4
-      validation_step_interval: 100
-      validation_prompt_library: false
-      validation_disable_unconditional: true
-      validation_resolution: 1024x1024
-      validation_num_inference_steps: 30
-      validation_guidance_real: 7.5
-      num_eval_images: 1
-      seed: 42
-      report_to: none
-      push_to_hub: false
-      push_checkpoints_to_hub: false
+      seed: 42                           # Training seed.
+      gradient_checkpointing: true       # Reduce VRAM by recomputing activations.
+      # max_grad_norm: 1.0               # Optional gradient clipping.
+      # grad_clip_method: norm           # Optional gradient clipping method.
+
+      train_batch_size: 1            # Per-device batch size.
+      gradient_accumulation_steps: 1 # Effective batch multiplier.
+      num_train_epochs: 0            # Step-based training; max_train_steps controls run length.
+      max_train_steps: 4             # Current short Pony run length.
+
+      caption_dropout_probability: 0.1 # Caption dropout for regularization.
+      data_backend_sampling: uniform   # Uniform dataloader sampling.
+      allow_dataset_oversubscription: true
+
+      push_to_hub: false             # Upload final artifacts to Hugging Face Hub.
+      push_checkpoints_to_hub: false # Upload intermediate checkpoints.
+      # checkpoints_total_limit: 5   # Keep latest 5 checkpoints.
+      checkpoint_step_interval: 4    # Save checkpoint every 4 steps.
+      validation_step_interval: 100  # Run validation every 100 steps.
+      # validation_on_startup: true  # Render baseline validation before training.
+      validation_prompt_library: false       # Disable SimpleTuner built-in prompt library.
+      validation_disable_unconditional: true # Skip unconditional validation branch.
+      validation_resolution: 1024x1024       # Validation image size.
+      validation_num_inference_steps: 30     # Full-run validation sampling steps.
+      validation_guidance_real: 7.5          # SDXL/Pony validation guidance.
+      # validation_guidance: 5.0             # Alternative CFG field for some SimpleTuner versions.
+      # validation_guidance_rescale: 0.0     # Guidance rescale; 0 disables rescale.
+      # validation_seed: 42                  # Deterministic validation seed.
+      num_eval_images: 1                     # Images per validation prompt.
+      # validation_negative_prompt: "score_4, score_3, score_2, signature, ugly, cropped, blurry, low-quality"
+
+      report_to: none # Set to tensorboard to write TensorBoard logs.
+      # logging_dir: logs # TensorBoard log dir relative to TRAINING/<config-id>_<run>.
+
+      # Additional kneifftools-owned SimpleTuner defaults. Leave commented to
+      # use defaults from src/kneiff/training/lora/simpletuner.py.
       use_ema: false
       vae_batch_size: 1
-      data_backend_sampling: uniform
-      allow_dataset_oversubscription: true
-      caption_dropout_probability: 0.1
       aspect_bucket_alignment: 64
       tokenizer_max_length: 77
       t5_padding: null
@@ -162,42 +297,10 @@ training:
       keep_vae_loaded: false
       resume_from_checkpoint: null
 
+    # Short smoke-run overrides. These merge last only with --testrun.
     trainer_testrun:
-      output_dir: _simpletuner-output-testrun
-      max_train_steps: 4
-      checkpoint_step_interval: 100
-      validation_step_interval: 4
-      ignore_final_epochs: true
-
-    dataset:
-      type: local
-      dataset_type: image
-      crop: true
-      crop_style: random
-      crop_aspect: preserve
-      resolution: 1024
-      minimum_image_size: 1024
-      maximum_image_size: 1024
-      target_downsample_size: 1024
-      resolution_type: pixel_area
-      caption_strategy: textfile
-      metadata_backend: discovery
-      repeats: 0
-      disabled: false
-
-
-
-    text_embeds:
-      id: text-embeds
-      type: local
-      dataset_type: text_embeds
-      default: true
-      disabled: false
-
-    validation_prompts:
-      enabled: true
-      filename: simpletuner-validation-prompts.json
-      positive_prefix: "score_9, score_8_up, score_7_up, source_furry, rating_safe, "
-      custom:
-        custom_portrait: "Rook_Kaefer, felkin, close-up portrait, detailed lighting"
-        custom_fullbody: "Rook_Kaefer, felkin, full-body character reference, standing, solo"
+      output_dir: _simpletuner-output-testrun # Keep smoke checkpoints away from full run.
+      max_train_steps: 4                      # Tiny run to verify plumbing.
+      checkpoint_step_interval: 100           # Avoid extra smoke checkpoints.
+      validation_step_interval: 4             # Validate at the end of the smoke run.
+      ignore_final_epochs: true               # Fix early stop due to SimpleTuner epoch calculation.