ratneshpasi03 commited on
Commit
23f9020
ยท
1 Parent(s): 5fb7082

Add .gitattributes for LFS tracking and update README with new app metadata

Browse files
Files changed (2) hide show
  1. .gitattributes +35 -0
  2. README.md +11 -147
.gitattributes ADDED
@@ -0,0 +1,35 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ *.7z filter=lfs diff=lfs merge=lfs -text
2
+ *.arrow filter=lfs diff=lfs merge=lfs -text
3
+ *.bin filter=lfs diff=lfs merge=lfs -text
4
+ *.bz2 filter=lfs diff=lfs merge=lfs -text
5
+ *.ckpt filter=lfs diff=lfs merge=lfs -text
6
+ *.ftz filter=lfs diff=lfs merge=lfs -text
7
+ *.gz filter=lfs diff=lfs merge=lfs -text
8
+ *.h5 filter=lfs diff=lfs merge=lfs -text
9
+ *.joblib filter=lfs diff=lfs merge=lfs -text
10
+ *.lfs.* filter=lfs diff=lfs merge=lfs -text
11
+ *.mlmodel filter=lfs diff=lfs merge=lfs -text
12
+ *.model filter=lfs diff=lfs merge=lfs -text
13
+ *.msgpack filter=lfs diff=lfs merge=lfs -text
14
+ *.npy filter=lfs diff=lfs merge=lfs -text
15
+ *.npz filter=lfs diff=lfs merge=lfs -text
16
+ *.onnx filter=lfs diff=lfs merge=lfs -text
17
+ *.ot filter=lfs diff=lfs merge=lfs -text
18
+ *.parquet filter=lfs diff=lfs merge=lfs -text
19
+ *.pb filter=lfs diff=lfs merge=lfs -text
20
+ *.pickle filter=lfs diff=lfs merge=lfs -text
21
+ *.pkl filter=lfs diff=lfs merge=lfs -text
22
+ *.pt filter=lfs diff=lfs merge=lfs -text
23
+ *.pth filter=lfs diff=lfs merge=lfs -text
24
+ *.rar filter=lfs diff=lfs merge=lfs -text
25
+ *.safetensors filter=lfs diff=lfs merge=lfs -text
26
+ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
27
+ *.tar.* filter=lfs diff=lfs merge=lfs -text
28
+ *.tar filter=lfs diff=lfs merge=lfs -text
29
+ *.tflite filter=lfs diff=lfs merge=lfs -text
30
+ *.tgz filter=lfs diff=lfs merge=lfs -text
31
+ *.wasm filter=lfs diff=lfs merge=lfs -text
32
+ *.xz filter=lfs diff=lfs merge=lfs -text
33
+ *.zip filter=lfs diff=lfs merge=lfs -text
34
+ *.zst filter=lfs diff=lfs merge=lfs -text
35
+ *tfevents* filter=lfs diff=lfs merge=lfs -text
README.md CHANGED
@@ -1,147 +1,11 @@
1
- # VayuBuddy Question Curation
2
-
3
- ## ๐ŸŽฏ Aim
4
- The purpose to create this templet is to have the automated interface to collect and manage data analytic questions for VayuBuddy
5
-
6
- ## ๐Ÿ“‚ Folder Structure
7
-
8
- The project is organized as follows:
9
-
10
- ```bash
11
- project_root/
12
- โ”‚โ”€โ”€ app.py # Main Streamlit application
13
- โ”‚โ”€โ”€ requirements.txt # Dependencies list
14
- โ”‚โ”€โ”€ README.md # Documentation
15
- โ”‚
16
- โ”œโ”€โ”€ data/
17
- โ”‚ โ”œโ”€โ”€ questions/ # Stores question-related data
18
- โ”‚ โ”‚ โ”œโ”€โ”€ 0/ # Folder for question ID 0
19
- โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ question.txt # Question text
20
- โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ answer.txt # Answer text
21
- โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ code.py # Reference code for the question
22
- โ”‚ โ”‚ โ”‚ โ””โ”€โ”€ metadata.json # Metadata for the question
23
- โ”‚ โ”‚ โ”œโ”€โ”€ 1/ # Folder for question ID 1
24
- โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ question.txt # Question text
25
- โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ answer.txt # Answer text
26
- โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ code.py # Reference code for the question
27
- โ”‚ โ”‚ โ”‚ โ””โ”€โ”€ metadata.json # Metadata for the question
28
- โ”‚ ... ... ... # and so on...
29
- โ”‚ โ”‚ ... ...
30
- โ”‚ โ”‚
31
- โ”‚ โ””โ”€โ”€ raw_data/ # Stores the required CSV's
32
- โ”‚ โ”œโ”€โ”€ NCAP_Funding.csv # NCAP Funding Data
33
- โ”‚ โ”œโ”€โ”€ State.csv # States area & population Data
34
- โ”‚ โ””โ”€โ”€ Data.csv # Main AQI Data
35
- โ”‚
36
- โ”œโ”€โ”€ pages/ # Streamlit multipage support
37
- โ”‚ โ”œโ”€โ”€ all_question.py # Page to view questions
38
- โ”‚ โ”œโ”€โ”€ execute_code.py # Page to run the code of all questions
39
- โ”‚ โ”œโ”€โ”€ add_question.py # Page to add new questions
40
- โ”‚ โ”œโ”€โ”€ edit_question.py # Page to edit existing questions
41
- โ”‚ โ””โ”€โ”€ delete_question.py # Page to delete questions
42
- โ”‚
43
- โ”œโ”€โ”€ utils/ # Utility functions
44
- โ”‚ โ”œโ”€โ”€ load_jsonl.py # Function to load questions a list
45
- โ”‚ โ”œโ”€โ”€ data_to_jsonl.py # Function to convert question folders into JSONL
46
- โ”‚ โ”œโ”€โ”€ jsonl_to_data.py # Function to convert JSONL into question folders
47
- โ”‚ โ””โ”€โ”€ code_services.py # Handles code formatting & execution
48
- โ”‚
49
- โ””โ”€โ”€ output.jsonl # Processed question data in JSONL format
50
- ```
51
-
52
- This structure ensures **modularity** and **maintainability** of the project. ๐Ÿš€
53
-
54
-
55
- ## ๐Ÿ“œ How to use this App
56
-
57
- - Add questions through ```Add Questions``` Page
58
- - Edit questions through ```Edit Questions``` Page
59
- - Delete questions through ```Delete Questions``` Page
60
- - The Data will not be saved in-case of missing fields or error in code
61
-
62
- ### ```NOTE```
63
- - while entering Data form code.py in ```Add Questions``` Page or ```Edit Questions``` Page either follow the ```true_code format``` i.e. all code written in the true_code function and true_code function called in the end of it's defination or follow ```No true_code format```
64
-
65
- #### true_code format
66
- ```python
67
- def true_code():
68
- import pandas as pd
69
-
70
- df = pd.read_csv('data/raw_data/Data.csv', sep=",")
71
-
72
- data = df.groupby(['state','station'])['PM2.5'].mean()
73
- ans = data.idxmax()[0]
74
- print(ans)
75
-
76
- true_code()
77
- ```
78
-
79
- #### No true_code format
80
- ```python
81
- import pandas as pd
82
-
83
- df = pd.read_csv('data/raw_data/Data.csv', sep=",")
84
-
85
- data = df.groupby(['state','station'])['PM2.5'].mean()
86
- ans = data.idxmax()[0]
87
- print(ans)
88
- ```
89
-
90
- ## ๐Ÿงฉ Sample Question
91
-
92
- ### question.txt
93
- ```bash
94
- Which state has the highest average PM2.5 concentration across all stations?
95
- ```
96
-
97
- ### answer.txt
98
- ```bash
99
- Delhi
100
- ```
101
-
102
- ### code.py
103
- ```python
104
- def true_code():
105
- import pandas as pd
106
-
107
- df = pd.read_csv('data/raw_data/Data.csv', sep=",")
108
-
109
- data = df.groupby(['state','station'])['PM2.5'].mean()
110
- ans = data.idxmax()[0]
111
- print(ans)
112
-
113
- true_code()
114
- ```
115
-
116
- ### metadata.json
117
- ```json
118
- {
119
- "question_id": 0,
120
- "category": "spatial",
121
- "answer_category": "single",
122
- "plot": false,
123
- "libraries": [
124
- "pandas"
125
- ]
126
- }
127
- ```
128
-
129
-
130
- ## ๐Ÿ› ๏ธ How to Set-Up project
131
-
132
- open the terminal in the empty folder and follow the following steps:
133
-
134
- ### 1st step : clone repo
135
- ```bash
136
- git clone https://github.com/ratnesh003/VayuBuddy-Question-Curation.git .
137
- ```
138
-
139
- ### 2rd step : to install the dependencies to run the codes
140
- ```bash
141
- pip install -r requirements.txt
142
- ```
143
-
144
- ### 3nd step : to create dummy /data folder from already present output.jsonl
145
- ```bash
146
- py .\utils\jsonl_to_data.py
147
- ```
 
1
+ ---
2
+ title: VayuBuddy Question And Answer
3
+ emoji: ๐Ÿš€
4
+ colorFrom: pink
5
+ colorTo: red
6
+ sdk: streamlit
7
+ sdk_version: 1.42.0
8
+ app_file: app.py
9
+ pinned: false
10
+ short_description: This is a streamlit app to create the collection of Question
11
+ ---