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 the software implementation of most algorithms used or developed in my research. Specifically, it contains scikit-learn compatible implementations for Active Learning and Oversampling, 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.

Contributions at the algorithm level are available in the package mlresearch.

Installation

A Python distribution of version 3.8, 3.9 or 3.10 is required to run this project. Earlier Python versions might work in most cases, but they are not tested. ML-Research requires:

  • numpy (>= 1.14.6)
  • pandas (>= 1.3.5)
  • sklearn (>= 1.0.0)
  • imblearn (>= 0.8.0)
  • rich (>= 10.16.1)

Some functions in the mlresearch.utils submodule (the ones in the script _visualization.py) require Matplotlib >= 2.2.3.

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.4.1.tar.gz (63.5 kB view details)

Uploaded Source

Built Distribution

ml_research-0.4.1-py3-none-any.whl (82.0 kB view details)

Uploaded Python 3

File details

Details for the file ml-research-0.4.1.tar.gz.

File metadata

  • Download URL: ml-research-0.4.1.tar.gz
  • Upload date:
  • Size: 63.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for ml-research-0.4.1.tar.gz
Algorithm Hash digest
SHA256 086bec8bdc6e509dd5a175cc80862626d17ec584059541677c08c34c3bea39d1
MD5 e653adc4efb93ad8541699909f98a0e1
BLAKE2b-256 f9903c46a7b181951be251869c7f7ae73f35c9a776fda742483ac7603e2a9bad

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ml_research-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 82.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for ml_research-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 acfbce4cd0a1fcdd9315cf5f71963371268ab24ee769c72ca1fe11f63452e29f
MD5 e4525caedc413b2220d1b7fb9fe43d68
BLAKE2b-256 eb1184ebe7a190ea69e9d511b977cb35f6f8a7fb300cf0366e10e57189d978e6

See more details on using hashes here.

Supported by

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