Skip to content

Commit d5fad78

Browse files
committed
fix: restore HF Space config in README
1 parent b71cf27 commit d5fad78

23 files changed

Lines changed: 11 additions & 77 deletions

README.md

Lines changed: 11 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,15 @@
1-
# 🏴‍☠️ Oasis Security – Crime Predictor
2-
3-
[![CI/CD](https://github.com/Data-Science-Designer-and-Developer/oasis-security/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/Data-Science-Designer-and-Developer/oasis-security/actions)
4-
[![Docker](https://img.shields.io/badge/Docker-GHCR-blue)](https://ghcr.io/Data-Science-Designer-and-Developer)
5-
[![Model](https://img.shields.io/badge/R²-0.806-brightgreen)](https://github.com/Data-Science-Designer-and-Developer/oasis-security/blob/main/models/crime_predictor/models/crime_predictor.pkl)
6-
7-
A predictive model for crime rates in France (per 100,000 inhabitants), fully structured for production use.
8-
This repository demonstrates a **ML project with clear structure, documentation, modeling pipeline, and deployment readiness**.
9-
---
10-
11-
## 🚀 Project Objectives
12-
13-
- Build a reliable predictive model using official French crime data (from data.gouv.fr).
14-
- Establish a **clean, reproducible MLOps pipeline**:
15-
- Clear folder structure (`data/`, `notebooks/`, `models/`, etc.)
16-
- Serialized model for reuse
17-
- Training & inference scripts
18-
- Integrated CI/CD workflows
19-
201
---
21-
22-
## 📁 Repository Structure
23-
24-
oasis-security/
25-
├── .github/ # GitHub workflows (CI/CD)
26-
├── data/ # Processed data files
27-
├── docs/ # Documentation & dashboards
28-
├── images/ # Visual assets & plots
29-
├── models/
30-
│ └── crime_predictor/
31-
│ ├── src/ # Source code for model
32-
│ ├── models/ # Serialized model (.pkl)
33-
│ ├── mlruns/ # MLflow tracking data
34-
│ ├── tests/ # Unit tests (optional)
35-
│ └── requirements.txt # Dependencies for this model
36-
├── notebooks/ # Exploration & analysis notebooks
37-
├── pipeline/ # Scripts for automation
38-
├── Dockerfile # Docker configuration
39-
├── LICENSE # License
40-
└── README.md # Project overview
41-
42-
2+
title: Oasis Security
3+
emoji: 🚨
4+
colorFrom: red
5+
colorTo: blue
6+
sdk: streamlit
7+
sdk_version: "1.41.0"
8+
python_version: "3.10"
9+
app_file: files/Delinquance.py
10+
pinned: false
4311
---
4412

45-
## 📊 Usage
46-
47-
1. Create & activate a virtual environment:
48-
python3 -m venv .venv
49-
source .venv/bin/activate
50-
51-
52-
2. Install dependencies:
53-
pip install -r models/crime_predictor/requirements.txt
54-
55-
3. Run training:
56-
python models/crime_predictor/src/train.py
57-
58-
4. Start prediction API:
59-
python models/crime_predictor/src/predict.py
60-
61-
62-
📝 Contribution & CI/CD
63-
64-
This project is designed to be production ready with GitHub Actions workflows (tests & model builds).
65-
Contributions welcome 🌟
66-
67-
🛠️ Tech Stack
68-
69-
Core: Python 3.13, scikit-learn, joblib
70-
Future: FastAPI, MLflow, Docker, GitHub Actions
71-
Data: data.gouv.fr (police/gendarmerie 2016-2025)
72-
73-
📜 License
74-
75-
MIT License
76-
77-
📝 Author
13+
# Oasis Security — Crime & Delinquency in France
7814

79-
Frédéric Tellier – Data Scientist
80-
LinkedIn : https://www.linkedin.com/in/fr%C3%A9d%C3%A9ric-tellier-8a9170283/
81-
| Portfolio : https://github.com/Dreipfelt/
15+
Analysis of crime and delinquency data from Police Nationale and Gendarmerie Nationale (2012-2021), with predictions up to 2030 using Prophet, XGBoost, and LightGBM.
250 KB
Binary file not shown.
Binary file not shown.

data/crimes-et-délits-PN-GN.xlsx

3.97 MB
Binary file not shown.

data/rapport_delinquance_2030.xlsx

7.04 KB
Binary file not shown.
250 KB
Binary file not shown.

images/alignement_sources.png

245 KB
Loading

images/benchmark_final.png

205 KB
Loading

images/classement_regions.png

221 KB
Loading

0 commit comments

Comments
 (0)