hanwang commited on
Commit
4c85899
·
1 Parent(s): 49a96d2

Add image and brief description of CLI and app to Readme

Browse files
Files changed (1) hide show
  1. README.md +21 -1
README.md CHANGED
@@ -12,7 +12,13 @@ pinned: false
12
  # MetDataAnalysis
13
  Bootcamp Final Project
14
 
15
- ## How to run
 
 
 
 
 
 
16
  ### Create your virtual environment
17
  `python3 -m venv venv`
18
  ### Activate your virtual environment
@@ -29,3 +35,17 @@ Bootcamp Final Project
29
  ![GIF](end.jpg)
30
 
31
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
  # MetDataAnalysis
13
  Bootcamp Final Project
14
 
15
+ Browse and analyze Met art collection API
16
+ ![The Met Logo](https://cdn.sanity.io/images/cctd4ker/production/1357b570f8ec477e8bc69bf74f56b43877e72e58-720x466.gif?w=360&q=75&fit=clip&auto=format)
17
+
18
+ API document: https://huggingface.co/spaces/mg643/MetDataAnalysis
19
+
20
+ ## How to run locally
21
+ Use Python 3.13 or higher
22
  ### Create your virtual environment
23
  `python3 -m venv venv`
24
  ### Activate your virtual environment
 
35
  ![GIF](end.jpg)
36
 
37
 
38
+ The application has 3 tabs:
39
+ 1. Random - Display 3 random images from the Met collection
40
+ 2. Search & Browse - searches the image collection based on query,
41
+ display a table of select results from across the departments, and select one for more details
42
+ 3. Dept Analytics - a chart of matching images by department
43
+
44
+ ### Run CLI
45
+ `python met_api.py`
46
+
47
+ The CLI will search for images that matches the keyword across selected departments (or all departments).
48
+ The CLI will display a list of departments to choose from (or press enter for all)
49
+ Then it will ask for a search query. It will then display a table of items that matches the query with some details.
50
+ ### Use on HuggingFace Spaces
51
+ Browse to: https://huggingface.co/spaces/mg643/MetDataAnalysis