lecrapaud 0.18.7__py3-none-any.whl → 0.22.6__py3-none-any.whl

lecrapaud-0.18.7.dist-info/METADATA

@@ -1,248 +0,0 @@
-Metadata-Version: 2.3
-Name: lecrapaud
-Version: 0.18.7
-Summary: Framework for machine and deep learning, with regression, classification and time series analysis
-License: Apache License
-Author: Pierre H. Gallet
-Requires-Python: ==3.12.*
-Classifier: License :: Other/Proprietary License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: category-encoders (>=2.8.1)
-Requires-Dist: celery (>=5.5.3)
-Requires-Dist: ftfy (>=6.3.1)
-Requires-Dist: joblib (>=1.5.1)
-Requires-Dist: keras (>=3.10.0)
-Requires-Dist: lightgbm (>=4.6.0)
-Requires-Dist: matplotlib (>=3.10.3)
-Requires-Dist: mlxtend (>=0.23.4)
-Requires-Dist: numpy (>=2.1.3)
-Requires-Dist: openai (>=1.88.0)
-Requires-Dist: pandas (>=2.3.0)
-Requires-Dist: pydantic (>=2.9.2)
-Requires-Dist: python-dotenv (>=1.1.0)
-Requires-Dist: scikit-learn (>=1.6.1)
-Requires-Dist: scipy (<1.14.0)
-Requires-Dist: seaborn (>=0.13.2)
-Requires-Dist: sqlalchemy (>=2.0.41)
-Requires-Dist: tensorboardx (>=2.6.4)
-Requires-Dist: tensorflow (>=2.19.0)
-Requires-Dist: tiktoken (>=0.9.0)
-Requires-Dist: tqdm (>=4.67.1)
-Requires-Dist: xgboost (>=3.0.2)
-Description-Content-Type: text/markdown
-
-<div align="center">
-
-<img src="https://s3.amazonaws.com/pix.iemoji.com/images/emoji/apple/ios-12/256/frog-face.png" width=120 alt="crapaud"/>
-
-## Welcome to LeCrapaud
-
-**An all-in-one machine learning framework**
-
-[![GitHub stars](https://img.shields.io/github/stars/pierregallet/lecrapaud.svg?style=flat&logo=github&colorB=blue&label=stars)](https://github.com/pierregallet/lecrapaud/stargazers)
-[![PyPI version](https://badge.fury.io/py/lecrapaud.svg)](https://badge.fury.io/py/lecrapaud)
-[![Python versions](https://img.shields.io/pypi/pyversions/lecrapaud.svg)](https://pypi.org/project/lecrapaud)
-[![License](https://img.shields.io/github/license/pierregallet/lecrapaud.svg)](https://github.com/pierregallet/lecrapaud/blob/main/LICENSE)
-[![codecov](https://codecov.io/gh/pierregallet/lecrapaud/branch/main/graph/badge.svg)](https://codecov.io/gh/pierregallet/lecrapaud)
-
-</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
-
-
-### Install the package
-
-```sh
-pip install lecrapaud
-```
-
-### 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 import LeCrapaud
-
-# 1. Create the main app
-app = LeCrapaud(uri=uri)
-
-# 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)
-```
-
-### Database Configuration (Required)
-
-LeCrapaud requires access to a MySQL database to store experiments and results. You must either:
-
-- Pass a valid MySQL URI to the `LeCrapaud` constructor:
-  ```python
-  app = LeCrapaud(uri="mysql+pymysql://user:password@host:port/dbname")
-  ```
-- **OR** set the following environment variables before using the package:
-  - `DB_USER`, `DB_PASSWORD`, `DB_HOST`, `DB_PORT`, `DB_NAME`
-  - Or set `DB_URI` directly with your full connection string.
-
-If neither is provided, database operations will not work.
-
-### Using OpenAI Embeddings (Optional)
-
-If you want to use the `columns_pca` embedding feature (for advanced feature engineering), you must set the `OPENAI_API_KEY` environment variable with your OpenAI API key:
-
-```sh
-export OPENAI_API_KEY=sk-...
-```
-
-If this variable is not set, features relying on OpenAI embeddings will not be available.
-
-### Experiment Context Arguments
-
-Below are the main arguments you can pass to `create_experiment` (or the `Experiment` class):
-
-| Argument             | Type      | Description                                                                              | Example/Default    |
-| -------------------- | --------- | ---------------------------------------------------------------------------------------- | ------------------ |
-| `columns_binary`     | list      | Columns to treat as binary                                                               | `['flag']`         |
-| `columns_boolean`    | list      | Columns to treat as boolean                                                              | `['is_active']`    |
-| `columns_date`       | list      | Columns to treat as dates                                                                | `['date']`         |
-| `columns_drop`       | list      | Columns to drop during feature engineering                                               | `['col1', 'col2']` |
-| `columns_frequency`  | list      | Columns to frequency encode                                                              | `['category']`     |
-| `columns_onehot`     | list      | Columns to one-hot encode                                                                | `['sector']`       |
-| `columns_ordinal`    | list      | Columns to ordinal encode                                                                | `['grade']`        |
-| `columns_pca`        | list      | Columns to use for PCA/embeddings (requires `OPENAI_API_KEY` if using OpenAI embeddings) | `['text_col']`     |
-| `columns_te_groupby` | list      | Columns for target encoding groupby                                                      | `['sector']`       |
-| `columns_te_target`  | list      | Columns for target encoding target                                                       | `['target']`       |
-| `data`               | DataFrame | Your main dataset (required for new experiment)                                          | `your_dataframe`   |
-| `date_column`        | str       | Name of the date column                                                                  | `'date'`           |
-| `experiment_name`    | str       | Name for the training session                                                            | `'my_session'`     |
-| `group_column`       | str       | Name of the group column                                                                 | `'stock_id'`       |
-| `max_timesteps`      | int       | Max timesteps for time series models                                                     | `30`               |
-| `models_idx`         | list      | Indices of models to use for model selection                                             | `[0, 1, 2]`        |
-| `number_of_trials`   | int       | Number of trials for hyperparameter optimization                                         | `20`               |
-| `perform_crossval`   | bool      | Whether to perform cross-validation                                                      | `True`/`False`     |
-| `perform_hyperopt`   | bool      | Whether to perform hyperparameter optimization                                           | `True`/`False`     |
-| `plot`               | bool      | Whether to plot results                                                                  | `True`/`False`     |
-| `preserve_model`     | bool      | Whether to preserve the best model                                                       | `True`/`False`     |
-| `target_clf`         | list      | List of classification target column indices/names                                       | `[1, 2, 3]`        |
-| `target_mclf`        | list      | Multi-class classification targets (not yet implemented)                                 | `[11]`             |
-| `target_numbers`     | list      | List of regression target column indices/names                                           | `[1, 2, 3]`        |
-| `test_size`          | int/float | Test set size (count or fraction)                                                        | `0.2`              |
-| `time_series`        | bool      | Whether the data is time series                                                          | `True`/`False`     |
-| `val_size`           | int/float | Validation set size (count or fraction)                                                  | `0.2`              |
-
-**Note:**
-- Not all arguments are required; defaults may exist for some.
-- For `columns_pca` with OpenAI embeddings, you must set the `OPENAI_API_KEY` environment variable.
-
-
-
-### 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)
-```
-
-## ⚠️ Using Alembic in Your Project (Important for Integrators)
-
-If you use Alembic for migrations in your own project and you share the same database with LeCrapaud, you must ensure that Alembic does **not** attempt to drop or modify LeCrapaud tables (those prefixed with `{LECRAPAUD_TABLE_PREFIX}_`).
-
-By default, Alembic's autogenerate feature will propose to drop any table that exists in the database but is not present in your project's models. To prevent this, add the following filter to your `env.py`:
-
-```python
-def include_object(object, name, type_, reflected, compare_to):
-    if type_ == "table" and name.startswith(f"{LECRAPAUD_TABLE_PREFIX}_"):
-        return False  # Ignore LeCrapaud tables
-    return True
-
-context.configure(
-    # ... other options ...
-    include_object=include_object,
-)
-```
-
-This will ensure that Alembic ignores all tables created by LeCrapaud when generating migrations for your own project.
-
----
-
-## 🤝 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
-
-4. Create environment
-
-```sh
-$ pip install virtualenv
-$ python -m venv .venv
-$ source .venv/bin/activate
-```
-
-5. Install dependencies
-
-```sh
-$ make install
-```
-
-6. Deactivate virtualenv (if needed)
-
-```sh
-$ deactivate
-```
-
----
-
-Pierre Gallet © 2025

lecrapaud-0.18.7.dist-info/RECORD

@@ -1,46 +0,0 @@
-lecrapaud/__init__.py,sha256=oCxbtw_nk8rlOXbXbWo0RRMlsh6w-hTiZ6e5PRG_wp0,28
-lecrapaud/api.py,sha256=GsylHdScug-D8ePbPKo5r7Wa0myj9Ol0OqNwlNsbgs8,22518
-lecrapaud/config.py,sha256=itiqC31HB8i2Xo-kn2viCQrg_9tnA07-TJuZ-xdnx44,1126
-lecrapaud/db/__init__.py,sha256=82o9fMfaqKXPh2_rt44EzNRVZV1R4LScEnQYvj_TjK0,34
-lecrapaud/db/alembic/README,sha256=MVlc9TYmr57RbhXET6QxgyCcwWP7w-vLkEsirENqiIQ,38
-lecrapaud/db/alembic/env.py,sha256=RvTTBa3bDVBxmDtapAfzUoeWBgmVQU3s9U6HmQCAP84,2421
-lecrapaud/db/alembic/script.py.mako,sha256=MEqL-2qATlST9TAOeYgscMn1uy6HUS9NFvDgl93dMj8,635
-lecrapaud/db/alembic/versions/2025_06_23_1748-f089dfb7e3ba_.py,sha256=hyPW0Mt_B4ZAHnJYLREy7MAncNDLnEIyJQJW2pyz_LY,17228
-lecrapaud/db/alembic/versions/2025_06_24_1216-c62251b129ed_.py,sha256=6Pf36HAXEVrVlnrohAe2O7gVaXpDiv3LLIP_EEgTyA0,917
-lecrapaud/db/alembic/versions/2025_06_24_1711-86457e2f333f_.py,sha256=KjwjYvFaNqYmBLTYel8As37fyaBtNVWTqN_3M7y_2eI,1357
-lecrapaud/db/alembic/versions/2025_06_25_1759-72aa496ca65b_.py,sha256=MiqooJuZ1etExl2he3MniaEv8G0LrmqY-0m22m9xKmc,943
-lecrapaud/db/alembic/versions/2025_08_25_1434-7ed9963e732f_add_best_score_to_model_selection.py,sha256=dzPelNA8N1f8rxUAF9KeoRx3FPvcTKshgcKyq_woe8c,858
-lecrapaud/db/alembic.ini,sha256=Zw2rdwsKV6c7J1SPtoFIPDX08_oTP3MuUKnNxBDiY8I,3796
-lecrapaud/db/models/__init__.py,sha256=Lhyw9fVLdom0Fc6yIP-ip8FjkU1EwVwjae5q2VM815Q,740
-lecrapaud/db/models/base.py,sha256=J9ew-0z_-tnWAwhVvOmVDys2R6jPF_oSca_ny6wpXQE,7606
-lecrapaud/db/models/experiment.py,sha256=LjsMTY-PA9HZ27D2sz2fWy7HvwFqiS0dXKaiKF-S3k4,14868
-lecrapaud/db/models/feature.py,sha256=5o77O2FyRObnLOCGNj8kaPSGM3pLv1Ov6mXXHYkmnYY,1136
-lecrapaud/db/models/feature_selection.py,sha256=mk42xuw1Sm_7Pznfg7TNc5_S4hscdw79QgIe3Bt9ZRI,3245
-lecrapaud/db/models/feature_selection_rank.py,sha256=Ydsb_rAT58FoSH13wkGjGPByzsjPx3DITXgJ2jgZmow,2198
-lecrapaud/db/models/model.py,sha256=F0hyMjd4FFHCv6_arIWBEmBCGOfG3b6_uzU8ExtFE90,952
-lecrapaud/db/models/model_selection.py,sha256=tJuICcporf3TxQHbJbHxnKgkaVc02z2kJJoCYS2nDcw,2001
-lecrapaud/db/models/model_training.py,sha256=jAIYPdwBln2jf593soLQ730uYrTfNK8zdG8TesOqmh0,1698
-lecrapaud/db/models/score.py,sha256=fSfXLt6Dm-8Fy9ku0urMT5Fa6zNqn4YqVnEO4o3zKVI,1669
-lecrapaud/db/models/target.py,sha256=DKnfeaLU8eT8J_oh_vuFo5-o1CaoXR13xBbswme6Bgk,1649
-lecrapaud/db/models/utils.py,sha256=-a-nWWmpJ2XzidIxo2COVUTrGZIPYCfBzjhcszJj_bM,1109
-lecrapaud/db/session.py,sha256=E93WXcFFILFAIeH61ft2Egs7D-6caqs0oi4zCkO5Lq4,2822
-lecrapaud/directories.py,sha256=0LrANuDgbuneSLker60c6q2hmGnQ3mKHIztTGzTx6Gw,826
-lecrapaud/experiment.py,sha256=1xLWjOrqAxJh9CdXOx9ppQuRFRRj0GH-xYZqg-ty9hI,2463
-lecrapaud/feature_engineering.py,sha256=ib1afBrwqePiXUaw0Cpe6hY3VNl5afg8YVntb88SCT4,39199
-lecrapaud/feature_selection.py,sha256=6ry-oVPQHbipm1XSE5YsH7AY0lQFt4CFbWiHiRs1nxg,43593
-lecrapaud/integrations/openai_integration.py,sha256=hHLF3fk5Bps8KNbNrEL3NUFa945jwClE6LrLpuMZOd4,7459
-lecrapaud/jobs/__init__.py,sha256=ZkrsyTOR21c_wN7RY8jPhm8jCrL1oCEtTsf3VFIlQiE,292
-lecrapaud/jobs/config.py,sha256=AmO0j3RFjx8H66dfKw_7vnshaOJb9Ox5BAZ9cwwLFMY,377
-lecrapaud/jobs/scheduler.py,sha256=OKXhb_gxE1-R7D1HyPns88iIS31Wd4gRqEzk4EqS0J4,774
-lecrapaud/jobs/tasks.py,sha256=sbD2_IT45DE4yQQbR6DVb9xv5x06rYDtUvSK8exYxes,332
-lecrapaud/misc/tabpfn_tests.ipynb,sha256=VkgsCUJ30d8jaL2VaWtQAgb8ngHPNtPgnXLs7QQTjqg,6676
-lecrapaud/misc/test-gpu-bilstm.ipynb,sha256=4nLuZRJVe2kn6kEmauhRiz5wkWT9AVrYhI9CEk_dYUY,9608
-lecrapaud/misc/test-gpu-resnet.ipynb,sha256=27Vu7nYwujYeh3fOxBNCnKJn3MXNPKZU-U8oDDUbymg,4944
-lecrapaud/misc/test-gpu-transformers.ipynb,sha256=k6MBSs_Um1h4PykvE-LTBcdpbWLbIFST_xl_AFW2jgI,8444
-lecrapaud/model_selection.py,sha256=gP7Jo_JyI7YVKNk7VG5DjGcheUZsir1vNnTlTCM-R40,72480
-lecrapaud/search_space.py,sha256=-JkzuMhaomdwiWi4HvVQY5hiw3-oREemJA16tbwEIp4,34854
-lecrapaud/utils.py,sha256=ATKu9pbXjYFRa2YzBYjqyLHJrzfnZ7SJrOD_qAnEBYE,8242
-lecrapaud-0.18.7.dist-info/LICENSE,sha256=MImCryu0AnqhJE_uAZD-PIDKXDKb8sT7v0i1NOYeHTM,11350
-lecrapaud-0.18.7.dist-info/METADATA,sha256=nMJ_H2nwBRKvFFyac3d6T0s6eluunnDdiVZcdM6dnBI,11081
-lecrapaud-0.18.7.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-lecrapaud-0.18.7.dist-info/RECORD,,