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.9 is required to run this project. Earlier Python versions might work in most cases, but they are not tested. 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.0.tar.gz (75.0 kB view details)

Uploaded Source

Built Distribution

ml_research-0.5.0-py3-none-any.whl (96.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ml-research-0.5.0.tar.gz
  • Upload date:
  • Size: 75.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for ml-research-0.5.0.tar.gz
Algorithm Hash digest
SHA256 c4964526307d997c23e9202a3830b483535b7e740f8fa826689f806f58d2fdd2
MD5 7e17228199d51b40ffb8a4aee39823d5
BLAKE2b-256 336dc410fdced6809d2e6a6bfcf527df33860c25471bd539b3a0e30500eb8d2e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ml_research-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 96.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for ml_research-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 235f7fb4741b11ea48375d8d09940c899670361fa5d6a25be0c39ca2e5269657
MD5 83393797f9ec2101b935ff2660a91818
BLAKE2b-256 d46f508c9d79aa2b0d40ad654222160907e321f8dd6ddbcaf5386aa893d83e44

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