nngeek195 commited on
Commit
c47cd20
Β·
verified Β·
1 Parent(s): 7e56915

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +111 -92
README.md CHANGED
@@ -1,93 +1,112 @@
1
- NailVirtuoso: AI-Powered Virtual Nail Try-On:
2
- NailVirtuoso is an AI-powered web application that allows users to virtually try on different nail colors. By uploading an image of their hand, a U-Net deep learning model performs precise nail segmentation, and the user can select any color to see it applied in real-time. This project was developed for the TensorForge '25 AI Buildathon.
3
-
4
- ## Features
5
- AI-Powered Nail Segmentation: Utilizes a U-Net architecture for accurate nail detection.
6
-
7
- Virtual Color Try-On: Apply any selected color to the segmented nails on your uploaded photo.
8
-
9
- Web-Based Interface: Easy-to-use application accessible from any web browser.
10
-
11
- Containerized Deployment: Packaged with Docker for easy and reproducible setup.
12
-
13
- ## Local Setup Instructions
14
- Follow these steps to set up and run the project on your local machine.
15
-
16
- ### Prerequisites
17
- Python 3.9 or later
18
-
19
- pip for package management
20
-
21
- A virtual environment tool (like venv)
22
-
23
- ### Installation
24
- Clone the repository:
25
-
26
- Bash
27
-
28
- git clone https://github.com/your-username/nailvirtuoso.git
29
- cd nailvirtuoso
30
- Create and activate a virtual environment:
31
-
32
- Bash
33
-
34
- # For Windows
35
- python -m venv venv
36
- .\venv\Scripts\activate
37
-
38
- # For macOS/Linux
39
- python3 -m venv venv
40
- source venv/bin/activate
41
- Install the required dependencies:
42
-
43
- Bash
44
-
45
- pip install -r requirements.txt
46
- Download the pre-trained model:
47
- Ensure your trained model file (nail_segmentation_model.pth) is located in the model/ directory.
48
-
49
- ### Running the Application
50
- Start the Flask server:
51
-
52
- Bash
53
-
54
- python run.py
55
- Access the application:
56
- Open your web browser and navigate to http://127.0.0.1:5000.
57
-
58
- ## Docker Deployment
59
- The easiest way to run this project is by using Docker.
60
-
61
- ### Prerequisites
62
- Docker Desktop installed and running.
63
-
64
- ### Quickstart with Docker
65
- Build the Docker image:
66
- From the project's root directory, run the following command:
67
-
68
- Bash
69
-
70
- docker build -t nail-virtuoso .
71
- Run the Docker container:
72
- This command will start the application and make it accessible on port 5001 of your local machine.
73
-
74
- Bash
75
-
76
- docker run -p 5001:5000 nail-virtuoso
77
- Access the application:
78
- Open your web browser and navigate to http://localhost:5001.
79
-
80
- ## Project Structure
81
- .
82
- β”œβ”€β”€ model/
83
- β”‚ └── nail_segmentation_model.pth
84
- β”œβ”€β”€ notebooks/
85
- β”‚ └── data_exploration.ipynb
86
- β”œβ”€β”€ scripts/
87
- β”‚ └── Model Train Stage (it contain code bases and some samll amount of data I use to train models)
88
- | └── Running_Stage (here is the working code bases)
89
- β”œβ”€β”€ Dockerfile
90
- β”œβ”€β”€ README.md
91
- β”œβ”€β”€ requirements.txt
92
- └── run.py
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
93
  └── Demo Video.mp4
 
1
+ ---
2
+ title: NailVirtuoso Virtual Try On
3
+ emoji: πŸ’…
4
+ colorFrom: pink
5
+ colorTo: purple
6
+ sdk: docker
7
+ pinned: false
8
+ app_port: 7860
9
+ license: mit
10
+ language:
11
+ - en
12
+ pipeline_tag: image-segmentation
13
+ tags:
14
+ - nails
15
+ - fashion
16
+ - virtual-try-on
17
+ - unet
18
+ ---
19
+
20
+ NailVirtuoso: AI-Powered Virtual Nail Try-On:
21
+ NailVirtuoso is an AI-powered web application that allows users to virtually try on different nail colors. By uploading an image of their hand, a U-Net deep learning model performs precise nail segmentation, and the user can select any color to see it applied in real-time. This project was developed for the TensorForge '25 AI Buildathon.
22
+
23
+ ## Features
24
+ AI-Powered Nail Segmentation: Utilizes a U-Net architecture for accurate nail detection.
25
+
26
+ Virtual Color Try-On: Apply any selected color to the segmented nails on your uploaded photo.
27
+
28
+ Web-Based Interface: Easy-to-use application accessible from any web browser.
29
+
30
+ Containerized Deployment: Packaged with Docker for easy and reproducible setup.
31
+
32
+ ## Local Setup Instructions
33
+ Follow these steps to set up and run the project on your local machine.
34
+
35
+ ### Prerequisites
36
+ Python 3.9 or later
37
+
38
+ pip for package management
39
+
40
+ A virtual environment tool (like venv)
41
+
42
+ ### Installation
43
+ Clone the repository:
44
+
45
+ Bash
46
+
47
+ git clone https://github.com/your-username/nailvirtuoso.git
48
+ cd nailvirtuoso
49
+ Create and activate a virtual environment:
50
+
51
+ Bash
52
+
53
+ # For Windows
54
+ python -m venv venv
55
+ .\venv\Scripts\activate
56
+
57
+ # For macOS/Linux
58
+ python3 -m venv venv
59
+ source venv/bin/activate
60
+ Install the required dependencies:
61
+
62
+ Bash
63
+
64
+ pip install -r requirements.txt
65
+ Download the pre-trained model:
66
+ Ensure your trained model file (nail_segmentation_model.pth) is located in the model/ directory.
67
+
68
+ ### Running the Application
69
+ Start the Flask server:
70
+
71
+ Bash
72
+
73
+ python run.py
74
+ Access the application:
75
+ Open your web browser and navigate to http://127.0.0.1:5000.
76
+
77
+ ## Docker Deployment
78
+ The easiest way to run this project is by using Docker.
79
+
80
+ ### Prerequisites
81
+ Docker Desktop installed and running.
82
+
83
+ ### Quickstart with Docker
84
+ Build the Docker image:
85
+ From the project's root directory, run the following command:
86
+
87
+ Bash
88
+
89
+ docker build -t nail-virtuoso .
90
+ Run the Docker container:
91
+ This command will start the application and make it accessible on port 5001 of your local machine.
92
+
93
+ Bash
94
+
95
+ docker run -p 5001:5000 nail-virtuoso
96
+ Access the application:
97
+ Open your web browser and navigate to http://localhost:5001.
98
+
99
+ ## Project Structure
100
+ .
101
+ β”œβ”€β”€ model/
102
+ β”‚ └── nail_segmentation_model.pth
103
+ β”œβ”€β”€ notebooks/
104
+ β”‚ └── data_exploration.ipynb
105
+ β”œβ”€β”€ scripts/
106
+ β”‚ └── Model Train Stage (it contain code bases and some samll amount of data I use to train models)
107
+ | └── Running_Stage (here is the working code bases)
108
+ β”œβ”€β”€ Dockerfile
109
+ β”œβ”€β”€ README.md
110
+ β”œβ”€β”€ requirements.txt
111
+ └── run.py
112
  └── Demo Video.mp4