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

Uploaded Source

Built Distribution

ml_research-0.4.2-py3-none-any.whl (83.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ml-research-0.4.2.tar.gz
Algorithm Hash digest
SHA256 73b05397ef9a49bc1215c456f705a685a48f9c8b53514d357be06be5017a75be
MD5 a9c170a31621c453bb02252867e26b98
BLAKE2b-256 1727264fafbef18eaec5bf22b07a5a8b8672b16147db00990e79df1c873c1068

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ml_research-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f14bfac6ed863127b9a5342d149905630d6ab9d15022856ea3f36de478433c67
MD5 1950cfeeee3bd6244e5f3fa2c33d3882
BLAKE2b-256 172f9115d19cafb396ce92395eb13cd5a409f06bdbdaab71a7960cbee6c25b29

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