hanwang commited on
Commit
95cce9a
·
1 Parent(s): 866715f

add design doc

Browse files
Files changed (2) hide show
  1. .gitignore +2 -0
  2. design.md +23 -0
.gitignore ADDED
@@ -0,0 +1,2 @@
 
 
 
1
+ venv
2
+ .env
design.md ADDED
@@ -0,0 +1,23 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Design document for MetDataAnalysis
2
+
3
+ ## Application Requirement Summary:
4
+ 1) an API "layer" and a CLI for the API
5
+ 2) StreamLit app (that can run locally and in HuggingFace)
6
+ 3) Visual element
7
+ 4) Data analysis
8
+
9
+ ## Application Components
10
+ - [ ] METrics StreamLit App (that runs locally and in HuggingFace)
11
+ - [ ] Display a dataframe table of items with image and metadata
12
+ - [ ] Search and display matching items in table
13
+ - [ ] data analysis visual (# by department, period, etc...)
14
+ - [ ] Nice visual layout and design
15
+ - [ ] API wrapper function
16
+ - [ ] CLI runner for api search function
17
+ - [ ] (optional) Local cache of recent items (serialized json)
18
+
19
+ ## Additional Tasks
20
+ - [ ] HuggingFace Space/Repo setup
21
+ - [x] GitHub Repo setup
22
+ - [ ] Everyone make a branch and commit
23
+ - [ ] Everyone do a PR