lecrapaud 0.1.0__tar.gz → 0.2.0__tar.gz

{lecrapaud-0.1.0 → lecrapaud-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: lecrapaud
-Version: 0.1.0
+Version: 0.2.0
 Summary: Framework for machine and deep learning, with regression, classification and time series analysis
 License: Apache License
 Author: Pierre H. Gallet
@@ -47,13 +47,30 @@ Requires-Dist: yahoo-fin (>=0.8.9.1)
 Requires-Dist: yfinance (>=0.2.55)
 Description-Content-Type: text/markdown
 
-# Stock
+<div align="center">
 
-## Overview
+# 🐸
 
-## Project description
+## Welcome to LeCrapaud
 
-## Quick Start
+**An all-in-one machine learning framework**
+
+</div>
+
+## 🚀 Introduction
+
+LeCrapaud is a high-level Python library for end-to-end machine learning workflows on tabular data, with a focus on financial and stock datasets. It provides a simple API to handle feature engineering, model selection, training, and prediction, all in a reproducible and modular way.
+
+## ✨ Key Features
+
+- 🧩 Modular pipeline: Feature engineering, preprocessing, selection, and modeling as independent steps
+- 🤖 Automated model selection and hyperparameter optimization
+- 📊 Easy integration with pandas DataFrames
+- 🔬 Supports both regression and classification tasks
+- 🛠️ Simple API for both full pipeline and step-by-step usage
+- 📦 Ready for production and research workflows
+
+## ⚡ Quick Start
 
 1. Create environment
 
@@ -66,8 +83,7 @@ $ source .venv/bin/activate
 2. Install dependencies
 
 ```sh
-$ pip install -r requirements.txt
-$ pip freeze > requirements.txt
+$ make install
 ```
 
 3. Deactivate virtualenv (if needed)
@@ -76,7 +92,51 @@ $ pip freeze > requirements.txt
 $ deactivate
 ```
 
-## Reminders for Github usage
+## 🛠️ How it works
+
+This package provides a high-level API to manage experiments for feature engineering, model selection, and prediction on tabular data (e.g. stock data).
+
+### Typical workflow
+
+```python
+from lecrapaud.api import LeCrapaud
+
+# 1. Create the main app
+app = LeCrapaud()
+
+# 2. Define your experiment context (see your notebook or api.py for all options)
+context = {
+    "data": your_dataframe,
+    "columns_drop": [...],
+    "columns_date": [...],
+    # ... other config options
+}
+
+# 3. Create an experiment
+experiment = app.create_experiment(**context)
+
+# 4. Run the full training pipeline
+experiment.train(your_dataframe)
+
+# 5. Make predictions on new data
+predictions = experiment.predict(new_data)
+```
+
+### Modular usage
+
+You can also use each step independently:
+
+```python
+data_eng = experiment.feature_engineering(data)
+train, val, test = experiment.preprocess_feature(data_eng)
+features = experiment.feature_selection(train)
+std_data, reshaped_data = experiment.preprocess_model(train, val, test)
+experiment.model_selection(std_data, reshaped_data)
+```
+
+## 🤝 Contributing
+
+### Reminders for Github usage
 
 1. Creating Github repository
 
@@ -96,10 +156,9 @@ $ git remote add origin <YOUR_REPO_URL>
 $ git push -u origin master
 ```
 
-3. use conventional commits
+3. Use conventional commits  
 https://www.conventionalcommits.org/en/v1.0.0/#summary
 
-
-***
+---
 
 Pierre Gallet © 2024

lecrapaud-0.2.0/README.md

@@ -0,0 +1,115 @@
+<div align="center">
+
+# 🐸
+
+## Welcome to LeCrapaud
+
+**An all-in-one machine learning framework**
+
+</div>
+
+## 🚀 Introduction
+
+LeCrapaud is a high-level Python library for end-to-end machine learning workflows on tabular data, with a focus on financial and stock datasets. It provides a simple API to handle feature engineering, model selection, training, and prediction, all in a reproducible and modular way.
+
+## ✨ Key Features
+
+- 🧩 Modular pipeline: Feature engineering, preprocessing, selection, and modeling as independent steps
+- 🤖 Automated model selection and hyperparameter optimization
+- 📊 Easy integration with pandas DataFrames
+- 🔬 Supports both regression and classification tasks
+- 🛠️ Simple API for both full pipeline and step-by-step usage
+- 📦 Ready for production and research workflows
+
+## ⚡ Quick Start
+
+1. Create environment
+
+```sh
+$ pip install virtualenv
+$ python -m venv .venv
+$ source .venv/bin/activate
+```
+
+2. Install dependencies
+
+```sh
+$ make install
+```
+
+3. Deactivate virtualenv (if needed)
+
+```sh
+$ deactivate
+```
+
+## 🛠️ How it works
+
+This package provides a high-level API to manage experiments for feature engineering, model selection, and prediction on tabular data (e.g. stock data).
+
+### Typical workflow
+
+```python
+from lecrapaud.api import LeCrapaud
+
+# 1. Create the main app
+app = LeCrapaud()
+
+# 2. Define your experiment context (see your notebook or api.py for all options)
+context = {
+    "data": your_dataframe,
+    "columns_drop": [...],
+    "columns_date": [...],
+    # ... other config options
+}
+
+# 3. Create an experiment
+experiment = app.create_experiment(**context)
+
+# 4. Run the full training pipeline
+experiment.train(your_dataframe)
+
+# 5. Make predictions on new data
+predictions = experiment.predict(new_data)
+```
+
+### Modular usage
+
+You can also use each step independently:
+
+```python
+data_eng = experiment.feature_engineering(data)
+train, val, test = experiment.preprocess_feature(data_eng)
+features = experiment.feature_selection(train)
+std_data, reshaped_data = experiment.preprocess_model(train, val, test)
+experiment.model_selection(std_data, reshaped_data)
+```
+
+## 🤝 Contributing
+
+### Reminders for Github usage
+
+1. Creating Github repository
+
+```sh
+$ brew install gh
+$ gh auth login
+$ gh repo create
+```
+
+2. Initializing git and first commit to distant repository
+
+```sh
+$ git init
+$ git add .
+$ git commit -m 'first commit'
+$ git remote add origin <YOUR_REPO_URL>
+$ git push -u origin master
+```
+
+3. Use conventional commits  
+https://www.conventionalcommits.org/en/v1.0.0/#summary
+
+---
+
+Pierre Gallet © 2024

{lecrapaud-0.1.0 → lecrapaud-0.2.0}/lecrapaud/config.py

@@ -22,4 +22,5 @@ DB_PASSWORD = (
 DB_HOST = os.getenv("TEST_DB_HOST") if PYTHON_ENV == "Test" else os.getenv("DB_HOST")
 DB_PORT = os.getenv("TEST_DB_PORT") if PYTHON_ENV == "Test" else os.getenv("DB_PORT")
 DB_NAME = os.getenv("TEST_DB_NAME") if PYTHON_ENV == "Test" else os.getenv("DB_NAME")
+DB_URI = os.getenv("DB_URI", None)
 OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")

{lecrapaud-0.1.0 → lecrapaud-0.2.0}/lecrapaud/db/session.py

@@ -3,20 +3,30 @@
 from contextlib import contextmanager
 from sqlalchemy import create_engine, text
 from sqlalchemy.orm import sessionmaker
-from lecrapaud.config import DB_USER, DB_PASSWORD, DB_HOST, DB_PORT, DB_NAME
+from urllib.parse import urlparse
+
+from lecrapaud.config import DB_USER, DB_PASSWORD, DB_HOST, DB_PORT, DB_NAME, DB_URI
 
 _engine = None
 _SessionLocal = None
-DATABASE_URL = f"mysql+pymysql://{DB_USER}:{DB_PASSWORD}@{DB_HOST}:{DB_PORT}/{DB_NAME}"
+DATABASE_URL = (
+    f"mysql+pymysql://{DB_USER}:{DB_PASSWORD}@{DB_HOST}:{DB_PORT}/{DB_NAME}" or DB_URI
+)
 
 
 def init_db(uri: str = None):
     global _engine, _SessionLocal
 
+    uri = uri if uri else DATABASE_URL
+    # Extract DB name from URI to connect without it
+    parsed = urlparse(uri)
+    db_name = parsed.path.lstrip("/")  # remove leading slash
+
+    # Build root engine (no database in URI)
+    root_uri = uri.replace(f"/{db_name}", "/")
+
     # Step 1: Connect to MySQL without a database
-    root_engine = create_engine(
-        uri if uri else f"mysql+pymysql://{DB_USER}:{DB_PASSWORD}@{DB_HOST}:{DB_PORT}/"
-    )
+    root_engine = create_engine(root_uri)
 
     # Step 2: Create database if it doesn't exist
     with root_engine.connect() as conn:
@@ -24,7 +34,7 @@ def init_db(uri: str = None):
         conn.commit()
 
     # Step 3: Connect to the newly created database
-    _engine = create_engine(DATABASE_URL, echo=False)
+    _engine = create_engine(uri, echo=False)
 
     # Step 4: Create session factory
     _SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=_engine)

{lecrapaud-0.1.0 → lecrapaud-0.2.0}/lecrapaud/feature_engineering.py

@@ -589,7 +589,6 @@ class PreprocessFeature:
 
         if transformer:
             transformed = transformer.transform(X)
-            print(len(transformed), len(transformed[0]))
         else:
             transformer = ColumnTransformer(
                 transformers=[

{lecrapaud-0.1.0 → lecrapaud-0.2.0}/lecrapaud/feature_selection.py

@@ -811,12 +811,10 @@ class PreprocessModel:
         if duplicates:
             raise ValueError(f"Doublons détectés dans columns_to_keep: {duplicates}")
 
-        logger.info(self.all_features)
-
         self.train = train[columns_to_keep]
-        if val:
+        if isinstance(val, pd.DataFrame):
             self.val = val[columns_to_keep]
-        if test:
+        if isinstance(test, pd.DataFrame):
             self.test = test[columns_to_keep]
 
     def run(self):

{lecrapaud-0.1.0 → lecrapaud-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lecrapaud"
-version = "0.1.0"
+version = "0.2.0"
 description = "Framework for machine and deep learning, with regression, classification and time series analysis"
 authors = [
     {name = "Pierre H. Gallet"}

lecrapaud-0.1.0/README.md

@@ -1,56 +0,0 @@
-# Stock
-
-## Overview
-
-## Project description
-
-## Quick Start
-
-1. Create environment
-
-```sh
-$ pip install virtualenv
-$ python -m venv .venv
-$ source .venv/bin/activate
-```
-
-2. Install dependencies
-
-```sh
-$ pip install -r requirements.txt
-$ pip freeze > requirements.txt
-```
-
-3. Deactivate virtualenv (if needed)
-
-```sh
-$ deactivate
-```
-
-## Reminders for Github usage
-
-1. Creating Github repository
-
-```sh
-$ brew install gh
-$ gh auth login
-$ gh repo create
-```
-
-2. Initializing git and first commit to distant repository
-
-```sh
-$ git init
-$ git add .
-$ git commit -m 'first commit'
-$ git remote add origin <YOUR_REPO_URL>
-$ git push -u origin master
-```
-
-3. use conventional commits
-https://www.conventionalcommits.org/en/v1.0.0/#summary
-
-
-***
-
-Pierre Gallet © 2024