lucabadiali commited on
Commit
1c30651
Β·
1 Parent(s): 3674d9f

Edited Readme

Browse files
Files changed (1) hide show
  1. README.md +33 -30
README.md CHANGED
@@ -22,36 +22,39 @@ This is a small project that allows the user to fine tune or download a pretrain
22
  - βœ” CD pipeline deploying a Dockerized FastAPI app on HF Spaces
23
  - βœ” Continuous monitoring with Prometheus + Grafana
24
 
25
- ## Structure of the project folder:
26
-
27
- .github/
28
- └── workflows/
29
- β”œβ”€β”€ huggingface-space-deploy.yml
30
- └── python-app.yml
31
- data/
32
- └── load_data.py
33
- models/
34
- src/
35
- β”œβ”€β”€ app/
36
- β”œβ”€β”€ __pycache__/
37
- └── config.cpython-311.pyc
38
- β”œβ”€β”€ __init__.py
39
- β”œβ”€β”€ app_post.py
40
- β”œβ”€β”€ app.py
41
- β”œβ”€β”€ config.py
42
- └── utils.py
43
- └── train_model.py
44
- tests/
45
- └── test_app.py
46
- .dockerignore
47
- .gitignore
48
- docker-compose.yml
49
- Dockerfile
50
- env_config.sh
51
- prometheus.yml
52
- pytest.ini
53
- README.md
54
- requirements.txt
 
 
 
55
 
56
  ## Project Configuration
57
 
 
22
  - βœ” CD pipeline deploying a Dockerized FastAPI app on HF Spaces
23
  - βœ” Continuous monitoring with Prometheus + Grafana
24
 
25
+ ## Project Structure
26
+
27
+
28
+ .
29
+ β”œβ”€β”€ .github/
30
+ β”‚ └── workflows/
31
+ β”‚ β”œβ”€β”€ huggingface-space-deploy.yml
32
+ β”‚ └── python-app.yml
33
+ β”œβ”€β”€ data/
34
+ β”‚ └── load_data.py
35
+ β”œβ”€β”€ models/
36
+ β”œβ”€β”€ src/
37
+ β”‚ β”œβ”€β”€ app/
38
+ β”‚ β”‚ β”œβ”€β”€ __pycache__/
39
+ β”‚ β”‚ β”‚ └── config.cpython-311.pyc
40
+ β”‚ β”‚ β”œβ”€β”€ __init__.py
41
+ β”‚ β”‚ β”œβ”€β”€ app_post.py
42
+ β”‚ β”‚ β”œβ”€β”€ app.py
43
+ β”‚ β”‚ β”œβ”€β”€ config.py
44
+ β”‚ β”‚ └── utils.py
45
+ β”‚ └── train_model.py
46
+ β”œβ”€β”€ tests/
47
+ β”‚ └── test_app.py
48
+ β”œβ”€β”€ .dockerignore
49
+ β”œβ”€β”€ .gitignore
50
+ β”œβ”€β”€ docker-compose.yml
51
+ β”œβ”€β”€ Dockerfile
52
+ β”œβ”€β”€ env_config.sh
53
+ β”œβ”€β”€ prometheus.yml
54
+ β”œβ”€β”€ pytest.ini
55
+ β”œβ”€β”€ README.md
56
+ └── requirements.txt
57
+
58
 
59
  ## Project Configuration
60