Skip to main content

Implementation of Machine Learning algorithms, experiments and utilities.

Project description


Github Actions Codecov Documentation Status Black Python Versions DOI

PyPI Pypi Version Downloads
Anaconda Conda Version Conda Downloads

ML-Research is an open source library for machine learning research. It contains several utilities for Machine Learning research and algorithm implementations. Specifically, it contains scikit-learn compatible implementations for Active Learning and synthetic data generation, as well as datasets and various utilities to assist in experiment design and results reporting.

The LaTeX and Python code for generating the paper, experiments' results and visualizations shown in each paper is available (whenever possible) in the publications repo.

Installation

A Python distribution of version >= 3.11 is required to run this project. Python versions below 3.11 are not supported and pip will refuse installation on Python < 3.11. ML-Research requires:

  • numpy (>= 1.20.0)
  • pandas (>= 2.1.0)
  • sklearn (>= 1.2.0)
  • imblearn (>= 0.8.0)

Some functions in the mlresearch.utils submodule (the ones in the script _visualization.py) require Matplotlib (>= 2.2.3). The mlresearch.datasets submodule and mlresearch.utils.parallel_apply function require tqdm (>= 4.46.0) to display progress bars.

User Installation

The easiest way to install ml-research is using pip :

pip install -U ml-research

Or conda :

conda install -c conda-forge ml-research

The documentation includes more detailed installation instructions.

Installing from source

The following commands should allow you to setup the development version of the project with minimal effort:

# Clone the project.
git clone https://github.com/joaopfonseca/ml-research.git
cd ml-research

# Create and activate an environment 
make environment 
conda activate mlresearch # Adapt this line accordingly if you're not running conda

# Install project requirements and the research package. Dependecy group
# "all" will also install the dependency groups shown below.
pip install .[optional,tests,docs] 

Citing ML-Research

If you use ML-Research in a scientific publication, we would appreciate citations to the following paper:

@article{fonseca2023improving,
  title={Improving Active Learning Performance through the Use of Data Augmentation},
  author={Fonseca, Joao and Bacao, Fernando and others},
  journal={International Journal of Intelligent Systems},
  volume={2023},
  year={2023},
  publisher={Hindawi}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ml_research-0.5.3.tar.gz (89.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ml_research-0.5.3-py3-none-any.whl (115.0 kB view details)

Uploaded Python 3

File details

Details for the file ml_research-0.5.3.tar.gz.

File metadata

  • Download URL: ml_research-0.5.3.tar.gz
  • Upload date:
  • Size: 89.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for ml_research-0.5.3.tar.gz
Algorithm Hash digest
SHA256 0af6523764a185eca293ff4cc9050ead8136f45a801375bb6fa7dbd399780354
MD5 70f014bee2383846f0817de4ee596f42
BLAKE2b-256 291e1cccfaa1aa7d9cca47ddc6e7d9d27b33718e8b4d6b1215d57c2f1bcb7f27

See more details on using hashes here.

File details

Details for the file ml_research-0.5.3-py3-none-any.whl.

File metadata

  • Download URL: ml_research-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 115.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for ml_research-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e21801eab758ee212a72bb49cdd0deadedcf22e13c951ce10d85391d7930f23c
MD5 e227f2b8aaf5d3395acb3363ec23741b
BLAKE2b-256 3c8f61774adea6cfabb486ef00b74e20c97b78b1d9f613223d1bb9ff8a42a809

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page