Marek Bukowicki commited on
Commit
ca4cd3d
·
1 Parent(s): af60913

update GUI information in Readme

Browse files
Files changed (1) hide show
  1. Readme.md +22 -11
Readme.md CHANGED
@@ -7,7 +7,7 @@ Paper: [ShimNet: A neural network for post-acquisition improvement of NMR spectr
7
 
8
  ## Installation
9
 
10
- Python 3.9+
11
 
12
  GPU version (for training and inference)
13
  ```
@@ -153,8 +153,6 @@ dic, data = ng.varian.read(varian_fid_path)
153
  python predict.py my_sample1.csv -o my_output --config runs/my_lab_spectrometer_2025/config.yaml --weights runs/my_lab_spectrometer_2025/model.pt
154
  ```
155
 
156
-
157
-
158
  ## Repeat training on our data
159
 
160
  If you want to train the network using the calibration data from our paper, follow the procedure below.
@@ -188,23 +186,36 @@ If you want to train the network using the calibration data from our paper, foll
188
 
189
  ## GUI
190
 
191
- ### GUI installation
192
-
193
- GUI requires Python 3.10. Not tested for Python 3.11+
194
-
195
 
196
- After installing ShimNet requirements (CPU/GPU) install GUI requirements:
197
 
198
  ```bash
199
  pip install -r requirements-gui.txt
200
  ```
201
 
202
- ### GUI usage
 
 
203
 
204
  ```bash
205
  python predict-gui.py
206
  ```
207
 
208
- Open your browser and go to `http://127.0.0.1:7860` address to use locally.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
209
 
210
- Under address given in the terminal message after `Running on public URL:` the tool may be used on other computers
 
7
 
8
  ## Installation
9
 
10
+ Python 3.9+ (3.10+ for GUI)
11
 
12
  GPU version (for training and inference)
13
  ```
 
153
  python predict.py my_sample1.csv -o my_output --config runs/my_lab_spectrometer_2025/config.yaml --weights runs/my_lab_spectrometer_2025/model.pt
154
  ```
155
 
 
 
156
  ## Repeat training on our data
157
 
158
  If you want to train the network using the calibration data from our paper, follow the procedure below.
 
186
 
187
  ## GUI
188
 
189
+ ### Installation
 
 
 
190
 
191
+ To use the ShimNet GUI, ensure you have Python 3.10 installed (not tested with Python 3.11+). After installing the ShimNet requirements (CPU/GPU), install the additional dependencies for the GUI:
192
 
193
  ```bash
194
  pip install -r requirements-gui.txt
195
  ```
196
 
197
+ ### Launching the GUI
198
+
199
+ The ShimNet GUI is built using Gradio. To start the application, run:
200
 
201
  ```bash
202
  python predict-gui.py
203
  ```
204
 
205
+ Once the application starts, open your browser and navigate to:
206
+
207
+ ```
208
+ http://127.0.0.1:7860
209
+ ```
210
+
211
+ to access the GUI locally.
212
+
213
+ ### Sharing the GUI
214
+
215
+ To make the GUI accessible over the internet, use the `--share` flag:
216
+
217
+ ```bash
218
+ python predict-gui.py --share
219
+ ```
220
 
221
+ A public web address will be displayed in the terminal, which you can use to access the GUI remotely or share with others.