devansh152 commited on
Commit
ff8599b
ยท
verified ยท
1 Parent(s): 20f9f94

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +101 -0
README.md CHANGED
@@ -1,3 +1,102 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: Network Analyzer
3
  emoji: ๐Ÿฆ€
@@ -10,3 +109,5 @@ pinned: false
10
  ---
11
 
12
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
1
+
2
+ # ๐Ÿงฌ Biological Network Analyzer
3
+
4
+ An intelligent assistant for analyzing biological networks from **text or image input**. This app can extract reaction networks from uploaded diagrams using **Gemini Vision API**, parse them into graph structures, and generate:
5
+
6
+ - ๐Ÿ“ˆ ODEs (Ordinary Differential Equations)
7
+ - ๐Ÿงฎ Jacobian matrices
8
+ - ๐Ÿ”„ Cyclic dependency checks
9
+ - ๐Ÿ“Š Graph stats (edges, variables)
10
+
11
+ All via a **Gradio-based conversational interface**.
12
+
13
+ ---
14
+
15
+ ## ๐Ÿš€ Features
16
+
17
+ - ๐Ÿ”ค **Text input** (e.g. `A + B -> C, C <-> D`)
18
+ - ๐Ÿ–ผ๏ธ **Image input** (upload scanned or digital diagrams)
19
+ - ๐Ÿง  Google Gemini API integration to extract text-based reactions from images
20
+ - ๐Ÿงช ODE system generation using mass-action kinetics
21
+ - ๐Ÿง  Jacobian matrix computation via symbolic algebra (SymPy)
22
+ - ๐Ÿ” Cycle detection and variable/edge counting
23
+ - ๐Ÿค– LLM-based fallback Q&A via `flan-t5-base`
24
+ - ๐ŸŽจ Customizable Gradio theme (e.g. `Soft`, `Glass`, etc.)
25
+
26
+ ---
27
+
28
+ ## ๐Ÿงฐ Tech Stack
29
+
30
+ | Component | Technology |
31
+ |---------------|-------------------------------|
32
+ | Frontend UI | [Gradio](https://gradio.app) |
33
+ | LLM Query | [Flan-T5](https://huggingface.co/google/flan-t5-base) |
34
+ | Image-to-Text | [Gemini API](https://ai.google.dev/) (Vision multimodal API) |
35
+ | Graph Parsing | [NetworkX](https://networkx.org) |
36
+ | Symbolic Math | [SymPy](https://www.sympy.org/) |
37
+
38
+ ---
39
+
40
+ ## ๐Ÿ–ฅ๏ธ Running the App on your device
41
+
42
+ ### โœ… Prerequisites
43
+
44
+ - Python โ‰ฅ 3.8
45
+ - Install dependencies:
46
+
47
+ ```bash
48
+ pip install gradio transformers networkx sympy google-generativeai python-dotenv pillow
49
+ ````
50
+
51
+ * Set your Gemini API key in a `.env` file:
52
+
53
+ ```
54
+ GEMINI_API=your_api_key_here
55
+ ```
56
+
57
+ ### โ–ถ๏ธ Run
58
+
59
+ ```bash
60
+ python your_script.py
61
+ ```
62
+
63
+ Or use inside a [Google Colab notebook](https://colab.research.google.com/) for instant testing.
64
+
65
+ ---
66
+
67
+ ## ๐Ÿ“ท Example Inputs
68
+
69
+ ### Text:
70
+
71
+ ```
72
+ A + B -> C, C <-> D, D -> E
73
+ ```
74
+
75
+ ### Image:
76
+
77
+ * Upload PNG or JPG of a biological reaction network
78
+ * Gemini will parse it automatically
79
+
80
+ ---
81
+
82
+ ## ๐Ÿ“Œ Future Additions
83
+
84
+ * Export ODEs/Jacobian as LaTeX/PDF
85
+ * Stoichiometry & reaction rate customization
86
+
87
+ ---
88
+
89
+ ## ๐Ÿง‘โ€๐Ÿ”ฌ Author
90
+
91
+ Built by \[Devansh] for a project on **LLM-based Equation Discovery from Biological Networks**.
92
+
93
+ ---
94
+
95
+ ## ๐Ÿ“ License
96
+
97
+ MIT License
98
+
99
+
100
  ---
101
  title: Network Analyzer
102
  emoji: ๐Ÿฆ€
 
109
  ---
110
 
111
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
112
+
113
+