성현 김 commited on
Commit
5243776
·
1 Parent(s): dda3243

Retrigger build with a small README update

Browse files
Files changed (1) hide show
  1. README.md +53 -7
README.md CHANGED
@@ -1,11 +1,57 @@
1
  ---
2
- title: My Midjourney Api
3
- emoji: 📉
4
- colorFrom: pink
5
- colorTo: pink
6
  sdk: docker
7
- pinned: false
8
- license: apache-2.0
 
 
 
 
9
  ---
10
 
11
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: 맞춤형 미드저니 프롬프트 생성기 API
3
+ emoji: 🤖🎨✨
4
+ colorFrom: indigo
5
+ colorTo: green
6
  sdk: docker
7
+ app_port: 7860 # Dockerfile에서 EXPOSE한 포트와 일치
8
+ # hardware: cpu-upgrade # 기본 CPU (무료)
9
+ # hardware: t4-small # 예시: T4 Small GPU (유료) - LLM 실행에 권장
10
+ # secrets: # .env 파일 대신 여기에 시크릿 설정
11
+ # - OPENAI_API_KEY # 예시
12
+ # - HF_TOKEN # Hugging Face Hub private 모델 접근 시 필요할 수 있음
13
  ---
14
 
15
+ ## 🚀 프로젝트 개요
16
+ 이 Hugging Face Space는 사용자의 한국어 입력을 기반으로 Midjourney 이미지 생성용 영어 프롬프트를 만들어주는 API를 제공합니다.
17
+ 자체 파인튜닝된 언어 모델(`sdgsjlfnjkl/kanana-2.1b-full-v12`)과 LangChain 프레임워크, ChromaDB 벡터 스토어, Wikipedia 컨텍스트 검색 기능을 활용합니다.
18
+
19
+ ## ⚙️ API 엔드포인트
20
+
21
+ - **`GET /`**: API 루트. 간단한 환영 메시지를 반환합니다.
22
+ - **`GET /health`**: 서버 및 주요 구성 요소의 상태를 확인합니다.
23
+ - **`POST /generate`**: 핵심 프롬프트 생성 엔드포인트.
24
+ - Request Body (`application/json`):
25
+ ```json
26
+ {
27
+ "user_input": "푸른 밤하늘 아래 반짝이는 호수와 그 위에 떠 있는 작은 배 한 척"
28
+ }
29
+ ```
30
+ - Response Body (`application/json`):
31
+ ```json
32
+ {
33
+ "generated_prompt": "A small boat floating on a sparkling lake under a blue night sky, detailed, serene, photorealistic.",
34
+ "processing_time_seconds": 5.82,
35
+ "error_message": null
36
+ }
37
+ ```
38
+ - **`POST /reset_memory`**: 서버에 저장된 대화 기록과 위키 검색 기록을 초기화합니다. (모든 사용자에게 영향)
39
+
40
+ ## 📚 API 문서
41
+ 이 Space의 URL 뒤에 `/docs`를 추가하면 (예: `https://your-username-your-space-name.hf.space/docs`) Swagger UI를 통해 API를 테스트하고 문서를 확인할 수 있습니다.
42
+
43
+ ## 🛠️ 주요 기술 스택
44
+ - FastAPI
45
+ - LangChain (LCEL, `ConversationBufferMemory`, `HuggingFaceEmbeddings`, `Chroma`)
46
+ - Transformers (`AutoModelForCausalLM`, `AutoTokenizer`)
47
+ - Sentence Transformers
48
+ - Konlpy (Okt)
49
+ - WikipediaAPI
50
+ - Docker
51
+
52
+ ## ⚠️ 주의사항
53
+ - **초기 로딩 시간**: API 서버 시작 시 다수의 AI 모델을 로딩하므로, Space가 "Running" 상태가 된 후에도 실제 API 응답까지 시간이 걸릴 수 있습니다. Logs 탭에서 "모든 모델 및 설정 로딩 완료" 메시지를 확인하세요.
54
+ - **공유 메모리**: 현재 구현에서 대화 기록과 위키 검색 기록은 모든 API 사용자 간에 공유됩니다.
55
+ - **하드웨어**: `sdgsjlfnjkl/kanana-2.1b-full-v12` 모델의 크기와 복잡성에 따라 GPU 하드웨어가 필요할 수 있습니다. README.md 상단의 `hardware` 설정을 조정하세요.
56
+
57
+ ''