Commit 7ae84b72 authored by insun park's avatar insun park
Browse files

chore: 프로젝트 개선을 위한 TODO 리스트 추가

parent c75845c8
# AI 전문가 양성 과정 - 개선 TODO 리스트
# AI Lecture 개선을 위한 TODO 리스트
## 📋 개요
16주 완성 AI 전문가 양성 과정의 개선사항들을 우선순위별로 정리한 문서입니다.
이 문서는 AI Lecture 프로젝트의 개선 사항을 관리하기 위한 TODO 리스트입니다.
---
## 1. 버전 관리 (Git)
## 🔥 높은 우선순위 (즉시 개선 필요)
- [ ] `git status`에 나타난 변경사항들 의미 있는 단위로 커밋하기
- [ ] 원격 저장소(`origin/main`)와 로컬 브랜치 동기화 (`git pull`)
- [ ] `.gitignore` 파일 점검하여 불필요한 파일이 추적되지 않도록 설정
### 1. 빈 소스 코드 파일들 완성
- [x] `source_code/07_deep_learning/part_7.1_recurrent_neural_networks.py` 완성
- LSTM, GRU를 활용한 시계열 데이터 예측 실습
- 100-150줄 정도의 실습 코드 작성
- [x] `source_code/07_deep_learning/part_7.2_transformer_and_llm_principles.py` 완성
- 간단한 Transformer 아키텍처 구현
- Attention 메커니즘 시각화
- 150-200줄 정도의 실습 코드 작성
- [x] `source_code/07_deep_learning/part_7.4_graph_neural_networks.py` 완성
- PyTorch Geometric을 사용한 GNN 기초 실습
- 그래프 분류 또는 노드 분류 예제
- 120-180줄 정도의 실습 코드 작성
- [x] `source_code/07_deep_learning/part_7.5_reinforcement_learning.py` 완성
- Q-Learning 또는 DQN 기초 실습
- OpenAI Gym 환경 활용
- 150-200줄 정도의 실습 코드 작성
## 2. 문서 (Documentation)
### 2. Jupyter 노트북 파일 추가
- [x] `source_code/02_python_core_syntax/part_2_python_core_syntax.ipynb` 생성
- [x] `source_code/03_python_collections/part_3_python_collections.ipynb` 생성
- [x] `source_code/04_object_oriented_programming/part_4_object_oriented_programming.ipynb` 생성
- [x] `source_code/06_machine_learning/part_6_machine_learning.ipynb` 생성
- [x] `source_code/07_deep_learning/part_7_deep_learning.ipynb` 생성
- [x] 각 하위 파트별 노트북 파일들 생성 (7.1, 7.2, 7.4, 7.5)
- [ ] `courses/**/*.md` 파일들의 구조 일관성 확보 (예: 학습 목표, 핵심 요약, 연습 문제 등 공통 섹션 추가)
- [ ] 각 강의별 `glossary.md` 파일을 `ai lecture/glossary.md`로 통합
- [ ] `ai lecture/README.md`에 프로젝트 상세 설명, 시작 가이드, 전체 강의 목록 및 링크 추가
### 3. 기본 테스트 코드 작성
- [x] `source_code/05_ai_core_libraries/tests/test_part_5.py` 생성
- [x] `source_code/06_machine_learning/tests/test_part_6.py` 생성
- [x] `source_code/07_deep_learning/tests/test_part_7.py` 생성
- [x] CI/CD 파이프라인에서 테스트 자동 실행 확인
## 3. 개발 환경 및 의존성
---
- [ ] `pyproject.toml`을 중심으로 의존성 관리 전략 통일
- [ ] `pip-tools` 등을 사용하여 `pyproject.toml`에서 `requirements.txt` 자동 생성 고려
## 🎯 중간 우선순위 (1-2주 내 개선)
## 4. 코드 및 테스트
### 4. 데이터셋 관리 개선
- [x] `datasets/` 폴더 생성 및 구조 설계
- [x] 실습용 샘플 데이터셋 정리
- [x] 머신러닝 실습용 CSV 파일들
- [x] 딥러닝 실습용 이미지 데이터 (소량)
- [x] NLP 실습용 텍스트 데이터
- [x] 데이터 로딩 유틸리티 함수 작성
- [x] 데이터셋 사용 가이드 문서 작성
- [ ] `source_code``.ipynb` 파일과 `.py` 파일의 관계를 해당 폴더의 `README.md`에 명시
- [ ] 테스트 커버리지가 낮은/없는 중요 코드에 대한 테스트 케이스 추가
### 5. 환경 설정 자동화
- [x] `scripts/setup.sh` (Linux/macOS용 설치 스크립트)
- [x] `scripts/setup.ps1` (Windows PowerShell용 설치 스크립트)
- [x] `scripts/run_tests.sh` (테스트 실행 스크립트)
- [x] `scripts/format_code.sh` (코드 포맷팅 스크립트)
- [x] `env.example` 파일 생성 (API 키 관리 템플릿)
## 5. 자동화
### 6. Docker 개발 환경 개선
- [x] 개발용 `Dockerfile.dev` 생성
- [x] `docker-compose.dev.yml` 생성 (로컬 개발 환경)
- [x] Jupyter Lab이 포함된 개발 컨테이너 구성
- [x] GPU 지원 Docker 설정 추가
### 7. 문서화 개선
- [x] 각 `source_code/*/README.md` 파일에 실행 가이드 추가
- [x] 트러블슈팅 가이드 보완 (`TROUBLESHOOTING.md`)
- [x] FAQ 문서 생성 (`FAQ.md`)
- [x] 기여 가이드라인 개선 (`CONTRIBUTING.md`)
---
## 📈 낮은 우선순위 (장기적 개선)
### 8. 인터랙티브 학습 도구
- [ ] Streamlit 기반 모델 데모 앱 개발
- [ ] 머신러닝 모델 시각화 대시보드
- [ ] 딥러닝 모델 추론 데모
- [ ] RAG 챗봇 데모
- [ ] 모델 성능 시각화 도구
- [ ] 하이퍼파라미터 튜닝 시각화
### 9. 평가 및 진도 관리 시스템
- [ ] 자동 채점 시스템 구축
- [ ] 진도 추적 대시보드
- [ ] 코드 품질 자동 평가
- [ ] 학습 성과 분석 도구
### 10. 커뮤니티 및 협업 기능
- [ ] GitHub Discussions 활성화
- [ ] 프로젝트 템플릿 제공
- [ ] 우수 프로젝트 쇼케이스
- [ ] 멘토링 시스템 구축
---
## 🛠️ 기술적 개선사항
### 11. 코드 품질 및 성능
- [ ] 타입 힌트 추가 (MyPy 오류 해결)
- [ ] 코드 리팩토링 (중복 코드 제거)
- [ ] 메모리 효율적인 데이터 로딩
- [ ] 병렬 처리 최적화
### 12. CI/CD 파이프라인 개선
- [ ] 단계별 테스트 분리 (unit, integration, e2e)
- [ ] 성능 벤치마크 자동화
- [ ] 배포 자동화 (GitHub Pages, DockerHub)
- [ ] 보안 취약점 스캔 강화
### 13. 모니터링 및 로깅
- [ ] 실습 코드 실행 로그 수집
- [ ] 오류 추적 시스템
- [ ] 사용자 행동 분석
- [ ] 시스템 성능 모니터링
---
## 📅 마일스톤 계획
### Phase 1 (1주차)
- [x] TODO 리스트 작성
- [x] 빈 소스 코드 파일 완성 (Part 7 하위 파일들)
- [x] 기본 테스트 코드 작성 (일부 완료)
### Phase 2 (2-3주차)
- [x] Jupyter 노트북 파일 생성
- [x] 데이터셋 정리 및 관리
- [x] 환경 설정 자동화
### Phase 3 (4-6주차)
- [x] Docker 개발 환경 개선
- [x] 문서화 개선
- [ ] 인터랙티브 학습 도구 개발
### Phase 4 (장기)
- [ ] 평가 시스템 구축
- [ ] 커뮤니티 기능 개발
- [ ] 고급 기능 구현
---
## 🤝 기여 방법
1. 이슈 생성 후 작업 시작
2. 브랜치 생성: `feature/todo-item-name`
3. Pull Request 생성 및 리뷰 요청
4. 완료 후 체크박스 체크
---
**마지막 업데이트:** 2024-12-28
**담당자:** AI Expert Course Team
**완료 상태:** Phase 1-3 모든 주요 작업 완료 ✅
\ No newline at end of file
- [ ] `Makefile`을 도입하여 `format`, `test` 등 자주 사용하는 스크립트 명령어 단순화
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment