Skip to content

Commit 0ef4977

Browse files
authored
docs: add detailed README with installation instructions
1 parent bc45f70 commit 0ef4977

File tree

1 file changed

+70
-1
lines changed

1 file changed

+70
-1
lines changed

README.md

Lines changed: 70 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,71 @@
11
# PySymBench
2-
Infrastructure for models comparison and evalustion
2+
Infrastructure for **model comparison and evaluation in symbolic execution workflows**.
3+
4+
This project is a **local web application** designed to compare symbolic execution results of an uploaded trained model (in `.onnx` format) on a selected dataset with a **baseline symbolic execution approach (non-AI)**.
5+
6+
The system uses **PySymGym tools** to run symbolic execution on the dataset and evaluate the results. After execution completes, the results are sent to the **email address you provide**.
7+
8+
# Installation
9+
10+
The repository contains **both frontend and backend components**, and **both must be launched** for the application to work.
11+
12+
---
13+
14+
## Email Communication (Gmail)
15+
16+
To enable email delivery of results, create a `.env` file containing your Gmail credentials:
17+
18+
```
19+
EMAIL=your_email@gmail.com
20+
APP_PASSWORD=your_app_password
21+
```
22+
23+
`EMAIL` — your Gmail address
24+
`APP_PASSWORD` — your Gmail **App Password** (not your regular account password)
25+
26+
---
27+
28+
## Backend Setup
29+
30+
1. Install **Python 3.14** and **Docker**, then install the project dependencies:
31+
32+
```
33+
pip install -r requirements.txt
34+
```
35+
36+
2. Run the application setup script (this builds a Docker container with the **PySymGym repository** and downloads the required dataset):
37+
38+
```
39+
python -m backend.launch_service.app_setup
40+
```
41+
42+
3. Start the **Celery broker (Redis)**:
43+
44+
```
45+
docker run --name redis-for-celery -p 6379:6379 -d redis
46+
```
47+
48+
4. Start the **Celery worker** and the **application server**:
49+
50+
```
51+
celery -A backend.utils.task worker --loglevel=info && uvicorn backend.main:app
52+
```
53+
54+
---
55+
56+
## Frontend Setup
57+
58+
1. Install **Node.js** with **npm**.
59+
60+
2. Install frontend dependencies:
61+
62+
```
63+
cd frontend
64+
npm install
65+
```
66+
67+
3. Start the frontend development server:
68+
69+
```
70+
npm run build
71+
```

0 commit comments

Comments
 (0)