Merge branch 'main' of https://github.com/Data-Science-Designer-and-Developer/oasis-security

Author: Dreipfelt

README.md

@@ -1,221 +1,11 @@
-<<<<<<< HEAD
-**🏴‍☠️ Oasis Security – Crime Predictor
-
-Modèle de prédiction de la délinquance en France (taux pour 100 000 habitants) intégré dans l’écosystème Oasis Security.
-L’objectif est de fournir un pipeline complet et industrialisable : de l’exploration à la mise en production (modèle sérialisé, API, CI/CD, MLflow).
-1. Objectifs du projet
-
-    Construire un modèle de prévision des taux de délinquance (par indicateur) à partir des données publiques de la police et de la gendarmerie (data.gouv.fr).
-
-    Fournir une implémentation production-ready :
-
-        Structure de projet claire (src/, models/, mlruns/, tests/).
-
-        Modèle sérialisé (crime_predictor.pkl) et facilement re-chargeable.
-
-        Scripts d’entraînement, d’inférence et de génération de rapports.
-
-    S’intégrer proprement dans un dépôt Oasis Security (vision sécurité & monitoring), avec une base solide pour un déploiement via Docker / GitHub Actions / MLflow.
-
-2. Structure du dépôt
-
-Structure simplifiée pour la partie modèle :
-
-bash
-oasis-security-complete/
-├── models/
-│   └── crime_predictor/
-│       ├── src/
-│       │   ├── model.py             # Classe CrimeRatePredictor (LinearRegression picklable)
-│       │   ├── generate_model.py    # Script de génération du premier modèle .pkl
-│       │   ├── train.py             # (prévu) pipeline d'entraînement complet + MLflow
-│       │   ├── predict.py           # (prévu) API FastAPI pour l’inférence
-│       │   └── config.yaml          # (prévu) hyperparamètres & config data
-│       ├── models/
-│       │   └── crime_predictor.pkl  # Modèle sérialisé (R² ~ 0.80 sur données simulées)
-│       ├── mlruns/                  # Répertoire MLflow (tracking local)
-│       ├── tests/                   # Tests unitaires (à compléter)
-│       └── requirements.txt         # Dépendances Python pour ce module
-├── docs/
-│   └── crime_predictor/             # (prévu) dashboard / documentation front
-└── .github/
-    └── workflows/                   # (prévu) CI/CD pour tests + build modèle/API
-
-3. Données & Modélisation
-3.1 Source de données
-
-    Données issues de data.gouv.fr : base statistique de la délinquance enregistrée par la police et la gendarmerie (niveau régional / communal, par indicateur, par année).
-
-    Exemples de variables disponibles :
-
-        annee, Code_region, indicateur, nombre, insee_pop, …
-
-        Calcul du taux pour 100 000 habitants = nombre/insee_pop∗100000nombre/insee_pop∗100000.
-
-    Remarque : pour la première version de crime_predictor.pkl, un jeu de données simulé est utilisé pour garantir un modèle picklable et stable (LinearRegression), en attendant le branchement final sur la vraie source data.gouv.
-
-3.2 Modèle actuel
-
-Dans models/crime_predictor/src/model.py :
-
-    Classe centrale : CrimeRatePredictor
-
-    Modèle : LinearRegression (scikit-learn) pour garantir :
-
-        sérialisation simple via joblib,
-
-        robustesse sur différentes versions de Python,
-
-        compatibilité avec une future montée en complexité (XGBoost/LightGBM, Prophet, etc.).
-
-Fonctionnalités clés :
-
-    train(data_url: str) -> dict
-    Entraîne le modèle sur des features simulées (actuellement) et renvoie des métriques (R²).
-
-    save(path: str)
-    Sérialise le modèle + méta-données (noms de variables, flag is_trained) dans un .pkl.
-
-Ce design te permet ensuite de remplacer très facilement le bloc de génération de données par un vrai pipeline EDA + feature engineering basé sur ton notebook d’analyses.
-4. Installation & utilisation
-4.1 Prérequis
-
-    Python 3.13 (ou 3.11+) dans un environnement virtuel (.venv).
-
-    pip à jour.
-
-4.2 Installation des dépendances
-
-Depuis la racine du projet oasis-security-complete :
-
-bash
-cd models/crime_predictor
-pip install -r requirements.txt
-
-Le fichier requirements.txt contient notamment :
-
-    pandas
-
-    numpy
-
-    scikit-learn
-
-    joblib
-
-    (et, pour les futures étapes) fastapi, uvicorn, mlflow, pyyaml, etc.
-
-4.3 Générer (ou régénérer) le modèle
-
-Depuis models/crime_predictor/src :
-
-bash
-cd models/crime_predictor/src
-python generate_model.py
-
-Ce script :
-
-    instancie CrimeRatePredictor,
-
-    entraîne un modèle LinearRegression sur des données simulées,
-
-    sérialise le modèle dans :
-
-bash
-models/crime_predictor/models/crime_predictor.pkl
-
-4.4 Charger le modèle dans un autre script
-
-Exemple minimal :
-
-python
-from pathlib import Path
-import joblib
-import numpy as np
-
-# Charger le modèle
-model_path = Path(__file__).resolve().parents[1] / "models" / "crime_predictor.pkl"
-data = joblib.load(model_path)
-
-regressor = data["model"]
-feature_names = data["features"]
-
-# Exemple de prédiction
-X_sample = np.random.randn(1, len(feature_names))
-y_pred = regressor.predict(X_sample)
-
-print("Features:", feature_names)
-print("Prediction:", y_pred[0])
-
-Ce pattern est compatible avec :
-
-    une API FastAPI (predict.py),
-
-    un batch scoring,
-
-    ou une intégration dans un pipeline plus large (Oasis, Streamlit, etc.).
-
-=======
->>>>>>> 7cca8880 (Update README.md and project files, add new datasets and notebooks)
 # 🏴‍☠️ Oasis Security – Crime Predictor
 
 [![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)
 [![Docker](https://img.shields.io/badge/Docker-GHCR-blue)](https://ghcr.io/Data-Science-Designer-and-Developer)
 [![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)
 
-**Production ML pipeline** forecasting French crime rates (per 100k) using data.gouv.fr police data.
-
-## 🚀 Quick Start
-
-```bash
-pip install -r models/crime_predictor/requirements.txt
-cd models/crime_predictor/src && python generate_model.py
-
-Predict:
-
-python
-import joblib
-model = joblib.load("../../models/crime_predictor.pkl")["model"]
-print(model.predict([[0.1,0.2,250,5]]))  # ~287/100k
-
-📁 Structure
-
-text
-models/crime_predictor/
-├── src/        # model.py, generate_model.py
-├── models/     # crime_predictor.pkl (R²=0.806)
-├── mlruns/     # MLflow tracking
-├── tests/      # pytest ready
-└── requirements.txt
-
-📊 Model
-
-Data: data.gouv.fr (police stats 2016-2025)
-Features: year_sin, region_mean, ind_code
-R²: 0.806 (production stable)
-🔮 2030 Forecasts
-Region	Crime	Rate/100k
-IDF(11)	VIOLENCES	387 🚨
-Paris	CAMBRIOLE	245 ⚠️
-
-<<<<<<< HEAD
-## 🚀 **Copie-colle → push → portfolio parfait**
-
-```bash
-cd oasis-security-complete/
-cat > README.md << 'EOF'
-[Coller le markdown ci-dessus]
-EOF
-git add README.md
-git commit -m "📖 README pro senior DS"
-git push origin master
-**# Oasis Security – Crime Rate Predictor
-
-[![Python](https://img.shields.io/badge/Python-3.11-blue?logo=python)](https://www.python.org/)
-[![License: MIT](https://img.shields.io/badge/License-MIT-green)](LICENSE)
-
 A predictive model for crime rates in France (per 100,000 inhabitants), fully structured for production use.  
 This repository demonstrates a **ML project with clear structure, documentation, modeling pipeline, and deployment readiness**.
-
 ---
 
 ## 🚀 Project Objectives
@@ -231,79 +21,61 @@ This repository demonstrates a **ML project with clear structure, documentation,
 
 ## 📁 Repository Structure
 
-oasis-security/
-├── .github/ # GitHub workflows (CI/CD)
-├── data/ # Processed data files
-├── docs/ # Documentation & dashboards
-├── images/ # Visual assets & plots
-├── models/
-│ └── crime_predictor/
-│ ├── src/ # Source code for model
-│ ├── models/ # Serialized model (.pkl)
-│ ├── mlruns/ # MLflow tracking data
-│ ├── tests/ # Unit tests (optional)
-│ └── requirements.txt # Dependencies for this model
-├── notebooks/ # Exploration & analysis notebooks
-├── pipeline/ # Scripts for automation
-├── Dockerfile # Docker configuration
-├── LICENSE # License
-└── README.md # Project overview
+oasis-security/  
+├── .github/ # GitHub workflows (CI/CD)  
+├── data/ # Processed data files  
+├── docs/ # Documentation & dashboards  
+├── images/ # Visual assets & plots  
+├── models/  
+│ └── crime_predictor/  
+│ ├── src/ # Source code for model  
+│ ├── models/ # Serialized model (.pkl)  
+│ ├── mlruns/ # MLflow tracking data  
+│ ├── tests/ # Unit tests (optional)  
+│ └── requirements.txt # Dependencies for this model  
+├── notebooks/ # Exploration & analysis notebooks  
+├── pipeline/ # Scripts for automation  
+├── Dockerfile # Docker configuration  
+├── LICENSE # License  
+└── README.md # Project overview  
 
 
 ---
 
 ## 📊 Usage
 
 1. Create & activate a virtual environment:
-```bash
 python3 -m venv .venv
 source .venv/bin/activate
 
+
 2. Install dependencies:
-'''bash 
 pip install -r models/crime_predictor/requirements.txt
 
 3. Run training: 
-'''bash
 python models/crime_predictor/src/train.py
 
 4. Start prediction API:
 python models/crime_predictor/src/predict.py
 
+
 📝 Contribution & CI/CD
 
 This project is designed to be production ready with GitHub Actions workflows (tests & model builds).
 Contributions welcome 🌟
 
-📜 License
-
-MIT License
-
-
----
-
-### 3️⃣ Commit and push the changes
-
-Après avoir modifié `README.md` avec le contenu ci‑dessus, exécute dans le terminal :
-
-```bash
-git add README.md
-git commit -m "Update README to clear English structure"
-git push
-
 🛠️ Tech Stack
 
 Core: Python 3.13, scikit-learn, joblib
 Future: FastAPI, MLflow, Docker, GitHub Actions
 Data: data.gouv.fr (police/gendarmerie 2016-2025)
 
+📜 License
+
+MIT License
+
 📝 Author
 
 Frédéric Tellier – Data Scientist
-LinkedIn : https://www.linkedin.com/in/fr%C3%A9d%C3%A9ric-tellier-8a9170283/ | Portfolio : https://github.com/Dreipfelt/
-
-Licence: MIT
-=======
-Author: Frédéric Tellier – Data Scientist
-License: MIT
->>>>>>> 7cca8880 (Update README.md and project files, add new datasets and notebooks)
+LinkedIn : https://www.linkedin.com/in/fr%C3%A9d%C3%A9ric-tellier-8a9170283/   
+| Portfolio : https://github.com/Dreipfelt/