diff --git a/.gitignore b/.gitignore index 668182e..bedffc1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,6 @@ env/ *__pycache__/ .vscode/ +*.bat +Makefile ``` diff --git a/mlforall/__init__.py b/mlforall/__init__.py index 314b9fa..fbb3e23 100644 --- a/mlforall/__init__.py +++ b/mlforall/__init__.py @@ -1 +1,25 @@ #__init__.py +from mlforall import DataReading, DataScaling, DataModeling + +__all__ = [ + 'DataReading', + 'DataScaling', + 'DataModeling' +] + +__version__ = '0.3.1' + +__doc__ = ''' + +## Description +**mlforall** is an open-source library aimed to developers that are beginners in the data analysis area but want to build powerful machine learning projects from the very beginning. The package offers a reliable, easy to use and well documented set of functions that drive the user through the most common steps of any machine learning projects, from data reading to model testing. + +## Main features +These are some of the functionalities that mlforall offers: +1. File extension asbtraction when reading data (only supported for `.csv`, `.txt`, `.xlsx`, `.xlsx`, `.parquet` and `.npy`) +2. Automatic handling of non-numeric features and missing values. +3. A pool with almost all the data-scaling methods available and the most common ML models. +4. Automatic model evaluation and reporting. + +''' + diff --git a/setup.py b/setup.py index 4b26382..28ec833 100644 --- a/setup.py +++ b/setup.py @@ -9,13 +9,13 @@ setup( name = 'mlforall', # How you named your package folder (MyLib) packages = ['mlforall'], # Chose the same as "name" - version = '0.3', # Start with a small number and increase it with every change you make + version = '0.3.1', # Start with a small number and increase it with every change you make license='MIT', # Chose a license from here: https://help.github.com/articles/licensing-a-repository description = 'Library that easily allows to create machine learning progress for more unexperiencied programmers.', # Give a short description about your library author = 'Unai Torrecilla', # Type in your name author_email = 'unai.torrecilla@alumni.mondragon.edu', # Type in your E-Mail url = 'https://github.com/UnaiTorrecilla/MLForAll', # Provide either the link to your github or to your website - download_url = 'https://github.com/UnaiTorrecilla/MLForAll/archive/refs/tags/v_03.tar.gz', # I explain this later on + download_url = 'https://github.com/UnaiTorrecilla/MLForAll/archive/refs/tags/v_031.tar.gz', # I explain this later on long_description = long_description, long_description_content_type = 'text/markdown', keywords = ['Machine learning', 'Easy to use'], # Keywords that define your package best