azaher1215 commited on
Commit
81abcb2
Β·
1 Parent(s): 82b68ff

fix read me file

Browse files
Files changed (1) hide show
  1. README.md +24 -58
README.md CHANGED
@@ -1,58 +1,24 @@
1
- # CSE 555 Term Project (Computer Vision and Natural Language Processing)
2
-
3
- ## Overview
4
- This project is a multi-featured application focused on food image classification, variation detection, recipe recommendation, and reporting. It leverages deep learning and NLP techniques to provide a comprehensive toolkit for food-related data analysis and user interaction.
5
-
6
- ## Features
7
- - **Image Classification:** Classify food images using pre-trained models.
8
- - **Variation Detection:** Detect variations in food items.
9
- - **Recipe Recommendation:** Recommend recipes based on user input and image analysis.
10
- - **Report Generation:** Generate reports based on classification and recommendation results.
11
-
12
- ## Project Structure
13
- ```
14
- PatternRec_Project_Group5/
15
- β”œβ”€β”€ assets/
16
- β”‚ β”œβ”€β”€ css/ # Stylesheets
17
- β”‚ β”œβ”€β”€ modelWeights/ # Pre-trained model weights (.pth)
18
- β”‚ └── nlp/ # NLP data and models (to be downloaded from google drive once the app runs)
19
- β”œβ”€β”€ config.py # Configuration file
20
- β”œβ”€β”€ Scripts/ # Configuration file
21
- β”‚ β”œβ”€β”€ CV/ # CV Training script
22
- β”‚ β”œβ”€β”€ NLP/ # NLP Training script
23
- β”œβ”€β”€ Home.py # Main entry point (possibly Streamlit or similar)
24
- β”œβ”€β”€ model/ # Model code (classifier, search recipe)
25
- β”œβ”€β”€ pages/ # App pages (image classification, variation detection, etc.)
26
- β”œβ”€β”€ utils/ # Utility functions (layout, etc.)
27
- β”œβ”€β”€ sakenv/ # Python virtual environment
28
- ```
29
-
30
- ## Setup Instructions
31
- 1. **Clone the repository:**
32
- ```bash
33
- git clone <repo-url>
34
- cd PatternRec_Project_Group5
35
- ```
36
- 2. **Create and activate the virtual environment: (Already included as sakenv/):**
37
- ```bash
38
- source sakenv/bin/activate
39
- ```
40
- 3. **Install dependencies:**
41
- ```bash
42
- pip install -r requirements.txt
43
- ```
44
- 4. **Run the application:**
45
- - If using Streamlit:
46
- ```bash
47
- streamlit run Home.py
48
- ```
49
- - Or follow the instructions in `Home.py`.
50
-
51
- ## Python Version
52
- - Python 3.12.2
53
-
54
- ## Notes
55
- - Model weights are stored in the `assets/` directory.
56
- - NLP weights were quite large and are stored at [CSE 555 Project Group 5](https://drive.google.com/drive/folders/1m6cfy4NuxIKNDBtJqm150NNN0FSUS8Np)
57
- - Ensure you have the necessary permissions to access large files in `assets/modelWeights/` and `assets/nlp/`.
58
- - For best results, use the provided virtual environment and requirements file.
 
1
+ ---
2
+ title: Pattern
3
+ emoji: πŸš€
4
+ colorFrom: red
5
+ colorTo: red
6
+ sdk: docker
7
+ app_port: 8501
8
+ tags:
9
+ - streamlit
10
+ pinned: false
11
+ short_description: for pattern recg
12
+ ---
13
+
14
+ # Welcome to Streamlit!
15
+
16
+
17
+ Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
18
+
19
+
20
+
21
+
22
+
23
+ If you have any questions, checkout our [documentation](https://docs.streamlit.io) and [community
24
+ forums](https://discuss.streamlit.io).