Feedback

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+issue_templates:
+  - name: Feature Template
+    description: Suggest an feature for this project 👩‍💻
+    file: feature.md
+  - name: Experiment Template
+    description: Suggest an experiment for this project 🧑🏻‍🔬
+    file: experiment.md
+  - name: Research Template
+    description: Suggest an research to generate ideas 👨‍🏫
+    file: research.md

.github/ISSUE_TEMPLATE/experiment.md

@@ -0,0 +1,38 @@
+---
+name: 📊 Experiment Request
+about: Suggest an experiment for this project 🧑🏻‍🔬
+title: "[EXP]"
+labels: experiment
+assignees:
+---
+# 📊 Experiment
+
+## 🥚 실험 근거
+
+- 레퍼런스 (논문, 강의, 포스팅)
+- 합리적 추론
+
+## 📎 내용
+
+- 실험에 대한 상세한 내용
+- 실험 환경과 변인 통제 반드시 기입
+
+## 🐣 예상 결과
+
+- 반드시 이유와 함께 예상 결과 작성
+
+## 🍳 실제 결과
+
+- 예상 결과와 달랐다면 그 이유도 함께 작성
+
+## 📝 실험 정보
+
+- wandb 링크
+- 제출 결과 노션 링크
+
+## 📌 체크리스트
+
+- [ ] todo 1
+- [ ] todo 2
+
+---

.github/ISSUE_TEMPLATE/feature.md

@@ -0,0 +1,20 @@
+---
+name: 🚀 Feature Request
+about: Suggest an feature for this project 👩‍💻
+title: "[FEAT]"
+labels: enhancement
+assignees:
+---
+# 🚀 Feature
+
+## 📎 내용
+
+- context 1
+- context 2
+
+## 📌 체크리스트
+
+- [ ] todo 1
+- [ ] todo 2
+
+---

.github/ISSUE_TEMPLATE/research.md

@@ -0,0 +1,25 @@
+---
+name: 📚 Research Request
+about: Suggest an research to generate ideas 👨‍🏫
+title: "[RES]"
+labels: research
+assignees:
+---
+# 📚 Research
+
+## 📎 내용
+
+- context 1
+- context 2
+
+## 🧐 결론 및 실험 가능성
+
+- conclusion 1
+- conclusion 2
+
+## 📌 체크리스트
+
+- [ ] todo 1
+- [ ] todo 2
+
+---

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+## Description
+
+- 이번 PR에서 작업한 내용을 간략히 설명
+
+## Refer to the reviewer
+
+- 리뷰어에게 필요한 설명이나 특별히 봐주었으면 하는 부분을 작성
+
+## Related Issue
+
+- #이슈번호

.github/workflows/check-lint.yml

@@ -0,0 +1,24 @@
+name: check-lint
+
+on: [pull_request]
+
+jobs:
+  check-lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+
+      - name: Check Lint
+        run: |
+          make quality

.gitignore

@@ -0,0 +1,177 @@
+# Custom
+.idea/
+**/data/
+**/output/
+**/outputs/
+**/wandb/
+**/*.out
+config/*.yaml
+config/token.json
+config/credentials.json
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Mac
+**/.DS_Store
+.vscode/settings.json

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-merge-conflict
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.7.2
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: local
+    hooks:
+      - id: pytest
+        name: pytest
+        entry: python3 -m pytest
+        language: system
+        pass_filenames: false
+        types: [python]

Makefile

@@ -0,0 +1,48 @@
+clean: clean-pyc clean-test
+quality: set-style-dep check-quality
+style: set-style-dep set-style
+setup: set-precommit set-style-dep set-test-dep set-git set-dev
+test: set-test-dep set-test
+
+
+##### basic #####
+set-git:
+	git config --local commit.template .gitmessage
+
+set-style-dep:
+	pip3 install ruff==0.7.2
+
+set-test-dep:
+	pip3 install pytest==8.3.2
+
+set-precommit:
+	pip3 install pre-commit==4.0.1
+	pre-commit install
+
+set-dev:
+	pip3 install -r ./requirements.txt
+
+set-test:
+	python3 -m pytest tests/
+
+set-style:
+	ruff check --fix .
+	ruff format .
+
+check-quality:
+	ruff check .
+	ruff format --check .
+
+#####  clean  #####
+clean-pyc:
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test:
+	rm -f .coverage
+	rm -f .coverage.*
+	rm -rf .pytest_cache
+	rm -rf .mypy_cache
+	rm -rf .ruff_cache