Home

Welcome to the HEARUS-AI-SERVING wiki!

프로젝트 구조

/routers
│
├── langchain.py # 비동기 LLM 메소드와 LangChain 정의
│                # chromaDB 활용하여 LLM 결과 캐싱
│                # LLM 결과를 추출하는 JSON Parser 메소드 정의
│
├── websocket.py # WebSocket 연결을 위한 메소드 정의
│                # Whisper 모델 인퍼런스 및 음성 변환 로직 정의
│                # 연결 이후 비동기 Task 수행
│                # 연결 해제 후 메모리 관련 작업 (flush 등) 수행
│
├── main.py # WebSocket 및 API 정의
└── requirements.txt # 프로젝트에 필요한 Python 패키지 리스트

시작하기

필수 요구사항

• Python 3.9 이상
• pip (최신 버전)
• venv (가상 환경 관리)

설치 및 실행

1. 레포지토리 clone (이미 완료했다면 skip)

   git clone https://github.com/TEAM-Hearus/HEARUS-AI-SERVING
   

2. 프로젝트 디렉토리로 이동

   cd HEARUS-AI-SERVING
   

3. 가상 환경 생성 및 활성화

   python -m venv venvs/hearus
   source ./venvs/hearus/Scripts/activate  # Windows
   # source ./venvs/hearus/bin/activate  # macOS/Linux
   

4. 의존성 설치

   pip install -r requirements.txt
   

5. Ollama 및 llama3 설치

   pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu121
   pip install -r requirements.txt
   curl -fsSL https://ollama.com/install.sh | sh
   
   ollama serve
   ollama pull llama3
   

6. 애플리케이션 실행

   python -m uvicorn main:app --host 0.0.0.0 --port 8000 --reload
   

🤝 기여하기

Hearus의 발전에 기여해 주셔서 감사합니다! 우리는 모든 형태의 기여를 환영합니다.

1. Issue 생성: 버그 리포트, 기능 제안, 또는 질문
2. Pull Request: 코드 개선, 문서화, 또는 새로운 기능 구현
3. Code Review: 다른 기여자의 PR을 리뷰하고 피드백 제공
4. Documentation: README, 위키, 또는 코드 주석 개선

자세한 기여 가이드라인은 CONTRIBUTING.md를 참조해 주세요. 또한 프로젝트에 대한 문의사항이 있으시다면 ISSUE를 생성해 주세요.