georgeyiasemis commited on
Commit
8bfde36
·
verified ·
1 Parent(s): f8b4ccb

Docs: note training data/schemes/accels/ACS and how to override at inference

Browse files
Files changed (1) hide show
  1. README.md +47 -17
README.md CHANGED
@@ -15,33 +15,63 @@ Inference-ready `vsharp_<anatomy>.yaml` + `vsharp_<anatomy>.pt` pairs for
15
  [vSHARP](https://arxiv.org/abs/2309.09954) (Yiasemis et al.).
16
 
17
  Configs are **inference-only** (no `training` / `validation` blocks).
 
 
 
18
 
19
- ## Training protocol (important)
 
20
 
21
- These models were **not** trained at a single fixed acceleration or a single
22
- sampling scheme. Training used:
 
 
 
 
 
 
23
 
24
  | | |
25
  |---|---|
26
- | **Accelerations** | `[2, 4, 6, 8, 10]` |
27
- | **Center fractions** | `[0.16, 0.08, 0.06, 0.04, 0.02]` |
28
  | **Schemes** | FastMRIEquispaced, FastMRIRandom, Gaussian1D, Gaussian2D, VariableDensityPoisson, Radial |
29
 
30
- The released inference YAMLs use that same acceleration / ACS schedule.
31
- Default mask *name* follows the validation logging protocol:
32
 
33
- | Name | Dataset | Default mask |
34
- |------|---------|--------------|
35
- | `vsharp_brain` | fastMRI brain | FastMRIRandom |
36
- | `vsharp_knee` | fastMRI knee | FastMRIEquispaced |
37
- | `vsharp_prostate` | fastMRI prostate | FastMRIEquispaced |
38
- | `vsharp_cardiac` | CMRxRecon 2023 | FastMRIEquispaced |
39
 
40
- Change `inference.dataset.transforms.masking.name` to any training scheme, or
41
- set a single acceleration (e.g. `accelerations: [8]`, `center_fractions: [0.04]`)
42
- for fixed-R evaluation.
43
 
44
- Weights are converted to the current DIRECT ModConv parameter layout.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
45
 
46
  ## Usage
47
 
 
15
  [vSHARP](https://arxiv.org/abs/2309.09954) (Yiasemis et al.).
16
 
17
  Configs are **inference-only** (no `training` / `validation` blocks).
18
+ Weights are converted to the current DIRECT ModConv parameter layout.
19
+
20
+ ## What these models were trained on
21
 
22
+ Each anatomy was trained on its own multi-coil dataset with **mixed sampling
23
+ schemes** and **mixed acceleration / ACS** (not a single fixed 4× setting):
24
 
25
+ | Name | Training data | Default inference mask | Checkpoint iter |
26
+ |------|---------------|------------------------|-----------------|
27
+ | `vsharp_brain` | fastMRI brain (multi-coil) | FastMRIRandom | 950000 |
28
+ | `vsharp_knee` | fastMRI knee (multi-coil) | FastMRIEquispaced | 1050000 |
29
+ | `vsharp_prostate` | fastMRI prostate (multi-coil) | FastMRIEquispaced | 500000 |
30
+ | `vsharp_cardiac` | CMRxRecon 2023 (multi-coil cine) | FastMRIEquispaced | 100000 |
31
+
32
+ Shared masking schedule used during training (all schemes below):
33
 
34
  | | |
35
  |---|---|
36
+ | **Accelerations (R)** | `[2, 4, 6, 8, 10]` |
37
+ | **Center fractions (ACS)** | `[0.16, 0.08, 0.06, 0.04, 0.02]` (paired with R: 2→0.16, 4→0.08, 6→0.06, 8→0.04, 10→0.02) |
38
  | **Schemes** | FastMRIEquispaced, FastMRIRandom, Gaussian1D, Gaussian2D, VariableDensityPoisson, Radial |
39
 
40
+ Released inference YAMLs keep that full R / ACS list. Default mask *name*
41
+ matches the validation-logging protocol above.
42
 
43
+ ## Changing acceleration / scheme at inference
 
 
 
 
 
44
 
45
+ Edit `inference.dataset.transforms.masking` in the YAML:
 
 
46
 
47
+ ```yaml
48
+ inference:
49
+ dataset:
50
+ transforms:
51
+ masking:
52
+ name: FastMRIEquispaced # <- sampling scheme
53
+ accelerations: # <- R factor(s)
54
+ - 2
55
+ - 4
56
+ - 6
57
+ - 8
58
+ - 10
59
+ center_fractions: # <- ACS fraction(s), same length as accelerations
60
+ - 0.16
61
+ - 0.08
62
+ - 0.06
63
+ - 0.04
64
+ - 0.02
65
+ ```
66
+
67
+ Examples:
68
+
69
+ - Fixed **8×** with matching ACS: `accelerations: [8]`, `center_fractions: [0.04]`
70
+ - Fixed **4×**: `accelerations: [4]`, `center_fractions: [0.08]`
71
+ - Different scheme: set `name: FastMRIRandom` (or any training scheme above)
72
+
73
+ `name`, `accelerations`, and `center_fractions` are independent — swap the
74
+ scheme without changing R/ACS, or pin R/ACS without changing the scheme.
75
 
76
  ## Usage
77