lily_fast_api / DEPLOYMENT_CHECKLIST.md
gbrabbit's picture
Fresh start for HF Spaces deployment
526927a
|
raw
history blame
4.71 kB

๐Ÿš€ Lily LLM API - Hugging Face Spaces ๋ฐฐํฌ ์ฒดํฌ๋ฆฌ์ŠคํŠธ

โœ… ๋ฐฐํฌ ์ „ ์ฒดํฌ๋ฆฌ์ŠคํŠธ

๐Ÿ“‹ ํ•„์ˆ˜ ํŒŒ์ผ ํ™•์ธ

  • Dockerfile.huggingface - Docker ์„ค์ • ํŒŒ์ผ
  • app_huggingface.py - Hugging Face Spaces ์ง„์ž…์ 
  • requirements_full.txt - ์™„์ „ํ•œ ์˜์กด์„ฑ ํŒจํ‚ค์ง€ ๋ชฉ๋ก
  • README_huggingface.md - ํ”„๋กœ์ ํŠธ ์„ค๋ช… ๋ฌธ์„œ
  • .dockerignore - Docker ๋นŒ๋“œ ์ œ์™ธ ํŒŒ์ผ ๋ชฉ๋ก

๐Ÿ”ง ํ”„๋กœ์ ํŠธ ๊ตฌ์กฐ ํ™•์ธ

  • lily_llm_api/ - FastAPI ์„œ๋ฒ„ ์ฝ”๋“œ
  • lily_llm_core/ - ํ•ต์‹ฌ RAG ๋ฐ AI ๋กœ์ง
  • lily_llm_utils/ - ์œ ํ‹ธ๋ฆฌํ‹ฐ ํ•จ์ˆ˜๋“ค
  • ๋ชจ๋ธ ํŒŒ์ผ๋“ค์ด ์˜ฌ๋ฐ”๋ฅธ ๊ฒฝ๋กœ์— ์œ„์น˜

๐ŸŒ Hugging Face ๊ณ„์ • ์ค€๋น„

  • Hugging Face ๊ณ„์ • ์ƒ์„ฑ ์™„๋ฃŒ
  • Write ๊ถŒํ•œ์ด ์žˆ๋Š” Access Token ์ƒ์„ฑ
  • ํ† ํฐ์„ ์•ˆ์ „ํ•œ ๊ณณ์— ์ €์žฅ

๐Ÿš€ ๋ฐฐํฌ ๋‹จ๊ณ„

1๋‹จ๊ณ„: Hugging Face Space ์ƒ์„ฑ

  • Hugging Face Spaces ์ ‘์†
  • "Create new Space" ํด๋ฆญ
  • ๋‹ค์Œ ์„ค์ •์œผ๋กœ ์ƒ์„ฑ:
    • Space name: lily-llm-api (๋˜๋Š” ์›ํ•˜๋Š” ์ด๋ฆ„)
    • SDK: Docker ์„ ํƒ
    • Hardware: CPU basic (๋ฌด๋ฃŒ) ๋˜๋Š” CPU upgrade (์œ ๋ฃŒ)
    • Visibility: Public ๋˜๋Š” Private

2๋‹จ๊ณ„: ํŒŒ์ผ ์—…๋กœ๋“œ

  • Space ์ €์žฅ์†Œ ํด๋ก  ๋˜๋Š” ์›น ์ธํ„ฐํŽ˜์ด์Šค ์‚ฌ์šฉ
  • ํ•„์ˆ˜ ํŒŒ์ผ๋“ค์„ ์˜ฌ๋ฐ”๋ฅธ ์ด๋ฆ„์œผ๋กœ ๋ณต์‚ฌ:
    • Dockerfile.huggingface โ†’ Dockerfile
    • requirements_full.txt โ†’ requirements.txt
    • README_huggingface.md โ†’ README.md
  • ์†Œ์Šค ์ฝ”๋“œ ๋””๋ ‰ํ† ๋ฆฌ๋“ค ๋ณต์‚ฌ
  • Git commit ๋ฐ push (Git ๋ฐฉ์‹ ์‚ฌ์šฉ ์‹œ)

3๋‹จ๊ณ„: ํ™˜๊ฒฝ ๋ณ€์ˆ˜ ์„ค์ •

Space Settings > Variables์—์„œ ์„ค์ •:

  • HOST=0.0.0.0
  • PORT=7860
  • PYTHONPATH=/app
  • PYTHONUNBUFFERED=1
  • TOKENIZERS_PARALLELISM=false
  • OMP_NUM_THREADS=1
  • MKL_NUM_THREADS=1

4๋‹จ๊ณ„: ๋นŒ๋“œ ๋ฐ ๋ฐฐํฌ ํ™•์ธ

  • Space ํŽ˜์ด์ง€์—์„œ ๋นŒ๋“œ ๋กœ๊ทธ ํ™•์ธ
  • ์˜ค๋ฅ˜ ๋ฐœ์ƒ ์‹œ ๋กœ๊ทธ ๋ถ„์„ ๋ฐ ์ˆ˜์ •
  • ๋นŒ๋“œ ์™„๋ฃŒ ํ›„ ์•ฑ ์‹คํ–‰ ํ™•์ธ

๐Ÿงช ํ…Œ์ŠคํŠธ ์ฒดํฌ๋ฆฌ์ŠคํŠธ

API ๊ธฐ๋ณธ ํ…Œ์ŠคํŠธ

  • Health Check: GET /health
curl https://YOUR_USERNAME-lily-llm-api.hf.space/health
  • ๋ชจ๋ธ ๋ชฉ๋ก: GET /models
curl https://YOUR_USERNAME-lily-llm-api.hf.space/models
  • ํ…์ŠคํŠธ ์ƒ์„ฑ: POST /generate
curl -X POST https://YOUR_USERNAME-lily-llm-api.hf.space/generate \
  -F "prompt=์•ˆ๋…•ํ•˜์„ธ์š”! ํ…Œ์ŠคํŠธ ๋ฉ”์‹œ์ง€์ž…๋‹ˆ๋‹ค."

๊ณ ๊ธ‰ ๊ธฐ๋Šฅ ํ…Œ์ŠคํŠธ

  • ์ด๋ฏธ์ง€ ์ฒ˜๋ฆฌ ํ…Œ์ŠคํŠธ
  • RAG ์‹œ์Šคํ…œ ํ…Œ์ŠคํŠธ (๋ฌธ์„œ ์—…๋กœ๋“œ ๋ฐ ์งˆ์˜)
  • ๋ฉ€ํ‹ฐ๋ชจ๋‹ฌ ๊ธฐ๋Šฅ ํ…Œ์ŠคํŠธ

์„ฑ๋Šฅ ํ…Œ์ŠคํŠธ

  • ์‘๋‹ต ์‹œ๊ฐ„ ์ธก์ •
  • ๋™์‹œ ์š”์ฒญ ์ฒ˜๋ฆฌ ํ™•์ธ
  • ๋ฉ”๋ชจ๋ฆฌ ์‚ฌ์šฉ๋Ÿ‰ ๋ชจ๋‹ˆํ„ฐ๋ง

๐Ÿ”— Hearth Chat ์—ฐ๋™ ์ค€๋น„

URL ๊ธฐ๋ก

๋ฐฐํฌ ์™„๋ฃŒ ํ›„ ๋‹ค์Œ URL ๊ธฐ๋ก:

  • Hugging Face Space URL: https://YOUR_USERNAME-lily-llm-api.hf.space
  • API ๋ฌธ์„œ URL: https://YOUR_USERNAME-lily-llm-api.hf.space/docs

Hearth Chat ์„ค์ • ์—…๋ฐ์ดํŠธ

  • AI ์„ค์ • ๋ชจ๋‹ฌ์— Lily LLM ์˜ต์…˜ ์ถ”๊ฐ€
  • ๋ฐฑ์—”๋“œ consumers.py์— Hugging Face API ํ˜ธ์ถœ ๋กœ์ง ์ถ”๊ฐ€
  • ํ™˜๊ฒฝ ๋ณ€์ˆ˜์— Lily LLM API URL ์„ค์ •

โŒ ๋ฌธ์ œ ํ•ด๊ฒฐ

์ผ๋ฐ˜์ ์ธ ์˜ค๋ฅ˜์™€ ํ•ด๊ฒฐ์ฑ…

๋นŒ๋“œ ์‹คํŒจ

  • requirements.txt ์˜์กด์„ฑ ํ™•์ธ
  • Dockerfile ๋ฌธ๋ฒ• ์˜ค๋ฅ˜ ํ™•์ธ
  • .dockerignore ํŒŒ์ผ ํ™•์ธ

๋ฉ”๋ชจ๋ฆฌ ๋ถ€์กฑ

  • ๋ถˆํ•„์š”ํ•œ ํŒจํ‚ค์ง€ ์ œ๊ฑฐ
  • ๋ชจ๋ธ ํฌ๊ธฐ ์ตœ์ ํ™”
  • Hardware ์—…๊ทธ๋ ˆ์ด๋“œ ๊ณ ๋ ค

๋ชจ๋“ˆ Import ์˜ค๋ฅ˜

  • PYTHONPATH ํ™˜๊ฒฝ ๋ณ€์ˆ˜ ํ™•์ธ
  • ํŒŒ์ผ ๊ฒฝ๋กœ ๋ฐ ๊ตฌ์กฐ ํ™•์ธ
  • ์˜์กด์„ฑ ํŒจํ‚ค์ง€ ๋ฒ„์ „ ํ™•์ธ

API ์‘๋‹ต ์—†์Œ

  • ํฌํŠธ ์„ค์ • ํ™•์ธ (7860)
  • ๋ฐฉํ™”๋ฒฝ ์„ค์ • ํ™•์ธ
  • ๋กœ๊ทธ์—์„œ ์˜ค๋ฅ˜ ๋ฉ”์‹œ์ง€ ํ™•์ธ

๐Ÿ“Š ๋ชจ๋‹ˆํ„ฐ๋ง ์„ค์ •

๋ฐฐํฌ ํ›„ ๋ชจ๋‹ˆํ„ฐ๋ง

  • Space ๋Œ€์‹œ๋ณด๋“œ์—์„œ ์‚ฌ์šฉ๋Ÿ‰ ํ™•์ธ
  • ๋กœ๊ทธ ์ •๊ธฐ์  ํ™•์ธ
  • ์„ฑ๋Šฅ ๋ฉ”ํŠธ๋ฆญ ๋ชจ๋‹ˆํ„ฐ๋ง
  • ์‚ฌ์šฉ์ž ํ”ผ๋“œ๋ฐฑ ์ˆ˜์ง‘

์œ ์ง€๋ณด์ˆ˜ ๊ณ„ํš

  • ์ •๊ธฐ์  ์—…๋ฐ์ดํŠธ ๊ณ„ํš ์ˆ˜๋ฆฝ
  • ๋ฐฑ์—… ์ „๋žต ์ˆ˜๋ฆฝ
  • ์žฅ์•  ๋Œ€์‘ ๊ณ„ํš ์ˆ˜๋ฆฝ

๐ŸŽ‰ ๋ฐฐํฌ ์™„๋ฃŒ!

๋ชจ๋“  ์ฒดํฌ๋ฆฌ์ŠคํŠธ ํ•ญ๋ชฉ์„ ์™„๋ฃŒํ•˜๋ฉด Lily LLM API๊ฐ€ Hugging Face Spaces์—์„œ ์„ฑ๊ณต์ ์œผ๋กœ ์‹คํ–‰๋ฉ๋‹ˆ๋‹ค.

๋‹ค์Œ ๋‹จ๊ณ„: HEARTH_CHAT_INTEGRATION.md๋ฅผ ์ฐธ์กฐํ•˜์—ฌ Railway Hearth Chat๊ณผ ์—ฐ๋™์„ ์ง„ํ–‰ํ•˜์„ธ์š”.


๐Ÿ“ž ์ง€์›

๋ฐฐํฌ ์ค‘ ๋ฌธ์ œ๊ฐ€ ๋ฐœ์ƒํ•˜๋ฉด:

  1. ๋กœ๊ทธ ํ™•์ธ ๋ฐ ๋ถ„์„
  2. DEPLOYMENT_GUIDE.md ์ƒ์„ธ ๊ฐ€์ด๋“œ ์ฐธ์กฐ
  3. Hugging Face Community ํฌ๋Ÿผ ํ™œ์šฉ
  4. GitHub Issues๋ฅผ ํ†ตํ•œ ๊ธฐ์ˆ  ์ง€์›