이재호

Update README.md

Showing 1 changed file with 39 additions and 13 deletions
...@@ -31,7 +31,7 @@ ...@@ -31,7 +31,7 @@
31 <img src="readme_img/logo.png" alt="Logo" width="80" height="80"> 31 <img src="readme_img/logo.png" alt="Logo" width="80" height="80">
32 </a> 32 </a>
33 33
34 - <h3 align="center">MWD Readme!!</h3> 34 + <h3 align="center">Mask-Wearing Discriminator!</h3>
35 35
36 <p align="center"> 36 <p align="center">
37 구글 Teachable Machine 2.0을 이용하여 마스크 착용 검사 및 출입부 작성 기능을 제공합니다. 37 구글 Teachable Machine 2.0을 이용하여 마스크 착용 검사 및 출입부 작성 기능을 제공합니다.
...@@ -40,9 +40,9 @@ ...@@ -40,9 +40,9 @@
40 <a href="http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject"><strong>Explore the docs »</strong></a> 40 <a href="http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject"><strong>Explore the docs »</strong></a>
41 <br /> 41 <br />
42 <br /> 42 <br />
43 - <a href="http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject">View Demo</a> 43 + <a href="https://teachablemachine.withgoogle.com">Teachable Machine 2.0</a>
44 · 44 ·
45 - <a href="http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject/issues">Report Bug</a> 45 + <a href="https://www.w3schools.com/">W3schools</a>
46 · 46 ·
47 <a href="http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject/issues">Request Feature</a> 47 <a href="http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject/issues">Request Feature</a>
48 </p> 48 </p>
...@@ -69,7 +69,9 @@ ...@@ -69,7 +69,9 @@
69 </li> 69 </li>
70 <li><a href="#usage">Usage</a></li> 70 <li><a href="#usage">Usage</a></li>
71 <li><a href="#roadmap">Roadmap</a></li> 71 <li><a href="#roadmap">Roadmap</a></li>
72 + <li><a href="#precautions">Precautions</a></li>
72 <li><a href="#contributing">Contributing</a></li> 73 <li><a href="#contributing">Contributing</a></li>
74 + <li><a href="#reference">Reference</a></li>
73 <li><a href="#license">License</a></li> 75 <li><a href="#license">License</a></li>
74 <li><a href="#contact">Contact</a></li> 76 <li><a href="#contact">Contact</a></li>
75 <li><a href="#acknowledgements">Acknowledgements</a></li> 77 <li><a href="#acknowledgements">Acknowledgements</a></li>
...@@ -81,7 +83,13 @@ ...@@ -81,7 +83,13 @@
81 <!-- ABOUT THE PROJECT --> 83 <!-- ABOUT THE PROJECT -->
82 ## About The Project 84 ## About The Project
83 85
84 -구글 Teachable Machine 2.0을 이용하여 마스크 착용 검사 및 출입부 작성 기능을 제공합니다. 86 +전례 없는 COVID-19가 창궐함에 따라 전염을 막기 위한 마스크 착용은 필수 불가결의 의무가 되었고, 출입자 통제 및 기록, 마스크 착용 여부 판별에 대한 업무가 증가하고 있다.<br>
87 +그래서, 우리는 인공지능을 활용해 이러한 업무를 뒷받침할 수 있는 간단한 시스템을 제작해보게 되었다.<br><br>
88 +
89 +쉽고 빠르게 머신러닝을 가능케 하는 오픈소스인 구글의 Teachable Machine 2.0을 이용한 마스크 착용 판별 프로그램입니다.<br>
90 +Teachable Machine 2.0을 이용해 마스크 착용을 유형별로 학습시킨 모델을 만들었습니다.<br>
91 +이 프로그램은 웹캠을 통해 입력되는 사람의 얼굴을 실시간으로 인식해 마스크 착용 여부를 판별합니다.<br>
92 +마스크 착용 판별 이외에 출입자 인적사항 기록 기능과 기록을 파일화해 저장하는 기능도 제공합니다.<br>
85 93
86 94
87 ### Built With 95 ### Built With
...@@ -99,11 +107,6 @@ ...@@ -99,11 +107,6 @@
99 <!-- GETTING STARTED --> 107 <!-- GETTING STARTED -->
100 ## Getting Started 108 ## Getting Started
101 109
102 -1. main page 접속<br>
103 - 1.1 <urL>을 통해 접속합니다.<br><br>
104 -2. 카메라 허용<br>
105 - 2.1 카메라 허용 메시지가 표시되면 허용을 선택합니다.<br><br>
106 -
107 ### Installation 110 ### Installation
108 111
109 1. Clone the repo 112 1. Clone the repo
...@@ -122,17 +125,21 @@ ...@@ -122,17 +125,21 @@
122 ```sh 125 ```sh
123 npm start 126 npm start
124 ``` 127 ```
125 - 128 +### Initial setting
129 +1. Main page 접속<br>
130 + 1.1 https://localhost:3000을 통해 Main page에 접속합니다.<br><br>
131 +2. 카메라 허용<br>
132 + 2.1 카메라 허용 메시지가 표시되면 허용을 선택합니다.<br><br>
126 133
127 <!-- USAGE EXAMPLES --> 134 <!-- USAGE EXAMPLES -->
128 ## Usage 135 ## Usage
129 - 136 +<!-- 사진 순서별로 정렬할 수 있도록. -->
130 [![Product Name Screen Shot][product-screenshot1]]()<br><br> 137 [![Product Name Screen Shot][product-screenshot1]]()<br><br>
131 [![Product Name Screen Shot][product-screenshot2]]()<br><br> 138 [![Product Name Screen Shot][product-screenshot2]]()<br><br>
132 [![Product Name Screen Shot][product-screenshot3]]()<br><br> 139 [![Product Name Screen Shot][product-screenshot3]]()<br><br>
133 1. 마스크 착용 판별 기능<br> 140 1. 마스크 착용 판별 기능<br>
134 1.1. 카메라 정면을 바라보고 서있는다. <br> 141 1.1. 카메라 정면을 바라보고 서있는다. <br>
135 - 1.2. 마스크 착용 여부에 따라 우측의 이미지가 변하고 소리가 출력된다.<br> 142 + 1.2. 마스크 착용 여부에 따라 영상 출력부 우측의 이미지가 변하고 소리가 출력된다.<br>
136 <br> 143 <br>
137 2. 출입내역 기록 기능<br> 144 2. 출입내역 기록 기능<br>
138 2.1. 처음 페이지에 접속하여 출입내역을 작성할 곳의 위치를 입력한다.<br> 145 2.1. 처음 페이지에 접속하여 출입내역을 작성할 곳의 위치를 입력한다.<br>
...@@ -142,7 +149,6 @@ ...@@ -142,7 +149,6 @@
142 3.1 지금까지 기록한 내용들을 '저장' 버튼을 눌러 파일을 생성한다.<br> 149 3.1 지금까지 기록한 내용들을 '저장' 버튼을 눌러 파일을 생성한다.<br>
143 3.2 생성한 파일을 '다운로드'를 통해 로컬에 저장한다.<br><br> 150 3.2 생성한 파일을 '다운로드'를 통해 로컬에 저장한다.<br><br>
144 151
145 -더 많은 정보를 원하신다면, [Teachablemachine Documentation](https://teachablemachine.withgoogle.com) 를 참고해주세요.
146 152
147 153
148 154
...@@ -153,6 +159,16 @@ See the [open issues](http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject/issues ...@@ -153,6 +159,16 @@ See the [open issues](http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject/issues
153 159
154 160
155 161
162 +<!-- PRECAUTION -->
163 +## Precautions
164 +아래 주의사항에 유의하여 사용해주세요.<br>
165 +**1. 마스크 착용 여부 판별에 웹캠의 실시간 영상 데이터를 사용. 브라우저의 웹캠 접근 권한 허용 필수. 웹캠 없이도 출입자 인적사항 기록은 가능하나 마스크 착용 여부 판별은 불가.**<br>
166 +**2. 인터넷 브라우저별로 json 및 txt 파일 생성 방법이 달라 Internet Explorer에서는 출입자 인적사항 기록은 가능하나 저장은 불가**<br>
167 +**3. Internet Explorer에서 대화 상자(Prompt)의 출력 방식이 Chrome 과는 달라 대화 상자 출력 불가. 따라서 초기에 위치 입력이 불가**<br>
168 +**4. 출입자 인적사항을 기록한 파일을 다운로드 시 반드시 로컬의 Download 폴더에 저장됨. 저장 경로 변경 불가.**<br>
169 +**5. 웹캠 앞에서의 재빠른 움직임은 마스크 착용 여부를 정확히 판별하지 못할 수 있음.**<br>
170 +
171 +
156 <!-- CONTRIBUTING --> 172 <!-- CONTRIBUTING -->
157 ## Contributing 173 ## Contributing
158 174
...@@ -165,6 +181,16 @@ See the [open issues](http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject/issues ...@@ -165,6 +181,16 @@ See the [open issues](http://khuhub.khu.ac.kr/MWD/2020-02-OSS-TermProject/issues
165 5. Open a Pull Request 181 5. Open a Pull Request
166 182
167 183
184 +<!-- Reference -->
185 +## Reference
186 +<a href="https://teachablemachine.withgoogle.com">Teachable Machine 2.0</a>
187 + ·
188 +<a href="https://www.w3schools.com/">W3schools</a>
189 + ·
190 +<a href="https://devdocs.io/express/">Express</a>
191 + ·
192 +<a href="https://devdocs.io/node/">Node.js</a>
193 +
168 194
169 <!-- LICENSE --> 195 <!-- LICENSE -->
170 ## License 196 ## License
......