Skip to content

Commit a42c5d3

Browse files
authored
Reorganize README
1 parent 1f27163 commit a42c5d3

1 file changed

Lines changed: 25 additions & 19 deletions

File tree

README.md

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
*A neural network model to predict arithmetic operation results.*
44

55

6-
[![GitHub License](https://img.shields.io/github/license/StompZone/MathModel)](LICENSE) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/StompZone/MathModel) ![Static Badge](https://img.shields.io/badge/python-%E2%89%A5%203.12-%2344aa33?style=flat&logo=python&logoColor=%23ffdd00) [![Run Tests](https://github.com/StompZone/MathModel/actions/workflows/test.yml/badge.svg)](https://github.com/StompZone/MathModel/actions/workflows/test.yml) [![Discord](https://img.shields.io/discord/599808270655291403?logo=discord&logoColor=%20%235865F2&label=StompZone%20Discord)](https://discord.stomp.zone)
6+
[![GitHub License](https://img.shields.io/github/license/StompZone/MathModel)](LICENSE) [![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/StompZone/MathModel)](https://github.com/StompZone/MathModel/archive/refs/heads/master.zip) [![Static Badge](https://img.shields.io/badge/python-%E2%89%A5%203.12-%2344aa33?style=flat&logo=python&logoColor=%23ffdd00)](https://github.com/StompZone/MathModel/blob/master/pyproject.toml) [![GitHub commit activity](https://img.shields.io/github/commit-activity/t/stompzone/mathmodel?logo=github&logoColor=%23ccc)](https://github.com/StompZone/MathModel/commits/master/)
7+
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/stompzone/mathmodel/test.yml?logo=github&logoColor=%23ccc&label=tests)](https://stompzone.github.io/MathModel/)
8+
[![Build Status](https://img.shields.io/github/actions/workflow/status/stompzone/mathmodel/test.yml?style=flat&logo=github)](https://stompzone.github.io/MathModel/)
79

810
## Overview
911

@@ -23,6 +25,22 @@ poetry install
2325
poetry install --with dev
2426
```
2527

28+
## Usage
29+
30+
### Train the Model
31+
32+
```bash
33+
poetry run python math_model.py
34+
```
35+
36+
### Outputs
37+
38+
After training, the following files are created:
39+
40+
- `trained_math_model.keras` — Trained neural network model.
41+
- `max_input_value.npy` — Scaling factor used for input normalization.
42+
43+
2644
### Testing
2745

2846
You can run tests locally using:
@@ -39,31 +57,19 @@ poetry run python run_tests.py --coverage --html
3957

4058
This project uses GitHub Actions to run tests on every push to the main branch and on pull requests.
4159

60+
<a href="https://stompzone.github.io/MathModel/"><img src="https://img.shields.io/github/actions/workflow/status/stompzone/mathmodel/test.yml?logo=github&logoColor=%23ccc&label=tests&style=for-the-badge" height=25></img></a>
61+
4262
### Test Reports
4363

4464
Test reports are automatically generated and published to GitHub Pages after successful runs on the main branch.
4565

46-
You can view the latest test report at:
47-
`https://{username}.github.io/{repository-name}/`
48-
49-
## Usage
50-
51-
### Train the Model
52-
53-
```bash
54-
poetry run python math_model.py
55-
```
56-
57-
### Outputs
58-
59-
After training, the following files are created:
60-
61-
- `trained_math_model.keras` — Trained neural network model.
62-
- `max_input_value.npy` — Scaling factor used for input normalization.
66+
<a href="https://stompzone.github.io/MathModel/"><img src="https://img.shields.io/github/actions/workflow/status/stompzone/mathmodel/test.yml?logo=github&style=for-the-badge&logoColor=%23ccc" height=25></img></a>
6367

6468
## Author
6569

66-
DJ Stomp ([GitHub](https://github.com/DJStompZone))
70+
<h4>DJStomp <span><a href="https://github.com/DJStompZone"><img src="https://i.imgur.com/EtL4g49.png" height=16/></a></span></h3>
71+
72+
<a href="https://discord.stomp.zone/"><img src="https://img.shields.io/discord/599808270655291403?logo=discord&logoColor=%20%235865F2&label=Discord&style=for-the-badge" height=25></img></a>
6773

6874
## License
6975

0 commit comments

Comments
 (0)