Feedback

.github/ISSUE_TEMPLATE/-title----body.md

@@ -0,0 +1,22 @@
+---
+name: "title/ body"
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Issue 타입(하나 이상의 Issue 타입을 선택해주세요)
+- [ ] Feat : 새로운 기능 추가
+- [ ] Remove : 파일 및 기능 삭제
+- [ ] Test : 테스트 코드 추가
+- [ ] Fix : 버그 수정
+- [ ] Docs : 문서 수정
+- [ ] Refactor : 코드 리펙토링
+- [ ] Style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우, 주석 추가
+
+### 상세 내용
+- [ ] ex) Github 소셜 로그인 기능이 필요합니다.
+
+### 추가사항

.github/pull_request_template.md

@@ -0,0 +1,17 @@
+### PR 타입(하나 이상의 PR 타입을 선택해주세요)
+- [ ] Feat : 새로운 기능 추가
+- [ ] Remove : 파일 및 기능 삭제
+- [ ] Test : 테스트 코드 추가
+- [ ] Fix : 버그 수정
+- [ ] Docs : 문서 수정
+- [ ] Refactor : 코드 리펙토링
+- [ ] Style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우, 주석 추가
+
+### 반영 브랜치
+ex) feat/login -> dev
+
+### 변경 사항
+ex) 로그인 시, 구글 소셜 로그인 기능을 추가했습니다.
+
+### 테스트 결과
+ex) 베이스 브랜치에 포함되기 위한 코드는 모두 정상적으로 동작해야 합니다. 결과물에 대한 스크린샷, GIF, 혹은 라이브 데모가 가능하도록 샘플API를 첨부할 수도 있습니다.

.gitignore

@@ -0,0 +1,132 @@
+/checkpoints
+/wandb
+/data
+baseline_code.ipynb
+*.csv
+gradcam/
+augmented_images/
+logs/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# input data, saved log, checkpoints
+data/
+input/
+saved/
+datasets/
+/data.tar.gz
+._data
+
+# editor, os cache directory
+.vscode/
+.idea/
+__MACOSX/
+
+# data.zip
+data.tar.gz
+
+nohup.out
+
+*.csv
+
+config.txt

README.md

@@ -0,0 +1,196 @@
+![imagenet-sketch](https://github.com/user-attachments/assets/a6307765-05bc-4cc7-9cd6-c4b6d70e9427)
+
+<br/>
+<br/>
+
+# 1. Project Overview (프로젝트 개요)
+- 프로젝트 이름: Sketch 이미지 데이터 분류
+- 프로젝트 설명: Sketch기반 이미지를 분류하여 어떤 객체를 나타내는지 예측하는 대회
+
+<br/>
+<br/>
+
+# Team Members (팀원 및 팀 소개)
+| 곽기훈 | 김재환 | 양호철 | 오종민 | 조소윤 | 홍유향 |
+|:------:|:------:|:------:|:------:|:------:|:------:|
+| <img src="https://github.com/user-attachments/assets/fb56b1d0-9c5c-49c0-a274-f5b7ff7ab8b1" alt="곽기훈" width="150"> | <img src="https://github.com/user-attachments/assets/28a7109b-4959-473c-a6e4-5ee736370ab6" alt="김재환" width="150"> | <img src="https://github.com/user-attachments/assets/9007ffff-765c-4ffa-80bf-31668fe199ba" alt="양호철" width="150"> | <img src="https://github.com/user-attachments/assets/8760f7bd-10d8-4397-952b-f1ca562b90d4" alt="오종민" width="150"> | <img src="https://github.com/user-attachments/assets/22baca4a-189a-4bc3-ab1c-8f6256637a16" alt="조소윤" width="150"> | <img src="https://github.com/user-attachments/assets/91f96db7-3137-42d2-9175-8a55f1493b31" alt="홍유향" width="150"> |
+| T7102 | T7128 | T7204 | T7207 | T7252 | T7267 |
+| [GitHub](https://github.com/kkh090) | [GitHub](https://github.com/Ja2Hw) | [GitHub](https://github.com/hocheol0303) | [GitHub](https://github.com/sejongmin) | [GitHub](https://github.com/whthdbs03) | [GitHub](https://github.com/hyanghyanging) | 
+
+<br/>
+<br/>
+
+# 개발 환경 및 버젼
+```
+python==3.10.14
+pandas==2.1.4
+matplotlib==3.8.4
+seaborn==0.13.2
+Pillow==10.3.0
+numpy==1.26.3
+timm==0.9.16
+albumentations==1.4.4
+tqdm==4.66.1
+scikit-learn==1.4.2
+opencv-python==4.9.0.80
+```
+
+<br/>
+<br/>
+
+# 학습 코드 실행
+```
+sh train.sh
+```
+모델 학습에 필요한 하이퍼파라미터는 train.sh와 args.py에서 확인할 수 있습니다. 
+
+<br/>
+<br/>
+
+# 추론 코드 실행
+```
+sh test.sh
+```
+모델 추론에 필요한 하이퍼파라미터는 test.sh와 args.py에서 확인할 수 있습니다. 
+
+<br/>
+<br/>
+
+# Project Structure (프로젝트 구조)
+```plaintext
+📦level1-imageclassification-cv-16
+ ┣ 📂.github
+ ┃ ┣ 📂ISSUE_TEMPLATE
+ ┃ ┃ ┗ 📜-title----body.md
+ ┃ ┣ 📜.keep
+ ┃ ┗ 📜pull_request_template.md
+ ┣ 📂model
+ ┃ ┣ 📜cnn.py
+ ┃ ┣ 📜mlp.py
+ ┃ ┣ 📜model_selection.py
+ ┃ ┣ 📜resnet18.py
+ ┃ ┣ 📜timm.py
+ ┃ ┗ 📜torchvision_model.py
+ ┣ 📂util
+ ┃ ┣ 📜augmentation.py
+ ┃ ┣ 📜checkpoints.py
+ ┃ ┣ 📜data.py
+ ┃ ┣ 📜losses.py
+ ┃ ┣ 📜metrics.py
+ ┃ ┣ 📜optimizers.py
+ ┃ ┗ 📜schedulers.py
+ ┣ 📜.gitignore
+ ┣ 📜README.md
+ ┣ 📜args.py
+ ┣ 📜eda.ipynb
+ ┣ 📜eda.py
+ ┣ 📜erase_dot_files.py
+ ┣ 📜gradcam.py
+ ┣ 📜image_augmentation.py
+ ┣ 📜separate.py
+ ┣ 📜test.py
+ ┣ 📜test.sh
+ ┣ 📜train.ipynb
+ ┣ 📜train.py
+ ┣ 📜train.sh
+ ┗ 📜trainer.py
+```
+
+<br/>
+
+### train.sh
+- train.py 파일을 실행시키면서 학습에 필요한 인자를 입력하는 쉘 스크립트 파일. 학습 재개 시 저장 시점과 동일한 하이퍼파라미터를 사용
+```
+ --mode: train 모드, test 모드 있음. train.sh에선 train 고정
+ --device: cpu, gpu 선택
+ --data_root: data 디렉터리 고정
+ --csv_path: train(+validation) 데이터셋 파일 경로 설정
+ --val_csv: 사용x
+ --height, --width: 학습 데이터셋의 Resize 크기 결정
+ --num_classes: class 개수 입력
+ --auto_split: 사용x
+ --split_seed: train_test_split의 random state seed 값 설정
+ --stratify: train_test_split의 비율을 고정하는 기준이 될 column 결정
+ --model: 사용할 모델명 기입. timm의 경우 timm-model_name 형태로 입력하면 timm 라이브러리의 모델을 불러옴
+ --lr: 학습률 설정
+ --lr_scheduler: 스케줄러 선택
+ --lr_scheduler_gamma: stepLR, RduceLROnPlateau의 learning rate decay 감소 비율을 지정하는 파라미터
+ --lr_scheduler_epochs_per_decay: stepLR의 lr 감소 주기 설정
+ --batch: 배치 사이즈
+ --loss: loss function 선택
+ --optim: 옵티마이저 선택
+ --r_epochs: train set과 validation set의 크기를 바꾸기 시작하는 에포크 설정 (뒤에서 n번째부터 시작)
+ --seed: random값의 기준 설정
+ --transform: 사용할 augmentation 클래스(라이브러리 기준으로 나눔)를 선택
+ --augmentations: 사용할 augmentation 기법을 설정. "_"로 split하여 string 분리
+ --adjust_ratio: 이미지의 종횡비를 1:1로 맞춤
+ --eraly_stopping: 개선이 있는지 감시할 epoch 수 설정. 이 epoch동안 validation accuracy의 개선이 없으면 학습 중단
+ --verbose: tqdm 사용 여부 결정. 주석 풀면 True, 아니면 False
+ --resume, --checkpoint_path: 체크포인트에 저장된 모델 불러오기 여부, 체크포인트.pt 파일 경로. 세트로 사용
+```
+### train.py
+- trainer.py의 trainer 클래스를 불러와서 학습 시킴
+
+### test.sh, test.py
+- test.sh에서 인자를 받아 test.py 파일을 실행해 test data의 예측 결과 저장. train.sh와 비슷
+
+### trainer.py
+- 학습 모듈
+```
+ -create_config_txt : train.sh 호출 당시 내용을 checkpoint 폴더에 함께 저장하여 어떤 하이퍼파라미터를 사용했는지 기록
+ -save_checkpoint_tmp : 이전 fold(or epoch)와 비교하여 validation accuracy가 1% 이상 개선되면 checkpoint 저장
+ -final_save_model : 이전 accuracy와 관계 없이 마지막 모델 저장
+ -train_epoch : 모델학습 1 epoch 수행
+ -validate : 모델 검증 수행
+ -train : epoch만큼 학습하는 함수. train.sh를 통해 전달받은 resome 파라미터가 true이면 self.load_settings 함수로 checkpoint 모델을 불러옴
+ -k_fold_train : train 함수에 K-Fold Cross Validation을 적용함
+ -load_settings 체크포인트 저장 시점의 모델과 optimizer, scheduler 등 학습에 필요한 정보를 불러옴
+```
+### eda.py
+- 모든 데이터의 메타데이터를 추출하여 csv파일로 만드는 파일
+
+### args.py
+- train.sh, test.sh에서 받아온 인자를 파이썬에서 사용할 수 있는 변수로 변환하는 모듈
+
+### gradcam.py 
+- Grad-CAM을 통해 Heatmap을 반환하는 함수를 포함하는 파일
+
+### image_augmentation.py
+- offline augmentation하는 파일. 종횡비를 맞추기 위해 흰 배경 추가하는 코드와 flip을 적용하는 코드가 있다. 추가된 이미지를 포함한 ./data/train1.csv 파일을 생성
+
+### separate.py
+- 데이터셋을 물리적으로 분리하는 파일
+
+### util/augmentation.py
+- augmentation 라이브러리를 관리하는 모듈. Albumentation을 사용
+```
+ -AlbumentationsTransforms 클래스: train.sh에서 받는 augmentations 인자를 가지고 클래스의 생성자가 full_aug_list를 보고 aug_list에 추가하여 사용할 증강 기법을 선택
+ -TransformSelector: train.sh에서 받은 transform 인자로 어떤 증강 클래스를 사용할지 선택
+```
+### util/checkpoints.py
+- 체크포인트를 저장/불러오기 하는 모듈
+
+### util/data.py
+- Dataset, DataLoader를 재정의하는 모듈
+```
+ -CustomDataset 클래스: 대회를 위해 제공받은 데이터셋에 맞게 데이터를 불러오게하는 Dataset
+ -HoDataset, HoDataLoader 클래스: K-Fold cross validation을 위한 Dataset, DataLoader
+```
+### util/losses.py
+- loss function을 가짐
+
+### util/metrics.py
+- f1 score을 계산하는 모듈
+
+### util/optimizers.py
+- train.sh의 optim 인자를 받아서 optimizer를 선택할 수 있게 매핑하는 모듈
+
+### util/schedulers.py
+- train.sh의 lr_scheduler 인자를 받아서 learning rate scheduler를 선택할 수 있게 매핑하는 모듈
+
+### model/
+- model_selection 파일은 다른 모델을 불러오는 파일. timm, torchvision_model은 라이브러리를 쉽게 불러오기 위한 모듈
+
+## 🔗 Reference
+
+### [📎 Wrapup Report](https://docs.google.com/document/d/1iAlyNw4r-V-5Q_FQlzzRdhlUt59wazMfl9hgjmcYV4o/edit?usp=sharing)