Metadata-Version: 2.4
Name: dragon-ml-toolbox
Version: 2.4.0
Summary: A collection of tools for data science and machine learning projects
Author-email: Karl Loza <luigiloza@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/DrAg0n-BoRn/ML_tools
Project-URL: Changelog, https://github.com/DrAg0n-BoRn/ML_tools/blob/master/CHANGELOG.md
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: LICENSE-THIRD-PARTY.md
Requires-Dist: numpy<2.0
Requires-Dist: scikit-learn
Requires-Dist: openpyxl
Requires-Dist: miceforest<7.0.0,>=6.0.0
Requires-Dist: plotnine<0.13,>=0.12
Requires-Dist: matplotlib
Requires-Dist: seaborn
Requires-Dist: pandas
Requires-Dist: polars
Requires-Dist: imbalanced-learn
Requires-Dist: statsmodels
Requires-Dist: ipython
Requires-Dist: ipykernel
Requires-Dist: notebook
Requires-Dist: jupyterlab
Requires-Dist: ipywidgets
Requires-Dist: joblib
Requires-Dist: xgboost
Requires-Dist: lightgbm<=4.5.0
Requires-Dist: shap
Requires-Dist: tqdm>=4.0
Requires-Dist: Pillow
Provides-Extra: pytorch
Requires-Dist: torch; extra == "pytorch"
Requires-Dist: torchvision; extra == "pytorch"
Provides-Extra: gui
Requires-Dist: FreeSimpleGUI>=5.2; extra == "gui"
Dynamic: license-file

# dragon-ml-toolbox

A collection of Python utilities for data science and machine learning, structured as a modular package for easy reuse and installation.

## Features

- Modular scripts for data exploration, logging, machine learning, and more.
- Designed for seamless integration as a Git submodule or installable Python package.

## Installation

**Python 3.10+ recommended.**

### Via PyPI

Install the latest stable release from PyPI:

```bash
pip install dragon-ml-toolbox
```

### Via GitHub (Editable)

Clone the repository and install in editable mode with optional dependencies:

```bash
git clone https://github.com/DrAg0n-BoRn/ML_tools.git
cd ML_tools
pip install -e .
```

### Via conda-forge

Install from the conda-forge channel:

```bash
conda install -c conda-forge dragon-ml-toolbox
```
**Note:** This version is outdated or broken due to dependency incompatibilities. Use PyPi instead.

## Optional dependencies

### FreeSimpleGUI

Wrapper library used to build powerful GUIs. Requires the tkinter backend.

```bash
pip install dragon-ml-toolbox[gui]
```

### PyTorch

Different builds available depending on the **platform** and **hardware acceleration** (e.g., CUDA for NVIDIA GPUs on Linux/Windows, or MPS for Apple Silicon on macOS).

Install the default CPU-only version with

```bash
pip install dragon-ml-toolbox[pytorch]
```

To make use of GPU acceleration use the official PyTorch installation instructions:

[PyTorch Instructions](https://pytorch.org/get-started/locally/)

## Usage

After installation, import modules like this:

```python
from ml_tools.utilities import sanitize_filename
from ml_tools.logger import custom_logger
```

## Available modules

```bash
data_exploration
datasetmaster
ensemble_learning
ETL_engineering
GUI_tools
handle_excel
logger
MICE_imputation
PSO_optimization
trainer
utilities
VIF_factor
vision_helpers
```
