Skip to content

Commit 12740e8

Browse files
committed
Update README
1 parent a9c8d7f commit 12740e8

File tree

2 files changed

+24
-12
lines changed

2 files changed

+24
-12
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ A flexible and reusable template for PyTorch-based machine learning experiments.
2020

2121
* **Reproducibility:** Ensure consistent results with built-in seed management.
2222

23-
## 🚀 Quick Start
23+
## Quick Start
2424

2525
1. **Create Your Repository:** Click "Use this template" on the GitHub page to create your own repository based on this template.
2626

@@ -66,7 +66,7 @@ A flexible and reusable template for PyTorch-based machine learning experiments.
6666
python analyze.py
6767
```
6868

69-
## 📖 Documentation
69+
## Documentation
7070

7171
For a deeper dive into the components and customization options, check out the detailed documentation:
7272

README_KR.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,32 @@
44

55
PyTorch 기반 머신러닝 실험을 위한 유연하고 재사용 가능한 템플릿입니다. YAML 설정, 통합된 하이퍼파라미터 최적화(Optuna), 실험 추적(Weights & Biases), 커스텀 컴포넌트, 쉬운 결과 분석으로 워크플로우를 간소화하세요.
66

7-
## 주요 특징
7+
## 주요 특징
88

9-
* **📄 YAML 설정:** 간단한 YAML 파일을 사용하여 모든 실험 설정(모델, 옵티마이저, 스케줄러, 학습 파라미터)을 쉽게 관리합니다.
10-
* **🚀 하이퍼파라미터 최적화:** Optuna 통합을 통해 최적의 하이퍼파라미터를 자동으로 찾습니다.
11-
* **📊 실험 추적:** Weights & Biases를 사용하여 메트릭, 설정, 모델을 원활하게 로깅합니다.
12-
* **✂️ 고급 프루닝:** Predicted Final Loss (PFL) Pruner와 같은 커스텀 프루너를 사용하여 최적화 속도를 높입니다.
13-
* **⚙️ 커스터마이징 가능한 컴포넌트:** 모델 ([`model.py`](model.py)), 학습률 스케줄러, 옵티마이저, 학습 루프 ([`Trainer` in `util.py`](util.py))를 쉽게 추가하거나 수정할 수 있습니다.
14-
* **📈 분석 도구:** 학습된 모델과 최적화 결과를 대화형으로 로드, 분석 및 평가합니다 ([`analyze.py`](analyze.py)).
15-
* **🔄 재현성:** 내장된 시드(seed) 관리를 통해 일관된 결과를 보장합니다.
9+
* **YAML 설정:** 간단한 YAML 파일을 사용하여 모든 실험 설정(모델, 옵티마이저, 스케줄러, 학습 파라미터)을 쉽게 관리합니다.
1610

17-
## 🚀 빠른 시작
11+
* **하이퍼파라미터 최적화:** Optuna 통합을 통해 최적의 하이퍼파라미터를 자동으로 찾습니다.
12+
13+
* **실험 추적:** Weights & Biases를 사용하여 메트릭, 설정, 모델을 원활하게 로깅합니다.
14+
15+
* **고급 프루닝:** Predicted Final Loss (PFL) Pruner와 같은 커스텀 프루너를 사용하여 최적화 속도를 높입니다.
16+
17+
* **커스터마이징 가능한 컴포넌트:** 모델 ([`model.py`](model.py)), 학습률 스케줄러, 옵티마이저, 학습 루프 ([`Trainer` in `util.py`](util.py))를 쉽게 추가하거나 수정할 수 있습니다.
18+
19+
* **분석 도구:** 학습된 모델과 최적화 결과를 대화형으로 로드, 분석 및 평가합니다 ([`analyze.py`](analyze.py)).
20+
21+
* **재현성:** 내장된 시드(seed) 관리를 통해 일관된 결과를 보장합니다.
22+
23+
## 빠른 시작
1824

1925
1. **저장소 만들기:** GitHub 페이지에서 "Use this template"을 클릭하여 이 템플릿을 기반으로 자신의 저장소를 만듭니다.
26+
2027
2. **저장소 복제(Clone):**
2128
```bash
2229
git clone https://github.com/<your-username>/<your-new-repository-name>.git
2330
cd <your-new-repository-name>
2431
```
32+
2533
3. **환경 설정 및 의존성 설치:** ([uv](https://github.com/astral-sh/uv) 사용 권장)
2634
```bash
2735
# 가상 환경 생성 및 활성화
@@ -36,24 +44,28 @@ PyTorch 기반 머신러닝 실험을 위한 유연하고 재사용 가능한
3644
3745
# 또는 pip 사용: pip install -r requirements.txt
3846
```
47+
3948
4. **(선택) Weights & Biases 로그인:**
4049
```bash
4150
wandb login
4251
```
52+
4353
5. **기본 실험 실행:**
4454
```bash
4555
python main.py --run_config configs/run_template.yaml
4656
```
57+
4758
6. **하이퍼파라미터 최적화 실행:**
4859
```bash
4960
python main.py --run_config configs/run_template.yaml --optimize_config configs/optimize_template.yaml
5061
```
62+
5163
7. **결과 분석:**
5264
```bash
5365
python analyze.py
5466
```
5567

56-
## 📖 문서
68+
## 문서
5769

5870
컴포넌트 및 커스터마이징 옵션에 대한 자세한 내용은 상세 문서를 참조하세요:
5971

0 commit comments

Comments
 (0)