trainedml 0.1.1__tar.gz

trainedml-0.1.1/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2025] [diamankayero]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

trainedml-0.1.1/MANIFEST.in

@@ -0,0 +1,12 @@
+include README.md
+include LICENCE
+include requirements.txt
+recursive-include src *.py
+recursive-include tests *.py
+recursive-include doc/source *.rst *.py *.css
+global-exclude *.pyc
+global-exclude __pycache__
+prune build
+prune dist
+prune doc/build
+prune venv

trainedml-0.1.1/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: trainedml
+Version: 0.1.1
+Summary: Simple ML training framework
+Author-email: diamankayero <diamanka.tck@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/diamankayero/trainedml
+Project-URL: Issues, https://github.com/diamankayero/trainedml
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENCE
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: scikit-learn
+Requires-Dist: matplotlib
+Requires-Dist: seaborn
+Requires-Dist: plotly
+Requires-Dist: tqdm
+Requires-Dist: requests
+Requires-Dist: pooch
+Requires-Dist: statsmodels
+Requires-Dist: joblib
+Requires-Dist: scipy
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: streamlit; extra == "dev"
+Provides-Extra: doc
+Requires-Dist: sphinx; extra == "doc"
+Requires-Dist: sphinx_rtd_theme; extra == "doc"
+Dynamic: license-file
+
+# trainedml
+
+`trainedml` est un package Python qui fournit des outils simples pour **charger des jeux de données publics**, **entraîner et comparer des modèles de machine learning**, et **visualiser les résultats** de manière intuitive.
+
+---
+
+## 📦 Installation
+
+### 🔹 Installation depuis **TestPyPI** (recommandé pour les tests)
+
+```bash
+python -m pip install --index-url https://test.pypi.org/simple/ trainedml --upgrade
+# oubien
+pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple trainedml
+```
+
+> ⚠️ L’option `--no-deps` est nécessaire car TestPyPI ne contient pas toujours toutes les dépendances.
+
+Si besoin, installe ensuite les dépendances séparément :
+
+```bash
+pip install -r requirements.txt
+```
+
+---
+
+### 🔹 Installation classique (depuis les sources)
+
+```bash
+git clone https://github.com/diamankayero/trainedml.git
+cd trainedml
+pip install -r requirements.txt
+```
+
+---
+
+## 🚀 Fonctionnalités principales
+
+* Chargement de jeux de données publics (ex : **Iris**)
+* Modèles implémentés :
+
+  * KNN (classification et régression)
+  * Régression logistique
+  * Random Forest (classification et régression)
+  * Régression linéaire, Ridge, Lasso
+* Visualisations :
+
+  * Heatmap
+  * Histogrammes
+  * Courbes
+  * Boxplots, bivarié, valeurs manquantes, outliers, normalité, multicolinéarité, profiling
+* API simple pour :
+* Exemples avancés :
+
+  * Benchmark de modèles de régression
+  * Analyse exploratoire complète (profiling, multicolinéarité, normalité)
+  * Visualisation de la distribution de la cible (régression)
+
+  * l’entraînement
+  * l’évaluation
+  * la comparaison de modèles
+
+---
+
+## 🧪 Exemple d’utilisation
+
+```python
+from trainedml.data.loader import DataLoader
+from trainedml.models.knn import KNNModel
+from trainedml.visualization import Visualizer
+
+# Chargement des données
+iris = DataLoader().load_iris()
+
+# Entraînement d'un modèle
+X = iris.drop(columns=['species'])
+y = iris['species']
+
+model = KNNModel()
+model.fit(X, y)
+
+# Visualisation
+viz = Visualizer(iris)
+fig = viz.heatmap()
+fig.show()
+```
+
+---
+
+## ✅ Tests
+
+Pour exécuter les tests unitaires :
+
+```bash
+python -m unittest discover tests
+```
+
+---
+
+## 🆕 Nouveauté 2026
+
+- Ajout du workflow GitHub Actions pour tests automatiques et publication sur TestPyPI.
+- Amélioration de la documentation et de la structure du projet.
+
+---
+
+## 📌 Statut du projet
+
+* ✔️ Version de test publiée sur **TestPyPI**
+* 🔄 En développement actif
+* 🚀 Publication sur PyPI prévue après validation
+# trainedml_module

trainedml-0.1.1/README.md

@@ -0,0 +1,112 @@
+# trainedml
+
+`trainedml` est un package Python qui fournit des outils simples pour **charger des jeux de données publics**, **entraîner et comparer des modèles de machine learning**, et **visualiser les résultats** de manière intuitive.
+
+---
+
+## 📦 Installation
+
+### 🔹 Installation depuis **TestPyPI** (recommandé pour les tests)
+
+```bash
+python -m pip install --index-url https://test.pypi.org/simple/ trainedml --upgrade
+# oubien
+pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple trainedml
+```
+
+> ⚠️ L’option `--no-deps` est nécessaire car TestPyPI ne contient pas toujours toutes les dépendances.
+
+Si besoin, installe ensuite les dépendances séparément :
+
+```bash
+pip install -r requirements.txt
+```
+
+---
+
+### 🔹 Installation classique (depuis les sources)
+
+```bash
+git clone https://github.com/diamankayero/trainedml.git
+cd trainedml
+pip install -r requirements.txt
+```
+
+---
+
+## 🚀 Fonctionnalités principales
+
+* Chargement de jeux de données publics (ex : **Iris**)
+* Modèles implémentés :
+
+  * KNN (classification et régression)
+  * Régression logistique
+  * Random Forest (classification et régression)
+  * Régression linéaire, Ridge, Lasso
+* Visualisations :
+
+  * Heatmap
+  * Histogrammes
+  * Courbes
+  * Boxplots, bivarié, valeurs manquantes, outliers, normalité, multicolinéarité, profiling
+* API simple pour :
+* Exemples avancés :
+
+  * Benchmark de modèles de régression
+  * Analyse exploratoire complète (profiling, multicolinéarité, normalité)
+  * Visualisation de la distribution de la cible (régression)
+
+  * l’entraînement
+  * l’évaluation
+  * la comparaison de modèles
+
+---
+
+## 🧪 Exemple d’utilisation
+
+```python
+from trainedml.data.loader import DataLoader
+from trainedml.models.knn import KNNModel
+from trainedml.visualization import Visualizer
+
+# Chargement des données
+iris = DataLoader().load_iris()
+
+# Entraînement d'un modèle
+X = iris.drop(columns=['species'])
+y = iris['species']
+
+model = KNNModel()
+model.fit(X, y)
+
+# Visualisation
+viz = Visualizer(iris)
+fig = viz.heatmap()
+fig.show()
+```
+
+---
+
+## ✅ Tests
+
+Pour exécuter les tests unitaires :
+
+```bash
+python -m unittest discover tests
+```
+
+---
+
+## 🆕 Nouveauté 2026
+
+- Ajout du workflow GitHub Actions pour tests automatiques et publication sur TestPyPI.
+- Amélioration de la documentation et de la structure du projet.
+
+---
+
+## 📌 Statut du projet
+
+* ✔️ Version de test publiée sur **TestPyPI**
+* 🔄 En développement actif
+* 🚀 Publication sur PyPI prévue après validation
+# trainedml_module

trainedml-0.1.1/doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

trainedml-0.1.1/doc/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

trainedml-0.1.1/doc/source/_static/basic.css

@@ -0,0 +1,3 @@
+a.api-link {
+    color: #d32f2f !important; /* rouge vif */
+}

trainedml-0.1.1/doc/source/conf.py

@@ -0,0 +1,40 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'trainedml'
+copyright = '2025, Yéro Diamanka'
+author = 'Yéro Diamanka'
+release = '0.01'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+	'sphinx.ext.autodoc',
+	'sphinx.ext.napoleon',
+]
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../../src'))
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+language = 'fr'
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+
+# -- Extension configuration ------------------------------------------------
+extensions += [
+    'sphinx.ext.viewcode',
+    'sphinx.ext.autosectionlabel',
+]

trainedml-0.1.1/doc/source/index.rst

@@ -0,0 +1,100 @@
+.. trainedml documentation master file, created by
+   sphinx-quickstart on Mon Dec 22 02:19:59 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+trainedml
+=========
+
+.. image:: https://img.shields.io/badge/python-3.8+-blue.svg
+   :target: https://www.python.org/
+   :alt: Python Version
+
+**trainedml** est une bibliothèque Python modulaire pour l'apprentissage automatique supervisé, conçue pour l'enseignement, la recherche et le prototypage rapide.
+
+- Chargement flexible de jeux de données publics ou personnalisés
+- Modèles classiques (Random Forest, KNN, Régression Logistique)
+- Visualisations intégrées (heatmap, histogramme, courbe)
+- API simple pour l'intégration web/applications
+- Documentation API complète et tests unitaires
+
+.. contents:: Sommaire
+   :depth: 2
+   :local:
+
+Guide de démarrage rapide
+=========================
+
+.. code-block:: python
+
+   from trainedml import Trainer
+   trainer = Trainer(dataset="iris", model="random_forest")
+   trainer.fit()
+   print(trainer.evaluate())
+   y_pred = trainer.predict([[5.1, 3.5, 1.4, 0.2]])
+
+Installation
+============
+
+.. code-block:: bash
+
+   pip install -r requirements.txt
+   pip install .
+
+Utilisation en ligne de commande
+================================
+
+.. code-block:: bash
+
+   python -m trainedml --dataset iris --model random_forest --show
+
+
+Sections de la documentation
+============================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: API
+
+   modules
+
+
+Explications mathématiques des méthodes
+=======================================
+
+
+.. rubric:: Explications mathématiques des méthodes
+
+
+.. note::
+   Les explications mathématiques détaillées pour chaque méthode sont disponibles dans la section API détaillée :
+
+   - :doc:`k-Nearest Neighbors (kNN) <trainedml/models/knn>`
+   - :doc:`Régression Logistique <trainedml/models/logistic>`
+   - :doc:`Random Forest <trainedml/models/random_forest>`
+
+   (voir aussi "modules" dans le menu de gauche)
+
+.. Les blocs mathématiques sont désormais déplacés dans les pages dédiées de l'API.
+
+
+FAQ
+---
+
+**Q : Comment ajouter un nouveau dataset ?**
+
+R : Utilisez la classe DataLoader avec l'URL de votre CSV et le nom de la colonne cible.
+
+**Q : Puis-je utiliser mes propres modèles ?**
+
+R : Oui, il suffit d'implémenter la classe BaseModel et de l'ajouter à MODEL_MAP.
+
+Contribuer
+----------
+
+Les contributions sont les bienvenues ! Merci de soumettre vos issues et pull requests sur GitHub.
+
+Licence
+-------
+
+Ce projet est distribué sous licence MIT.

trainedml-0.1.1/doc/source/modules.rst

@@ -0,0 +1,27 @@
+trainedml - API détaillée
+=========================
+
+.. toctree::
+   :maxdepth: 1
+
+   trainedml/models/knn
+   trainedml/models/logistic
+   trainedml/models/random_forest
+   trainedml/visualization
+   trainedml/analyzer
+   trainedml/vizs
+   trainedml/heatmap
+   trainedml/histogram
+   trainedml/line
+   trainedml/distribution
+   trainedml/correlation
+   trainedml/missing
+   trainedml/outliers
+   trainedml/target
+   trainedml/boxplot
+   trainedml/bivariate
+   trainedml/normality
+   trainedml/multicollinearity
+   trainedml/profiling
+
+# Les automodule détaillés sont retirés pour éviter les doublons

trainedml-0.1.1/doc/source/trainedml/analyzer.rst

@@ -0,0 +1,7 @@
+DataAnalyzer
+============
+
+.. automodule:: trainedml.analyzer
+   :members:
+   :undoc-members:
+   :show-inheritance:

trainedml-0.1.1/doc/source/trainedml/bivariate.rst

@@ -0,0 +1,7 @@
+Bivariate
+=========
+
+.. automodule:: trainedml.viz.bivariate
+   :members:
+   :undoc-members:
+   :show-inheritance:

trainedml-0.1.1/doc/source/trainedml/boxplot.rst

@@ -0,0 +1,7 @@
+Boxplot
+=======
+
+.. automodule:: trainedml.viz.boxplot
+   :members:
+   :undoc-members:
+   :show-inheritance:

trainedml-0.1.1/doc/source/trainedml/correlation.rst

@@ -0,0 +1,7 @@
+Correlation
+===========
+
+.. automodule:: trainedml.viz.correlation
+   :members:
+   :undoc-members:
+   :show-inheritance:

trainedml-0.1.1/doc/source/trainedml/distribution.rst

@@ -0,0 +1,7 @@
+Distribution
+============
+
+.. automodule:: trainedml.viz.distribution
+   :members:
+   :undoc-members:
+   :show-inheritance:

trainedml-0.1.1/doc/source/trainedml/heatmap.rst

@@ -0,0 +1,7 @@
+Heatmap
+=======
+
+.. automodule:: trainedml.viz.heatmap
+   :members:
+   :undoc-members:
+   :show-inheritance:

trainedml-0.1.1/doc/source/trainedml/histogram.rst

@@ -0,0 +1,7 @@
+Histogram
+=========
+
+.. automodule:: trainedml.viz.histogram
+   :members:
+   :undoc-members:
+   :show-inheritance:

trainedml-0.1.1/doc/source/trainedml/line.rst

@@ -0,0 +1,7 @@
+Line
+====
+
+.. automodule:: trainedml.viz.line
+   :members:
+   :undoc-members:
+   :show-inheritance:

trainedml-0.1.1/doc/source/trainedml/missing.rst

@@ -0,0 +1,7 @@
+Missing Values
+==============
+
+.. automodule:: trainedml.viz.missing
+   :members:
+   :undoc-members:
+   :show-inheritance:

trainedml-0.1.1/doc/source/trainedml/models/knn.rst

@@ -0,0 +1,44 @@
+k-Nearest Neighbors (kNN)
+=========================
+
+.. currentmodule:: trainedml.models.knn
+
+Principe (kNN)
+--------------
+
+Le kNN est un algorithme de classification supervisée basé sur la proximité des exemples dans l’espace des caractéristiques. Pour une observation :math:`x`, on recherche les :math:`k` voisins les plus proches selon une distance (souvent euclidienne) :
+
+.. math::
+   d(x, x_i) = \sqrt{\sum_{j=1}^p (x_j - x_{i,j})^2}
+
+La classe prédite est la plus fréquente parmi les :math:`k` voisins :
+
+.. math::
+   \hat{y} = \operatorname{mode}\left(\{y_i\}_{i \in V_k(x)}\right)
+
+.. math::
+
+   V_k(x)\ \text{ est l’ensemble des } k \text{ plus proches voisins de } x.
+
+**Avantages** : simple, non paramétrique, efficace pour les petits jeux de données.
+
+**Limites** : sensible à l’échelle des variables, coûteux pour de grands jeux de données.
+
+Illustration (kNN)
+------------------
+
+.. image:: ../../_static/figures/knn.png
+   :alt: Schéma kNN
+   :width: 400px
+   :align: center
+
+Exemple illustré (kNN)
+----------------------
+
+Supposons un jeu de données avec trois points :math:`A=(1,2)`, :math:`B=(2,3)`, :math:`C=(4,2)` et une nouvelle observation :math:`X=(2,2)`. Pour :math:`k=2`, les deux plus proches voisins de :math:`X` sont :math:`A` et :math:`B`. Si :math:`A` est de classe 0 et :math:`B` de classe 1, la classe prédite sera la plus fréquente parmi ces deux voisins.
+
+Pour aller plus loin (kNN)
+--------------------------
+
+- Documentation scikit-learn : https://scikit-learn.org/stable/modules/neighbors.html
+- Cours OpenClassrooms : https://openclassrooms.com/fr/courses/4425111-initiez-vous-au-machine-learning/5028281-classifiez-avec-les-k-plus-proches-voisins-knn