📖 LLM Diary: 감정 분석 기반 다이어리 플랫폼

📌 Table of Contents

• 🔍 About the Project
• 🚀 Features
• 💻 Technologies
• 🛠 Getting Started
• 📌 Usage
• 📧 Contact
• 📜 License

🔍 About the Project

거대 언어 모델(LLM)을 사용하여 사용자의 일기를 바탕으로 감정을 분석하고, 사용자에게 감정 통계 및 맞춤형 상담을 제안하는 시스템.

🚀 Features

🏷️ROLE

• User
• Counselor
• Admin
• UserSupporter

📊 Emotion Analsis

• Model: koBERT.
• Fine-tuning Dataset: 감성대화 말뭉치
• Emotion : 분노, 슬픔, 불안, 상처, 당황, 기쁨

Counsel

• 강조하고싶은 주요 기능이나 차별성 있는 특징

💻 Technologies

• Python 3.10.0
• Django 5.1.3
• tailwindcss 3.4.14
• transformers 4.47.0

🛠 Getting Started

0️⃣ Pre-requisite

The easiest way to start the LLMDiary is through docker compose. Before running this with the following commands, make sure that Docker and Docker Compose are installed on your machine:

1️⃣ Clone the Repository

git clone https://github.com/Jeon-Jinhyeok/LLMDiary.git
cd LLMDiary

2️⃣ Download the Model (Hugging Face)

sudo apt install git-lfs
git lfs clone https://huggingface.co/xxhyeok/koBERT-emotion

💡 참고: Hugging Face 모델 저장소에 접근하려면 SSH를 이용한 로그인 인증이 필요할 수 있습니다. Hugging Face SSH Key 설정 가이드 참고

3️⃣ Configure Environment Variables

• setup.env파일 수정

POSTGRES_DB=emotion_diary_db
POSTGRES_USER=admin
POSTGRES_PASSWORD=your-password
POSTGRES_HOST=db
POSTGRES_PORT=5432
DJANGO_SECRET_KEY=your-secret-key
DEBUG=False
ALLOWED_HOSTS=*

• setup.env 파일 적용

source ./setup.env

4️⃣ Run with Docker

docker compose up

5️⃣ Access the Web Interface

http://localhost:8000

📌 Usage

스크린샷, 코드 등을 통해 사용 방법과 사용 예제를 보여기. 사용 예제별로 h2 헤더로 나누어 설명

📧 Contact

• Jinhyeok, JEON - [email protected]
• Donggeon, KIM -

📜 License

Apache 2.0

주요 기능

사용자 기능

1. 일기 작성 및 저장
   사용자에게 자신의 감정을 기록할 수 있는 일기 작성 기능을 제공. 작성된 일기는 감정 분석 모델을 통해 분석되며, 분석 결과는 일기에 저장됨

2. 감정 통계 제공
   사용자는 지난 한 달 동안의 감정 데이터를 시각화된 막대그래프로 확인 가능하며 감정별로 기록된 횟수를 파악 가능

3. 맞춤형 상담 제안
   사용자의 감정 데이터를 기반으로 고객 지원 담당자가 상담을 제안할 수 있음. 또한 사용자가 상담사에게 상담을 신청할 수 있음

관리자 및 고객 지원 담당자 기능

1. 상담 제안
   관리자 또는 고객 지원 담당자는 특정 사용자의 감정을 분석한 데이터를 기반으로 "상담 제안" 버튼을 클릭하여 상담을 제안할 수 있습니다.

2. 감정 통계 관리
   모든 사용자에 대한 감정 데이터를 한눈에 파악할 수 있는 대시보드 제공. 사용자별 감정 빈도를 표시하며, 상담이 필요한 사용자에게 상담을 제안할 수 있습니다.

---