zaccharieramzi commited on
Commit
2e55017
1 Parent(s): 4a25e72

added model card and model weights

Browse files
Files changed (2) hide show
  1. README.md +88 -0
  2. model_weights.h5 +3 -0
README.md ADDED
@@ -0,0 +1,88 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # NCPDNet-multicoil-radial
2
+ ---
3
+ tags:
4
+ - TensorFlow
5
+ - MRI reconstruction
6
+ - MRI
7
+ datasets:
8
+ - fastMRI
9
+ ---
10
+
11
+ This is a non-Cartesian multicoil MRI reconstruction model for radial trajectories at acceleration factor 4.
12
+ The model uses 10 iterations and a small vanilla CNN.
13
+
14
+ ## Model description
15
+ For more details, see https://hal.inria.fr/hal-03188997.
16
+ This section is WIP.
17
+
18
+ ## Intended uses and limitations
19
+ This model can be used to reconstruct multicoil knee data from Siemens scanner at acceleration factor 4 in a radial acquisition setting.
20
+
21
+ ## How to use
22
+ This model can be loaded using the following repo: https://github.com/zaccharieramzi/fastmri-reproducible-benchmark.
23
+ After cloning the repo, `git clone https://github.com/zaccharieramzi/fastmri-reproducible-benchmark`, you can install the package via `pip install fastmri-reproducible-benchmark`.
24
+ The framework is TensorFlow.
25
+
26
+ You can initialize and load the model weights as follows:
27
+ ```python
28
+ import tensorflow as tf
29
+
30
+ from fastmri_recon.models.subclassed_models.ncpdnet import NCPDNet
31
+
32
+
33
+ model = NCPDNet(
34
+ multicoil=True,
35
+ im_size=(640, 400),
36
+ dcomp=True,
37
+ refine_smaps=True,
38
+ )
39
+ kspace_shape = 1
40
+ inputs = [
41
+ tf.zeros([1, 1, kspace_shape, 1], dtype=tf.complex64),
42
+ tf.zeros([1, 2, kspace_shape], dtype=tf.float32),
43
+ tf.zeros([1, 1, 640, 320], dtype=tf.complex64),
44
+ (tf.constant([320]), tf.ones([1, kspace_shape], dtype=tf.float32)),
45
+ ]
46
+ model(inputs)
47
+ model.load_weights('model_weights.h5')
48
+ ```
49
+
50
+ Using the model is then as simple as:
51
+ ```python
52
+ model([
53
+ kspace, # shape: [n_slices, n_coils, n_kspace_samples, 1]
54
+ traj, # shape: [n_slices, n_coils, 2, n_kspace_samples]
55
+ smaps, # shape: [n_slices, n_coils, n_kspace_samples, n_coils]
56
+ (
57
+ output_shape, # shape: [n_slices, 1]
58
+ dcomp, # shape: [n_slices, n_kspace_samples]
59
+ )
60
+ ])
61
+ ```
62
+
63
+ ## Limitations and bias
64
+ The limitations and bias of this model have not been properly investigated.
65
+
66
+ ## Training data
67
+ This model was trained using the [fastMRI dataset](https://fastmri.org/dataset/).
68
+
69
+ ## Training procedure
70
+ The training procedure is described in https://hal.inria.fr/hal-03188997.
71
+ This section is WIP.
72
+
73
+ ## Evaluation results
74
+ On the fastMRI validation dataset:
75
+ - PSNR: 40.00
76
+ - SSIM: 0.9191
77
+
78
+
79
+ ## Bibtex entry
80
+ ```
81
+ @unpublished{ramzi:hal-03188997,
82
+ TITLE = {{NC-PDNet: a Density-Compensated Unrolled Network for 2D and 3D non-Cartesian MRI Reconstruction}},
83
+ AUTHOR = {Ramzi, Zaccharie and G R, Chaithya and Starck, Jean-Luc and Ciuciu, Philippe},
84
+ YEAR = {2021},
85
+ MONTH = Sep,
86
+ }
87
+ ```
88
+
model_weights.h5 ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:0d2b4c99e6d15b55e5edefa9d015c6bb0c9ec74eff322ede296c63400dcf7140
3
+ size 770160