hanwang commited on
Commit
8af6c7f
·
1 Parent(s): 4c85899

Add image and brief description of CLI and app to Readme

Browse files
Files changed (1) hide show
  1. README.md +6 -10
README.md CHANGED
@@ -18,7 +18,6 @@ Browse and analyze Met art collection API
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
@@ -28,13 +27,6 @@ Use Python 3.13 or higher
28
  ### Run streamlit app
29
  `streamlit run main.py`
30
 
31
- ### Specifics
32
- - **Python**: 3.9.6
33
- - Deployed as a [Hugging Face Space](https://huggingface.co/spaces/mg643/MetDataAnalysis) and automatically synced with GitHub Actions.
34
-
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,
@@ -47,5 +39,9 @@ display a table of select results from across the departments, and select one fo
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
 
 
 
 
 
18
  API document: https://huggingface.co/spaces/mg643/MetDataAnalysis
19
 
20
  ## How to run locally
 
21
  ### Create your virtual environment
22
  `python3 -m venv venv`
23
  ### Activate your virtual environment
 
27
  ### Run streamlit app
28
  `streamlit run main.py`
29
 
 
 
 
 
 
 
 
30
  The application has 3 tabs:
31
  1. Random - Display 3 random images from the Met collection
32
  2. Search & Browse - searches the image collection based on query,
 
39
  The CLI will search for images that matches the keyword across selected departments (or all departments).
40
  The CLI will display a list of departments to choose from (or press enter for all)
41
  Then it will ask for a search query. It will then display a table of items that matches the query with some details.
42
+
43
+ ### Specifics
44
+ - **Python**: 3.9.6
45
+ - Deployed as a [Hugging Face Space](https://huggingface.co/spaces/mg643/MetDataAnalysis) and automatically synced with GitHub Actions.
46
+
47
+ ![GIF](end.jpg)