Metadata-Version: 2.4
Name: imlresearch
Version: 1.0.0
Summary: A Python Toolkit for Reproducible Image-Based ML Experiments
Author-email: SiulRek <luiskraker2000@gmail.com>
License: The MIT License (MIT)
        
        Copyright (c) 2025 Kraker Luis
        
        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.
Project-URL: Repository, https://github.com/SiulRek/ImageMLResearch
Project-URL: Documentation, https://imagemlresearch.readthedocs.io/en/api-development/
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Operating System :: Microsoft :: Windows
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Requires-Python: <3.13,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy<2,>=1.23.5
Requires-Dist: tensorflow<2.18,>=2.13
Requires-Dist: optuna<4.8,>=3.3
Requires-Dist: opencv-python<4.14,>=4.8
Requires-Dist: scikit-learn<1.8,>=1.4
Requires-Dist: seaborn<=0.13.2,>=0.12.0
Provides-Extra: ai-report
Requires-Dist: openai==1.34.0; extra == "ai-report"
Dynamic: license-file

# ImageMLResearch

[![Python 3.10–3.12](https://img.shields.io/badge/python-3.10%E2%80%933.12-blue.svg)](https://www.python.org/downloads/)

ImageMLResearch is a toolkit to help with image-based machine learning projects using Python. It includes functions for data handling, preprocessing, plotting, and more. These functions are combined into a single `Researcher` class to make experimentation easier and more efficient. Please note that this toolkit is specifically designed for image classification tasks and does not support regression problems.

For comprehensive usage instructions and API details, refer to the [official documentation](https://imagemlresearch.readthedocs.io/en/api-development/index.html).


## Installation
You can install ImageMLResearch using pip:

```bash
pip install imlresearch
```
 
 upgrade to the latest version:
```bash
pip install --upgrade imlresearch
```

📦 **Core Dependencies**  
This package supports Python 3.10–3.12. When installing, the following core libraries will also be installed:

```
numpy>=1.23.5,<2
tensorflow>=2.13,<2.18
optuna>=3.3,<4.8
opencv-python>=4.8,<4.14
scikit-learn>=1.4,<1.8
seaborn>=0.12.0,<=0.13.2
```

📦 **Optional Dependency for AI Report Generation**

```
openai==1.34.0
```

Install with:
```bash
pip install imlresearch[ai-report]
```

💡 **Optional GPU Support for TensorFlow**  
If you have a compatible GPU and wish to enable GPU acceleration for TensorFlow, you can install the CUDA-enabled version with the following command:

```bash
pip install --cache-dir=/opt/tmp tensorflow[and-cuda]
```

🧪 **Testing**  
The functionality of the code can be tested using the following command:

```python
from imlresearch.api.tests import run_all_tests
run_all_tests()
```
