Skip to content
This repository was archived by the owner on Nov 21, 2022. It is now read-only.

Commit a666622

Browse files
author
Issa
committed
Update Readme instructions
1 parent 2ca3a72 commit a666622

File tree

3 files changed

+22
-3
lines changed

3 files changed

+22
-3
lines changed

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ __pycache__/
1414
.idea/
1515

1616
# Private folders
17-
data/
1817
models/
1918
wandb/
19+
data/
2020

2121
# Distribution / packaging
2222
.Python

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,25 @@ cd src
6464
python train.py
6565
```
6666

67+
Usage is as follows:
68+
```s
69+
usage: train.py [-h] [--batch-size N] [--lr LR] [--epochs N] [--factor N]
70+
[--patience N] [--data-dir S] [--model-best-dir S]
71+
[--checkpoint-dir S]
72+
Philippine Poverty Prediction
73+
optional arguments:
74+
-h, --help show this help message and exit
75+
--batch-size N input batch size for training (default: 32)
76+
--lr LR learning rate (default: 1e-6)
77+
--epochs N number of epochs to train (default: 100)
78+
--factor N factor to reduce learning rate by on pleateau (default:
79+
0.1)
80+
--patience N number of iterations before reducing lr (default: 10)
81+
--data-dir S data directory (default: "../data/images/")
82+
--model-best-dir S best model path (default: "../models/model.pt")
83+
--checkpoint-dir S model directory (default: "../models/")
84+
```
85+
6786
## Code Organization
6887

6988
This repository is divided into three main parts:

src/train.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,11 @@ def main(args):
9494
)
9595
parser.add_argument(
9696
'--model-best-dir', type=str, default="../models/model.pt", metavar='S',
97-
help='data directory (default: "../models/model.pt")'
97+
help='besy model path (default: "../models/model.pt")'
9898
)
9999
parser.add_argument(
100100
'--checkpoint-dir', type=str, default="../models/", metavar='S',
101-
help='data directory (default: "../models/")'
101+
help='model directory (default: "../models/")'
102102
)
103103
args = parser.parse_args()
104104
wandb.config.update(args)

0 commit comments

Comments
 (0)