diff --git a/README.md b/README.md index 47fb645..c2f4ee1 100644 --- a/README.md +++ b/README.md @@ -1,94 +1,46 @@ -# KoBART 기반 장문 자동 요약 및 음성 출력 시스템 +# KoBART 기반 장문 요약과 음성 출력 -## 프로젝트 소개 +긴 한국어 텍스트를 입력하면 KoBART 모델로 요약하고, 요약 결과를 음성으로 읽어주는 프로젝트입니다. -본 프로젝트는 **SKT의 KoBART(Korean BART) 요약 모델**을 활용하여 -**긴 한국어 텍스트를 자동으로 요약**하고, **요약 결과를 음성(TTS)으로 읽어주는 시스템**을 구현한 캡스톤 디자인 프로젝트입니다. +`KoBART.py`가 모델 실행과 API 처리를 맡고, `index.html`에서 텍스트 입력과 결과 확인을 합니다. -뉴스 기사, 보고서, 장문 문서 등 읽기에 부담이 되는 텍스트를 입력하면 -핵심 내용만 추출하여 요약하고, 이를 음성으로 제공함으로써 -**정보 접근성 향상**과 **사용자 편의성 증대**를 목표로 합니다. +## 기간 -## 프로젝트 목표 +- 2025.03.10 ~ 2025.06.20 -- KoBART 모델을 활용한 **한국어 장문 요약 자동화** -- 요약 결과를 **음성으로 출력(TTS)** 하여 시각적 부담 감소 -- 웹 기반 인터페이스를 통한 **간편한 사용 환경 제공** -- AI 모델 + 서비스 구조에 대한 **실무형 이해 및 구현 경험** +## 사용한 것 -## 시스템 구성 +- `Python` +- `FastAPI` +- `PyTorch` +- `Hugging Face` +- `KoBART` +- `HTML` +- `JavaScript` -``` -사용자 입력(장문 텍스트) - ↓ -KoBART 요약 모델 - ↓ -요약 텍스트 생성 - ↓ -TTS(Text-to-Speech) - ↓ -음성 출력 -``` +## 동작 -## 주요 기능 +1. 브라우저에서 긴 텍스트를 입력합니다. +2. 서버가 입력 문장을 KoBART 요약 모델에 넣습니다. +3. 모델이 만든 요약문을 화면에 보여줍니다. +4. 요약문을 TTS로 변환해 재생합니다. -### 1. 장문 텍스트 자동 요약 -- SKT에서 공개한 **KoBART 요약 모델** 사용 -- 입력 길이에 따라 문단 단위 처리 -- 불필요한 문장 제거 후 핵심 정보 중심 요약 +## 파일 -### 2. 요약 결과 음성 출력 (TTS) -- 요약된 텍스트를 음성으로 변환 -- 눈으로 읽지 않아도 내용을 파악 가능 -- 시각 피로 감소 및 접근성 강화 +- `KoBART.py`: 모델 로드, 요약 처리, API 실행 +- `index.html`: 입력 화면 +- `requirements.txt`: Python 패키지 목록 +- `uv.sh`: 실행 보조 스크립트 -### 3. 웹 기반 인터페이스 -- 브라우저에서 바로 텍스트 입력 -- 요약 결과 즉시 확인 -- 음성 재생 버튼 제공 - -## 사용 모델 및 기술 스택 - -### AI / NLP -- **KoBART (SKT)** - - digit82/kobart-summarization - - Transformer 기반 Seq2Seq 요약 모델 - -### Backend -- **Python** -- **FastAPI** -- **PyTorch** - -### Frontend -- **HTML / CSS / JavaScript** - -### 기타 -- GPU 가속(CUDA) 지원 -- REST API 기반 구조 - -## 프로젝트 의의 - -- 실제 공개된 **대규모 한국어 요약 모델을 서비스 형태로 구현** -- AI 모델 학습이 아닌 **응용·배포 관점의 실무 경험** -- 텍스트 요약 + 음성 출력 결합을 통한 **사용자 경험(UX) 개선** -- AI 기술을 실생활 문제 해결에 적용한 사례 - -## 실행 방법 (요약) +## 실행 ```bash pip install -r requirements.txt python KoBART.py ``` -웹 브라우저에서 페이지 접속 후 장문 텍스트 입력 → 요약 및 음성 출력 +## 참고 -## 참고 자료 - -- SKT KoBART GitHub - https://github.com/SKT-AI/KoBART -- KoBART Summarization - https://github.com/seujung/KoBART-summarization - -## 라이선스 - -본 프로젝트는 **학습 및 연구 목적**으로 제작되었습니다. +- KoBART 모델은 공개된 한국어 요약 모델을 사용했습니다. +- 입력 길이가 길면 문단 단위로 나눠 처리해야 합니다. +- 모델 실행 환경에 따라 GPU 설정을 따로 맞춰야 합니다.