diff --git a/README.md b/README.md index cecc127..05a505f 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,33 @@ # 모두의 복지 앱 -![](https://i.imgur.com/LkDevQK.png) + +![](https://i.imgur.com/LkDevQK.png) + 복지 사각지대에 계신 분들이 앱 하나로 자신에게 **최적화된 복지 혜택**을 받아 볼 수 있습니다. **최적의 맞춤형 정보제공 챗봇과 실시간 푸시 알림, 주변 복지시설 안내, 관심복지 저장**의 기능을 통해 **복지 사각지대**의 사람들에게 편의를 제공합니다. -([2021 프로보노 공모전](https://www.hanium.or.kr/portal/subscription/info.do?trackSeq=2) 대상 과학기술정보통신부장관상 수상작입니다.) +([2021 프로보노 공모전](https://www.hanium.or.kr/portal/subscription/info.do?trackSeq=2) **대상 과학기술정보통신부장관상** 수상작입니다.) ## 기술 스택 | Frontend | Backend | DB | DATA | | :--------: | :--------: | :--------: | :--------: | | | || | + - Front-end Framework and Structure : [Frontend](https://welfareforeveryone.notion.site/Front-end-Framework-and-Structure-2e8b6b629ea844fd87a32a198ee49fff) - Back-end Framework and Structure : [Backend](https://welfareforeveryone.notion.site/Back-end-Framework-and-Structure-7ec49ee09c3a4c9b9a1f500b15aead1c) - 서버 구축까지의 시행착오 : [Server](https://welfareforeveryone.notion.site/Performance-Engineering-1a92fce2b23b4175bc4ce7cba45e141a) - KcELECTRA 동작 구조가 궁금하다면? : [KcELECTRA](https://velog.io/@kmg2933/KcELECTRA-%EC%B1%97%EB%B4%87-%EC%84%A4%EA%B3%84%EB%8F%84) -- KoSBERT에 대해 알고 싶다면? : [KoSBERT](https://www.notion.so/KoSBERT-f17c66df70b8455fb9ecc3441c887857) +- KoSBERT에 대해 알고 싶다면? : [KoSBERT](https://www.notion.so/welfareforeveryone/KoSBERT-15ecbf962da646d0a88909700f8bebd8) ## 실행 스크립트 ### 앱 실행 스크립트 + ```java Execute Android Eumulator Build Project Run ``` + ### 서버 실행 스크립트 server/.env를 참고해서 환경변수 파일을 만들어주세요. @@ -35,11 +40,15 @@ npm install npm run prod (production version) npm start (development version) ``` -### AI 챗봇 실행 스크립트 -docker image 다운로드: kmg2933/welfare-for-everyone:0921 + +### AI 일상대화 챗봇 실행 스크립트(KcELECTRA) + +> docker image 다운로드: kmg2933/welfare-for-everyone:0921 + - 파일 model.pt 파일은 해당 [링크](https://welfareforeveryone.notion.site/391ccf431eaa449db00c9a36658ee6e8)에서 받아가세요. + ```python config = { 'port':'number' @@ -47,6 +56,7 @@ config = { ``` - 실행 스크립트 + ```script sudo cp model.pt WelfareForEveryOne/ai/KcELECTRAchatbot/flask/model.pt sudo cp config.py WelfareForEveryOne/ai/KcELECTRAchatbot/flask/config.py @@ -60,18 +70,24 @@ docker build --no-cache -t kmg2933/welfare-for-everyone:prod . docker run --rm -it -p [host port]:[container port] kmg2933/welfare-for-everyone:prod ``` -### KoSBERT 실행 스크립트 -docker image 다운로드:bookbug/kosbert_image:latest + +### AI 복지정보 챗봇 실행 스크립트(KoSBERT) + +> docker image 다운로드:bookbug/kosbert_image:latest (참고 : CPU로 실행되도록 설정되어 있습니다. GPU로 실행하고 싶으시다면 [GPU 실행](https://github.com/BM-K/KoSentenceBERT-SKT/issues/8)을 참고해주세요.) + - 파일 -result.pt 파일은 해당 [링크](https://drive.google.com/drive/folders/1fLYRi7W6J3rxt-KdGALBXMUS2W4Re7II)의 sts/result.pt 파일을output/training_sts/0_Transformer에 넣어주세요. -corpus_embedding.csv는 해당 [링크](https://www.notion.so/welfareforeveryone/391ccf431eaa449db00c9a36658ee6e8)에서 가져가시고 [출처](https://www.data.go.kr/data/15090532/openapi.do)는 공공데이터포털입니다. +result.pt 파일은 해당 [링크](https://drive.google.com/drive/folders/1fLYRi7W6J3rxt-KdGALBXMUS2W4Re7II)의 sts/result.pt 파일을 다운받으세요. +corpus_embedding.csv는 해당 [링크](https://www.notion.so/welfareforeveryone/391ccf431eaa449db00c9a36658ee6e8)에서 다운받으세요. [출처](https://www.data.go.kr/data/15090532/openapi.do)는 공공데이터포털입니다. + ```python config = { 'port':'number' } ``` + - 실행 스크립트 + ```script // file copy sudo cp result.pt WelfareForEveryOne/ai/KoSentenceBERTchatbot/KoSentenceBERT/output/training_sts/0_Transformer/result.pt @@ -93,7 +109,7 @@ docker run --gpus all --rm -it -p [host port]:[container port] kosbert_image:pro ## 어플리케이션 시연 -전체 시연 영상은 다음 [데모 영상](https://www.youtube.com/watch?v=YdwjrgnP7SM)을 참고해 주세요. +전체 시연 영상은 다음 [데모 영상](https://www.youtube.com/watch?v=YdwjrgnP7SM)을 참고해 주세요. |추천 복지 열람|챗봇|복지시설 |푸시알림|관심복지 추가| |:---:|:---:|:---:|:---:|:---:| @@ -104,10 +120,10 @@ docker run --gpus all --rm -it -p [host port]:[container port] kosbert_image:pro | | | | | | | :-----------------------------------------------------------------------: | :-----------------------------------------------------------------------: | :-----------------------------------------------------------------------: | :-----------------------------------------------------------------------: | :-----------------------------------------------------------------------: | |[김진수](https://github.com/zinzinbin) | [박해미](https://github.com/parkhaemi) | [권태훈](https://github.com/Oxymoron957) | [김민규](https://github.com/MingyuKim-2933) |[문혜현](https://github.com/hyehyeonmoon) | -| App Frontend | App Frontend | App Backend | Chatbot AI |Chatbot AI | - +| App Frontend, Lead | App Frontend | App Backend | Chatbot AI |Chatbot AI | ## Reference + - [KcELECTRA by Beomi](https://https://github.com/Beomi/KcELECTRA) - [Pytorch Docker Image](https://hub.docker.com/r/pytorch/pytorch) - [Ko-SentenceBERT-SKTBERT](https://github.com/BM-K/KoSentenceBERT_SKT#sentence-transformers-multilingual-sentence-embeddings-using-bert--roberta--xlm-roberta--co-with-pytorch)