Update README.md

README.md

@@ -3,48 +3,66 @@ license: bsd-3-clause
 library_name: scikit-learn
 pipeline_tag: tabular-regression
 tags:
-- MRI
-- medical-imaging
-- ZAP
-- random-forest
-- regression
+  - MRI
+  - medical-imaging
+  - ZAP
+  - random-forest
+  - regression
 ---
 
 # ZAP Random Forest Regression Models
 
-This repository contains trained random forest regression models for
-accelerated liver Z-spectrum analysis proton (ZAP) parameter estimation.
+Trained random forest regression models for accelerated liver Z-spectrum analysis proton (ZAP) parameter estimation.
 
-The release includes models for two acquisition configurations:
+## Model configurations
 
-- 12 frequency offsets for greater acquisition acceleration
-- 20 frequency offsets for improved quantitative agreement
+Two acquisition configurations are provided:
 
-Each configuration estimates:
+- **12 frequency offsets:** greater acquisition acceleration
+- **20 frequency offsets:** improved quantitative agreement
 
-- relatively free fraction, \(F_f\)
-- apparent transverse exchange time, \(T_{2,f}^{\mathrm{ex}}\)
-- apparent transverse exchange time, \(T_{2,r}^{\mathrm{ex}}\)
+## Model outputs
 
-## Files
+Each configuration estimates the following voxel-wise parameters:
 
-`liver_zap_rfr_models_v1.zip` contains the trained scikit-learn models,
-selected frequency offsets, model manifest, software environment, release
-notes, license, and integrity checksums.
+$$
+F_f,\qquad T_{2,f}^{\mathrm{ex}},\qquad T_{2,r}^{\mathrm{ex}}.
+$$
+
+Here:
+
+- \\(F_f\\) is the relatively free fraction.
+- \\(T_{2,f}^{\mathrm{ex}}\\) is the apparent transverse exchange time of the relatively free component.
+- \\(T_{2,r}^{\mathrm{ex}}\\) is the apparent transverse exchange time of the restricted component.
+
+The restricted fraction is obtained as
+
+$$
+F_r = 1-F_f.
+$$
+
+## Model files
+
+The release archive, `liver_zap_rfr_models_v1.zip`, contains:
+
+- trained scikit-learn random forest regression models
+- selected frequency offsets for both acquisition configurations
+- model manifest
+- software-environment information
+- release notes
+- BSD 3-Clause license
+- SHA-256 integrity checksums
 
 ## Source code
 
-https://github.com/vmalis/ZAP-RFR
+The associated source code is available at [github.com/vmalis/ZAP-RFR](https://github.com/vmalis/ZAP-RFR).
 
 ## Intended use
 
-These models support research evaluation of accelerated liver ZAP imaging.
-They are not medical devices and are not intended for diagnosis or treatment
-decisions. Application to different scanners, acquisition protocols, tissues,
-or populations requires independent validation.
+These models are intended for research evaluation of accelerated liver ZAP imaging. They are not medical devices and are not intended for diagnosis or treatment decisions.
+
+Application to different scanners, acquisition protocols, tissues, or populations requires independent validation.
 
 ## Security
 
-The models use Python `joblib` serialization and therefore have Python pickle
-semantics. Load model files only from trusted sources and verify their
-SHA-256 checksums before use.
+The models use Python `joblib` serialization and therefore have Python pickle semantics. Load model files only from trusted sources and verify their SHA-256 checksums before use.