<html><head></head><body><h1>Release Notes: Version v0.4.0</h1>
<h2>Overview</h2>
<p>This release introduces comprehensive updates, including new machine learning modules, expanded documentation, and critical bug fixes. The addition of image classification support, Kaggle integration, and adjustments to key machine learning models significantly enhance the repository's functionality.</p>
<hr>
<h2>🚀 New Features</h2>
<h3>Machine Learning Enhancements</h3>
<ul>
<li>
<p><strong>Added SmallXception Architecture:</strong><br>
A lightweight model for binary image classification tasks.<br>
Commit: <code inline="">b2818e4</code>, <code inline="">b661a0e</code></p>
</li>
<li>
<p><strong>Introduced ImageClassificationTrainer Class:</strong><br>
Facilitates training and evaluation workflows for image classification.<br>
Commit: <code inline="">180ea0e</code></p>
</li>
<li>
<p><strong>Added <code inline="">ml_models</code> and <code inline="">ml_trainers</code> Modules:</strong><br>
Comprehensive modules for defining and training machine learning models.<br>
Commit: <code inline="">8c1b804</code>, <code inline="">4577d5f</code></p>
</li>
<li>
<p><strong>Kaggle Integration:</strong></p>
<ul>
<li>New <code inline="">kagglehub</code> dependency for downloading datasets and pre-trained models.<br>
Commit: <code inline="">77c832f</code></li>
<li>Included default addresses for Cucaracha pre-trained models.<br>
Commit: <code inline="">4c9c711</code></li>
<li>Module for handling Kaggle API calls.<br>
Commit: <code inline="">1ce6e56</code></li>
</ul>
</li>
<li>
<p><strong>Expanded Testing:</strong></p>
<ul>
<li>Tests for <code inline="">verify_image_compatibility</code> and <code inline="">ml_models</code> modules.<br>
Commits: <code inline="">03754ac</code>, <code inline="">0d92f22</code></li>
</ul>
</li>
</ul>
<h3>Dependency and Compatibility Updates</h3>
<ul>
<li>TensorFlow 2.16.2 defined as the required version.<br>
Commit: <code inline="">63cd4c9</code></li>
<li>Removed Windows compatibility; supports Linux/Mac only.<br>
Commit: <code inline="">963fa74</code></li>
</ul>
<hr>
<h2>🐛 Bug Fixes</h2>
<ul>
<li>
<p><strong>Dataset Loading Fix:</strong><br>
Adjusted <code inline="">load_cucaracha_dataset</code> to rearrange folder structures for compatibility with <code inline="">ml_trainers</code>.<br>
Commit: <code inline="">515d01c</code></p>
</li>
<li>
<p><strong>Model Improvements:</strong><br>
Fixed lint issues with the SmallXception model and <code inline="">__str__</code> method for the <code inline="">ModelArchitec</code> interface.<br>
Commits: <code inline="">799474c</code>, <code inline="">436f352</code></p>
</li>
<li>
<p><strong>Various Fixes:</strong></p>
<ul>
<li>Resolved <code inline="">int</code> to <code inline="">float</code> assertion issues.<br>
Commit: <code inline="">2fee044</code></li>
<li>Fixes for TensorFlow training runner stability.<br>
Commit: <code inline="">279d75b</code></li>
</ul>
</li>
</ul>
<hr>
<h2>📝 Documentation Updates</h2>
<ul>
<li>
<p><strong>Getting Started Section Added:</strong><br>
Comprehensive guide for new users.<br>
Commit: <code inline="">eb809a8</code></p>
</li>
<li>
<p><strong>New Documentation Sections:</strong><br>
Added details about <code inline="">ml_models</code> and <code inline="">ml_trainers</code> modules.<br>
Commit: <code inline="">f727042</code></p>
</li>
<li>
<p><strong>Documentation Configuration:</strong><br>
Added <code inline="">mkdocs.yml</code> for structured documentation generation.<br>
Commit: <code inline="">a5cb8c9</code></p>
</li>
</ul>
<hr>
<h2>🛠️ Enhancements</h2>
<ul>
<li>
<p>Organized the <code inline="">MLPattern</code> interface for general ML implementations.<br>
Commit: <code inline="">c355638</code></p>
</li>
<li>
<p>Improved code coverage and file organization within the repository.<br>
Commit: <code inline="">335a85c</code>, <code inline="">104ae7f</code></p>
</li>
<li>
<p>Updated <code inline="">.gitignore</code> to exclude <code inline="">.keras</code> files and <code inline="">organized_dataset</code>.<br>
Commits: <code inline="">45bdcfb</code>, <code inline="">f381dae</code></p>
</li>
<li>
<p>Improved dataset samples for more robust testing.<br>
Commit: <code inline="">c9c8636</code></p>
</li>
</ul>
<hr>
<h2>🔒 Issues Resolved</h2>
<ul>
<li><strong><a href="https://github.com/your-repo/issues/17">#17</a>:</strong> Add ML training support.</li>
<li><strong><a href="https://github.com/your-repo/issues/12">#12</a>:</strong> Define ML model and trainer modules.</li>
<li><strong><a href="https://github.com/your-repo/issues/8">#8</a>:</strong> Add Kaggle integration for datasets and models.</li>
<li><strong><a href="https://github.com/your-repo/issues/7">#7</a>:</strong> Support for image classification tasks.</li>
<li><strong><a href="https://github.com/your-repo/issues/6">#6</a>:</strong> TensorFlow training runner fixes.</li>
</ul>
<hr>
<h2>Commit Summary</h2>
Commit | Type | Description
-- | -- | --
a5cb8c9 | DOC | Add mkdocs.yml and getting_started.md section
799474c | BUG | Fix lint on SmallXception model
279d75b | BUG | Fix TensorFlow training runner
b2818e4 | ENH | Add SmallXception ML model
1ce6e56 | ENH | Kaggle API integration
eb809a8 | DOC | Added Getting Started guide
515d01c | BUG | Fix dataset loading issues
b661a0e | ENH | Adjust SmallXception to binary classification
f727042 | DOC | Add sections for ML modules
8c1b804 | ENH | Define ml_models and ml_trainers modules
77c832f | ENH | Add kagglehub dependency
2fee044 | BUG | Fix int-to-float assertion
335a85c | ENH | Improved code coverage
63cd4c9 | ENH | Defined TensorFlow 2.16.2 compatibility
<hr>
<h2>Upgrade Instructions</h2>
<ol>
<li>
<p>Update your package to the latest version:</p>
<pre><code class="language-bash">pip install cucaracha --upgrade
</code></pre>
</li>
<li>
<p>Follow the <a href="https://github.com/your-repo/docs/getting_started.md">Getting Started Guide</a> for an overview of the new features.</p>
</li>
</ol>
<p>We encourage users to explore the new ML capabilities and provide feedback through GitHub issues. Thank you for supporting