ByteJoseph commited on
Commit
d391d09
·
verified ·
1 Parent(s): dbadc63

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +46 -41
README.md CHANGED
@@ -1,41 +1,46 @@
1
- # SolveQ
2
-
3
- Simple neural network that learns `y = 2x + 3`. Built with PyTorch.
4
-
5
- ## What it does
6
-
7
- Trains a small network to approximate a linear function. The model has one hidden layer and learns from synthetic data.
8
-
9
- ## Setup
10
-
11
- ```bash
12
- pip install -r requirements.txt
13
- ```
14
-
15
- ## Running
16
-
17
- Train the model:
18
-
19
- ```bash
20
- python src/train.py
21
- ```
22
-
23
- This generates 200 samples, trains for 1000 epochs, shows the loss plot, and saves to `models/model.pt`.
24
-
25
- ![Training Loss](models/loss.png)
26
-
27
- Make predictions:
28
-
29
- ```bash
30
- python src/predict.py
31
- ```
32
-
33
- Predicts `x = 4.0` by default. To test other values, edit the `predict()` call in `predict.py`.
34
-
35
- ## Model
36
-
37
- - Input: 1 neuron
38
- - Hidden: 16 neurons (ReLU)
39
- - Output: 1 neuron
40
-
41
- Uses Adam optimizer (lr=0.01) and MSE loss.
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ metrics:
4
+ - accuracy
5
+ ---
6
+ # SolveQ
7
+
8
+ Simple neural network that learns `y = 2x + 3`. Built with PyTorch.
9
+
10
+ ## What it does
11
+
12
+ Trains a small network to approximate a linear function. The model has one hidden layer and learns from synthetic data.
13
+
14
+ ## Setup
15
+
16
+ ```bash
17
+ pip install -r requirements.txt
18
+ ```
19
+
20
+ ## Running
21
+
22
+ Train the model:
23
+
24
+ ```bash
25
+ python src/train.py
26
+ ```
27
+
28
+ This generates 200 samples, trains for 1000 epochs, shows the loss plot, and saves to `models/model.pt`.
29
+
30
+ ![Training Loss](models/loss.png)
31
+
32
+ Make predictions:
33
+
34
+ ```bash
35
+ python src/predict.py
36
+ ```
37
+
38
+ Predicts `x = 4.0` by default. To test other values, edit the `predict()` call in `predict.py`.
39
+
40
+ ## Model
41
+
42
+ - Input: 1 neuron
43
+ - Hidden: 16 neurons (ReLU)
44
+ - Output: 1 neuron
45
+
46
+ Uses Adam optimizer (lr=0.01) and MSE loss.