Skip to content

Latest commit

ย 

History

History
131 lines (97 loc) ยท 4.98 KB

README.md

File metadata and controls

131 lines (97 loc) ยท 4.98 KB

muchu-mlserver

๐Ÿ”ฅ Mu-Chu(๋ฌด์ถ”) : ๊ฒ€์ƒ‰ ํ‚ค์›Œ๋“œ์— ๋งž๋Š” ๋ฌดํ•œ๋„์ „ ์งค์„ ์ถ”์ฒœํ•ด์ฃผ๋Š” ์„œ๋น„์Šค


์„œ๋น„์Šค ์„ค๋ช…

๊ฒ€์ƒ‰ ๊ธฐ๋Šฅ์„ ํ†ตํ•ด ํ‚ค์›Œ๋“œ์— ๋งž๋Š” ๋ฌดํ•œ๋„์ „ ์งค์„ ์ถ”์ฒœํ•ด์ฃผ๊ณ , ์‚ฌ์šฉ์ž๊ฐ€ ์ข‹์•„ํ•  ๋งŒํ•œ ์งค์„ ์ถ”์ฒœํ•ด์ฃผ๋Š” ์„œ๋น„์Šค

  • ์ตœ์†Œ ๊ธฐ๋Šฅ (MVP)

    • ๋ฐฑ์—”๋“œ ์„œ๋ฒ„์™€์˜ ํ†ต์‹ (๋ฐฑ์—”๋“œ ์„œ๋ฒ„๋ฅผ ํ†ตํ•ด ๋‹จ์–ด๋ฅผ ๋ฐ›์•„ ๋ชจ๋ธ(PCA, K-means)์— ๋„ฃ๊ณ , ์ถœ๋ ฅ์„ ๋ฐ˜ํ™˜)

๊ณตํ†ต ์ปจ๋ฒค์…˜ (Convention)

๐ŸŒด Branch ์ „๋žต

  • Git Flow
ํ•ญ๋ชฉ ์„ค๋ช…
main ๊ธฐ์ค€์ด ๋˜๋Š” ๋ธŒ๋žœ์น˜๋กœ ์ œํ’ˆ์„ ๋ฐฐํฌํ•˜๋Š” ๋ธŒ๋žœ์น˜
develop ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜๋กœ ๊ฐœ๋ฐœ์ž๋“ค์ด ์ด ๋ธŒ๋žœ์น˜๋ฅผ ๊ธฐ์ค€์œผ๋กœ ๊ฐ์ž ์ž‘์—…ํ•œ ๊ธฐ๋Šฅ๋“ค์„ Merge
feature ๋‹จ์œ„ ๊ธฐ๋Šฅ์„ ๊ฐœ๋ฐœํ•˜๋Š” ๋ธŒ๋žœ์น˜๋กœ ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ์ด ์™„๋ฃŒ๋˜๋ฉด develop ๋ธŒ๋žœ์น˜์— Merge
  • Git Flow ๊ณผ์ •

    • master ๋ธŒ๋žœ์น˜์—์„œ develop ๋ธŒ๋žœ์น˜๋ฅผ ๋ถ„๊ธฐํ•จ
    • ๊ฐœ๋ฐœ์ž๋“ค์€ develop ๋ธŒ๋žœ์น˜์— ์ž์œ ๋กญ๊ฒŒ ์ปค๋ฐ‹์„ ํ•จ
    • ๊ธฐ๋Šฅ ๊ตฌํ˜„์ด ์žˆ๋Š” ๊ฒฝ์šฐ develop ๋ธŒ๋žœ์น˜์—์„œ feature/* ๋ธŒ๋žœ์น˜๋ฅผ ๋ถ„๊ธฐํ•ฉ๋‹ˆ๋‹ค.
    • ๊ธฐ๋Šฅ ๊ตฌํ˜„ ์ตœ์ข… ์™„๋ฃŒ ํ›„, ํ…Œ์ŠคํŠธ๋ฅผ ์œ„ํ•ด develop ๋ธŒ๋žœ์น˜์—์„œ ํ…Œ์ŠคํŠธ๋ฅผ ์ง„ํ–‰
    • ํ…Œ์ŠคํŠธ๊ฐ€ ์™„๋ฃŒ๋˜๋ฉด develop ๋ธŒ๋žœ์น˜๋ฅผ main ๋ธŒ๋žœ์น˜์— merge
  • ๋ณดํ†ต main <- release <- develop(default) <- feature

    • ๋ชจ๋“  ๊ธฐ๋Šฅ ๊ตฌํ˜„์€ feature์„ ์ด์šฉํ•ด ๋ธŒ๋žœ์น˜๋ฅผ ๋ถ„๊ธฐํ•ด ๊ฐœ๋ฐœ ํ›„ devleop์œผ๋กœ pull-request ํ•˜๊ธฐ!
    • ์ง์ ‘ develop์œผ๋กœ push โŒโŒ
  • ์˜ˆ์‹œ : feature/login

๐Ÿ• Commit ์ „๋žต

ํƒœ๊ทธ ์„ค๋ช…
Feat ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์„ ์ถ”๊ฐ€ํ•œ ๊ฒฝ์šฐ
Fix ์—๋Ÿฌ๋ฅผ ์ˆ˜์ •ํ•œ ๊ฒฝ์šฐ
Design CSS ๋“ฑ UI ๋””์ž์ธ์„ ๋ณ€๊ฒฝํ•œ ๊ฒฝ์šฐ
BREAKING CHANGE ์ค‘๋Œ€ํ•œ API๋ฅผ ๋ณ€๊ฒฝํ•œ ๊ฒฝ์šฐ
HOTFIX ๊ธ‰ํ•˜๊ฒŒ ์น˜๋ช…์ ์ธ ์—๋Ÿฌ๋ฅผ ๊ณ ์นœ ๊ฒฝ์šฐ
Style ์ฝ”๋“œ ํฌ๋งท ๋ณ€๊ฒฝ์„ ํ•˜๊ฑฐ๋‚˜ ์„ธ๋ฏธ ์ฝœ๋ก  ๋ˆ„๋ฝํ•˜์—ฌ ์ถ”๊ฐ€ํ•˜๋ฉด์„œ ์ฝ”๋“œ ์ˆ˜์ •์ด ์—†๋Š” ๊ฒฝ์šฐ
Refactor ์ฝ”๋“œ๋ฅผ ๋ฆฌํŒฉํ† ๋งํ•œ ๊ฒฝ์šฐ
Comment ์ฃผ์„์„ ์ถ”๊ฐ€ํ•˜๊ฑฐ๋‚˜ ๋ณ€๊ฒฝํ•œ ๊ฒฝ์šฐ
Docs ๋ฌธ์„œ๋ฅผ ์ˆ˜์ •ํ•œ ๊ฒฝ์šฐ
Test ํ…Œ์ŠคํŠธ ์ฝ”๋“œ๋ฅผ ์ถ”๊ฐ€, ๋ณ€๊ฒฝ, ๋ฆฌํŒฉํ† ๋งํ•œ ๊ฒฝ์šฐ
Chore ๊ธฐํƒ€ ๋ณ€๊ฒฝ์‚ฌํ•ญ (๋นŒ๋“œ ์Šคํฌ๋ฆฝํŠธ ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ง• ์„ค์ • ๋“ฑ)
Rename ํŒŒ์ผ or ํด๋”๋ช… ์ˆ˜์ •ํ•˜๊ฑฐ๋‚˜ ์˜ฎ๊ธฐ๋Š” ๊ฒฝ์šฐ
Remove ํŒŒ์ผ์„ ์‚ญ์ œํ•˜๋Š” ์ž‘์—…๋งŒ ์ˆ˜ํ–‰ํ•œ ๊ฒฝ์šฐ
  1. ์ œ๋ชฉ
  - "[ํƒœ๊ทธ] ์š”์•ฝ ๋ฉ”์‹œ์ง€" ํ˜•์‹์œผ๋กœ ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค.
  - ์ด ๊ธ€์ž ์ˆ˜๋Š” 50์ž ์ด๋‚ด๋กœ ํ•ฉ๋‹ˆ๋‹ค.
  - ๋ฌธ์žฅ์˜ ๋์— ํŠน์ˆ˜๋ฌธ์ž๋Š” ์‚ฝ์ž…ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ์˜ˆ) ., !, ?
  - ์š”์•ฝ ๋ฉ”์‹œ์ง€์˜ ํ˜•ํƒœ๋Š” ํ•œ๊ธ€, ์˜์–ด ๋ชจ๋‘ ํ—ˆ์šฉํ•ฉ๋‹ˆ๋‹ค.
  1. ๋ณธ๋ฌธ
  - ๋ณธ๋ฌธ์€ ํ•œ ์ค„ ๋‹น 72์ž ์ด๋‚ด๋กœ ํ•ฉ๋‹ˆ๋‹ค.
  - ๋ณธ๋ฌธ ๋‚ด์šฉ์€ ์–‘์— ๊ตฌ์• ๋ฐ›์ง€ ์•Š๊ณ  ์ตœ๋Œ€ํ•œ ์ƒ์„ธํžˆ ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค.
  - ๋ณธ๋ฌธ ๋‚ด์šฉ์€ ์–ด๋–ป๊ฒŒ ๋ณ€๊ฒฝํ–ˆ๋Š”์ง€ ๋ณด๋‹ค ๋ฌด์—‡์„ ๋ณ€๊ฒฝํ–ˆ๋Š”์ง€ ๋˜๋Š” ์™œ ๋ณ€๊ฒฝํ–ˆ๋Š”์ง€๋ฅผ ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค.
  1. ๊ผฌ๋ฆฟ๋ง
  - ๊ผฌ๋ฆฟ๋ง์€ ์•„๋ž˜์— ์ž‘์„ฑ: ex) #์ด์Šˆ ๋ฒˆํ˜ธ
  - ๊ผฌ๋ฆฌ๋ง์€ ๋ฐ˜๋“œ์‹œ ์ž‘์„ฑํ•  ํ•„์š”๋Š” ์—†์Šต๋‹ˆ๋‹ค.
  - << ์œ ํ˜• >>: #<< ์ด์Šˆ ๋ฒˆํ˜ธ >> ํ˜•์‹์œผ๋กœ ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค.
  - ์—ฌ๋Ÿฌ ๊ฐœ์˜ ์ด์Šˆ ๋ฒˆํ˜ธ๋ฅผ ์ ์„ ๋•Œ๋Š” ์‰ผํ‘œ๋กœ ๊ตฌ๋ถ„ํ•ฉ๋‹ˆ๋‹ค.
  - ์ด์Šˆ ํŠธ๋ž˜์ปค ์œ ํ˜•์€ ๋‹ค์Œ ์ค‘ ํ•˜๋‚˜๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.
    - Fixes: ์ด์Šˆ ์ˆ˜์ •์ค‘ (์•„์ง ํ•ด๊ฒฐ๋˜์ง€ ์•Š์€ ๊ฒฝ์šฐ)
    - Resolves: ์ด์Šˆ๋ฅผ ํ•ด๊ฒฐํ–ˆ์„ ๋•Œ ์‚ฌ์šฉ
    - Ref: ์ฐธ๊ณ ํ•  ์ด์Šˆ๊ฐ€ ์žˆ์„ ๋•Œ ์‚ฌ์šฉ
    - Related to: ํ•ด๋‹น ์ปค๋ฐ‹์— ๊ด€๋ จ๋œ ์ด์Šˆ๋ฒˆํ˜ธ (์•„์ง ํ•ด๊ฒฐ๋˜์ง€ ์•Š์€ ๊ฒฝ์šฐ)
  • ์˜ˆ์‹œ
[Feat] ์‚ฌ์šฉ์ž ์ธ์ฆ ๊ธฐ๋Šฅ ๊ตฌํ˜„

- OAuth ์—ฐ๋™
- ํšŒ์›๊ฐ€์ž…๊ณผ ๋กœ๊ทธ์ธ ๋กœ์ง ๊ตฌํ˜„
- ๋กœ๊ทธ์ธ, ํšŒ์›๊ฐ€์ž… ํผ ์ปดํฌ๋„ŒํŠธ ๊ตฌํ˜„

Fixes: #13
Resolves: #11, #12
Ref: #10
Related to: # 14

๐Ÿญ PR ์ „๋žต

  • PR Template์— ๋”ฐ๋ฆ„

MLServer

โœจ ๊ธฐ์ˆ  ์„ค๋ช…

Python, Scikit-learn, Flask ๋“ฑ์„ ํ†ตํ•ด ๋จธ์‹ ๋Ÿฌ๋‹ ์„œ๋ฒ„ ๊ฐœ๋ฐœ

๐Ÿ”ฅ ๊ธฐ์ˆ  ์Šคํƒ

ํ•ญ๋ชฉ ๊ธฐ์ˆ  ์Šคํƒ
์‚ฌ์šฉ์–ธ์–ด Python
์„œ๋ฒ„ AWS EC2, Flask
ML Scikit-learn
์‹œ๊ฐํ™” Seaborn, Matplotlib

โœ” ์ถ”๊ฐ€ ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ & ๋ฒ„์ „ ์ •๋ณด

ํ•ญ๋ชฉ ๋ฒ„์ „ ์ •๋ณด
Python v3.8.8
Flask v2.3.3