zaccharieramzi commited on
Commit
107703a
1 Parent(s): cb4fc19

added model card and model weights

Browse files
Files changed (2) hide show
  1. README.md +75 -0
  2. model_weights.h5 +3 -0
README.md ADDED
@@ -0,0 +1,75 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # KIKI-net-fastmri
2
+ ---
3
+ tags:
4
+ - TensorFlow
5
+ - MRI reconstruction
6
+ - MRI
7
+ datasets:
8
+ - fastMRI
9
+ ---
10
+
11
+ This model can be used to reconstruct single coil fastMRI data with an acceleration factor of 4.
12
+
13
+ ## Model description
14
+ For more details, see https://www.mdpi.com/2076-3417/10/5/1816.
15
+ This section is WIP.
16
+
17
+ ## Intended uses and limitations
18
+ This model can be used to reconstruct single coil knee data from Siemens scanner at acceleration factor 4.
19
+ It cannot be used on multi-coil data.
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
+ from fastmri_recon.models.functional_models.kiki_sep import full_kiki_net
29
+ from fastmri_recon.models.utils.non_linearities import lrelu
30
+
31
+ model = full_kiki_net(n_convs=16, n_filters=48, activation=lrelu)
32
+ model.load_weights('model_weights.h5')
33
+ ```
34
+
35
+ Using the model is then as simple as:
36
+ ```python
37
+ model([
38
+ kspace, # shape: [n_slices, n_rows, n_cols, 1]
39
+ mask, # shape: [n_slices, n_rows, n_cols]
40
+ ])
41
+ ```
42
+
43
+ ## Limitations and bias
44
+ The limitations and bias of this model have not been properly investigated.
45
+
46
+ ## Training data
47
+ This model was trained using the [fastMRI dataset](https://fastmri.org/dataset/).
48
+
49
+ ## Training procedure
50
+ The training procedure is described in https://www.mdpi.com/2076-3417/10/5/1816 for brain data.
51
+ This section is WIP.
52
+
53
+ ## Evaluation results
54
+ This model was evaluated using the [fastMRI dataset](https://fastmri.org/dataset/).
55
+
56
+ | Contrast | PD | PDFS |
57
+ |----------|-------|--------|
58
+ | PSNR | 32.86 | 29.57 |
59
+ | SSIM | 0.797 | 0.6271 |
60
+
61
+
62
+ ## Bibtex entry
63
+ ```
64
+ @article{ramzi2020benchmarking,
65
+ title={Benchmarking MRI reconstruction neural networks on large public datasets},
66
+ author={Ramzi, Zaccharie and Ciuciu, Philippe and Starck, Jean-Luc},
67
+ journal={Applied Sciences},
68
+ volume={10},
69
+ number={5},
70
+ pages={1816},
71
+ year={2020},
72
+ publisher={Multidisciplinary Digital Publishing Institute}
73
+ }
74
+ ```
75
+
model_weights.h5 ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:8bb58a6baeee7b3c33bec7c058bf89ccf49f94a320e94c8ce5b0fab6c3e9a750
3
+ size 7770552