yzhouchen001 commited on
Commit
0964a71
Β·
1 Parent(s): aedfaa8

updated readme

Browse files
Files changed (1) hide show
  1. README.md +20 -6
README.md CHANGED
@@ -7,15 +7,24 @@ sdk: streamlit
7
  pinned: false
8
  python_version: 3.11.7
9
  ---
10
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
11
 
12
  # πŸ”₯ FLARE
13
  Fine-grained Learning for Aligment of spectra-molecule REpresentation
14
 
15
- ### Yan Zhou Chen, Soha Hassoun
16
- #### Department of Computer Science, Tufts University
17
- This repository provides the implementation of FLARE. Given a mass spectrum, FLARE can be used to rank a set of molecular candidates. Further, FLARE enables visualization of peak-to-node attribution.
18
 
 
 
 
 
 
 
 
 
 
 
19
  ## πŸ›  Set up
20
  ### Clone repository
21
  ```
@@ -28,8 +37,8 @@ conda create -n flare python=3.11
28
  conda activate flare
29
  pip install -r requirements.txt
30
  ```
31
-
32
- ## Usage
33
  Modify params.yaml as necessary
34
 
35
  ```
@@ -42,8 +51,13 @@ python train.py
42
  # test
43
  python test.py
44
  ```
 
 
45
  ## πŸ™ Acknowledgments
46
  - **Loss Objective**: [FILIP](https://arxiv.org/abs/2111.07783)
47
  - **Training Data**: [MassSpecGym](https://github.com/pluskal-lab/MassSpecGym)
48
  - **Subformula Assigner Code**: [MIST](https://github.com/samgoldman97/mist/tree/main_v2)
49
 
 
 
 
 
7
  pinned: false
8
  python_version: 3.11.7
9
  ---
 
10
 
11
  # πŸ”₯ FLARE
12
  Fine-grained Learning for Aligment of spectra-molecule REpresentation
13
 
14
+ ### Authors
15
+ **Yan Zhou Chen, Soha Hassoun**
16
+ Department of Computer Science, Tufts University
17
 
18
+ ---
19
+
20
+ FLARE is a framework for **ranking molecular candidates given a mass spectrum**. Beyond candidate ranking, FLARE provides **visualization of peak-to-node attribution**, enabling deeper insights into how spectral peaks correspond to molecular graph nodes.
21
+
22
+ ---
23
+
24
+ ## 🌐 Visualize Peak-to-Node Correspondence
25
+ Explore our interactive [app](https://huggingface.co/spaces/HassounLab/FLARE) to visualize peak-to-node attributes in real time.
26
+
27
+ ---
28
  ## πŸ›  Set up
29
  ### Clone repository
30
  ```
 
37
  conda activate flare
38
  pip install -r requirements.txt
39
  ```
40
+ ---
41
+ ## πŸš€ Usage
42
  Modify params.yaml as necessary
43
 
44
  ```
 
51
  # test
52
  python test.py
53
  ```
54
+
55
+ ---
56
  ## πŸ™ Acknowledgments
57
  - **Loss Objective**: [FILIP](https://arxiv.org/abs/2111.07783)
58
  - **Training Data**: [MassSpecGym](https://github.com/pluskal-lab/MassSpecGym)
59
  - **Subformula Assigner Code**: [MIST](https://github.com/samgoldman97/mist/tree/main_v2)
60
 
61
+ ---
62
+ ## πŸ“§ Contact
63
+ For questions, reach out to soha.hassoun@tufts.edu