[Google mlb] Gemma Sprint - 코딩역량평가시스템

 

 

pythonic한 코드를 작성해보자!

 

 

위의 내용은 이번 프로젝트의 주요 목표로, python의 철학과 스타일에 충실한 코드를 작성하는 것에 중점을 두고 있다.

 

여기서 "Pythonic"이란 단순히 python으로 작성된 코드를 의미하는 것이 아니라, python의 기본적인 설계 철학과 문화를 체화한 코드이다. 

 

즉, 가독성이 뛰어나고, 간결하며, 파이썬 언어가 제공하는 고유한 기능을 잘 활용하는 코드라고 말할 수 있다.

 

이 프로젝트로 내가 얼마나 코드를 잘 작성하였는지 평가해보고자 한다.

---

사진 출처 : https://velog.io/@poagg42/gitflow-workflow

 

우선 효율적인 협업을 하기 위하여 git flow방식을 사용하여 브랜치를 관리하였다. (처음 써봐서 많이 버벅였다.)

 

 

 pythonic한 기준?

 

코드를 평가할 수 있는 기준을 세우기 위하여 

 

PEP8 : Style Guide for Pyhotn Code 와 python 공식 tutorial 가이드(python 3.11버전 기준)를 선정하였다. 

 

*PEP8은 python 개선 제안서로 python 코드 작성 시 따라야할 스타일 가이드라인을 정의한 문서

 들여쓰기, 라인 길이, 임포트 규칙 등 여러가지 규칙을 제공하여 협업 시 일관성을 유지하고, 코드 리뷰 및 유지보수가 용이해지도록 하는 Pythonic한 코드를 작성하는 데 중요한 요소

 

PEP 8 – Style Guide for Python Code | peps.python.org

 

The Python Tutorial

 

 

시스템의 주요 구성 요소

 

• 문서 임베딩과 검색
  PEP8 문서를 임베딩하여 작성한 코드가 가이드라인에 얼마나 잘 준수하였는지 평가
  
  
• 거대언어모델 기반 평가
  다양한 PEP8 가이드라인을 학습한 모델을 사용하여 사용자의 코드를 종합적으로 분석을 진행
  여기서 BM25와 벡터 임베딩 기반의 검색을 혼합하여 가장 관련성 높은 정보를 찾아낸 것을 바탕으로 사용자의 코드평가
  
  
• 자동화된 평가 및 결과 저장
  사용자 코드 목록을 입력받아 각 코드의 스타일, 가독성, 일관성 등을 평가하고, 개선이 필요한 부분에 대해 실질적인 피드백을 제공을 마크다운 형식으로 자동 저장

 

결과

 

# ex1

 

 

# ex2

 

 

pythonic하게 코드를 수정하여 응답하는 것을 볼 수 있다.

 

---

GitHub - effort-type/Coding-Skils-Evaluation

 

더 많은 예시와 자세한 코드는 깃허브에서 확인할 수 있다.