test with a readme

dnn-roi/pdhd/20260601/README.md

@@ -0,0 +1,125 @@
+# PDHD MobileNetV3-UNet baseline ROI models
+
+## Author
+Hokyeong Nam, gkddk33@gmail.com
+
+## Description 
+
+This document records the CVMFS README metadata for three TorchScript
+**MobileNetV3-UNet baseline** DNN-ROI models trained for ProtoDUNE-HD (PDHD)
+signal-processing studies. It summarizes the training and preprocessing choices
+needed by DUNE/Wire-Cell users to select and configure the correct model.
+
+## Model files
+
+| File | Architecture | Training events | Time rebin | Truth threshold | Truth padding | Training planes | Input channels |
+| --- | --- | ---: | ---: | ---: | --- | --- | ---: |
+| `mobileunetv3-cosmic590-deposplat-pdhd-rebin6-pad1-uv.ts` | MobileNetV3-UNet baseline | 590 | 6 | 100 | enabled | U + V | 3 |
+| `mobileunetv3-cosmic590-deposplat-pdhd-rebin4-pad1-uv.ts` | MobileNetV3-UNet baseline | 590 | 4 | 100 | enabled | U + V | 3 |
+| `mobileunetv3-cosmic590-deposplat-pdhd-rebin10-pad0-uv.ts` | MobileNetV3-UNet baseline | 590 | 10 | 100 | disabled | U + V | 3 |
+
+The filename tokens encode the model family, training/data variant, detector
+sample, time-rebinning configuration, truth-label padding configuration, and
+training plane set.
+
+## Training and preprocessing metadata
+
+All three models were produced with the same baseline workflow except for the
+`rebin` and padding choices listed above.
+
+### Detector sample, planes, and event count
+
+- Training sample: **PDHD** training sample.
+- Number of training events: **590**.
+- Planes used for training: **U plane and V plane only** (`UV`).
+- The models were trained as per-plane ROI predictors; the collection plane was
+  not included in this model set.
+
+### Input tensor
+
+The network input has **three channels**:
+
+1. `loose_lf`
+2. `mp2_roi`
+3. `mp3_roi`
+
+When connecting these models in a Wire-Cell graph, make sure the three input
+frames/tensors are supplied to the model.
+
+### Truth-label construction
+
+- Truth source: PDHD truth/deposition image used by the baseline preprocessing.
+- Truth threshold: `100` for all three models.
+- Thresholding was applied consistently for U-plane and V-plane training samples.
+
+### Padding configuration
+
+The rebin-4 and rebin-6 models use padded truth labels:
+
+```text
+padding       = 1
+padding_side  = both
+min_run       = 1
+avoid_merge   = enabled
+```
+
+The rebin-10 model does **not** add extra padding to the truth labels:
+
+```text
+padding = 0
+```
+
+## Choosing a model
+
+Use the model whose `rebin` value matches the preprocessing expected by the
+Wire-Cell deployment or validation chain:
+
+- Use `mobileunetv3-cosmic590-deposplat-pdhd-rebin4-pad1-uv.ts` for rebin-4 input.
+- Use `mobileunetv3-cosmic590-deposplat-pdhd-rebin6-pad1-uv.ts` for rebin-6 input.
+- Use `mobileunetv3-cosmic590-deposplat-pdhd-rebin10-pad0-uv.ts` for rebin-10 input.
+
+Do not mix a model with a different time-rebinning configuration unless the
+consumer explicitly converts the input tensors to the model's training binning.
+
+## Expected inference contract
+
+- Format: PyTorch TorchScript (`.ts`).
+- Model family: MobileNetV3 encoder with U-Net-style decoder.
+- Inputs: one batch of three-channel ROI/SP feature images.
+- Output: one ROI probability/mask image in the corresponding rebinned time
+  coordinate system.
+
+## Minimal provenance record
+
+```yaml
+model_family: MobileNetV3-UNet baseline
+format: torchscript
+sample: PDHD
+training_events: 590
+training_variant: cosmic590-deposplat
+planes: [U, V]
+input_channels: [loose_lf, mp2_roi, mp3_roi]
+truth_threshold: 100
+models:
+  - file: mobileunetv3-cosmic590-deposplat-pdhd-rebin6-pad1-uv.ts
+    rebin: 6
+    padding:
+      enabled: true
+      padding: 1
+      padding_side: both
+      min_run: 1
+      avoid_merge: true
+  - file: mobileunetv3-cosmic590-deposplat-pdhd-rebin4-pad1-uv.ts
+    rebin: 4
+    padding:
+      enabled: true
+      padding: 1
+      padding_side: both
+      min_run: 1
+      avoid_merge: true
+  - file: mobileunetv3-cosmic590-deposplat-pdhd-rebin10-pad0-uv.ts
+    rebin: 10
+    padding:
+      enabled: false
+      padding: 0
+```