Metadata-Version: 2.1
Name: ml-research
Version: 0.3.4
Summary: Implementation of Machine Learning algorithms, experiments and utilities.
Home-page: https://github.com/joaopfonseca/ml-research
Maintainer: J. Fonseca
Maintainer-email: jpfonseca@novaims.unl.pt
License: MIT
Download-URL: https://github.com/joaopfonseca/ml-research
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: dev
License-File: LICENSE

|CircleCI| |Codecov| |Documentation Status| |Pypi Version| |Black| |Python
Versions| |DOI|

ML-Research
===========

This repository contains the code developed for all the publications I
was involved in. The LaTeX and Python code for generating the paper,
experiments' results and visualizations reported in each paper is
available (whenever possible) in the paper's directory.

Additionally, contributions at the algorithm level are available in the
package ``research``.

Installation and Setup
----------------------

A Python distribution of version 3.7 or higher is required to run this
project.

User Installation
~~~~~~~~~~~~~~~~~

If you already have a working installation of numpy and scipy, the easiest way
to install scikit-learn is using ``pip`` ::

    pip install -U ml-research

The documentation includes more detailed `installation instructions
<https://mlresearch.readthedocs.io/en/latest/getting-started.html>`_.

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/research.git
    cd research

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

    # Install project requirements and the research package
    make requirements

Citing ML-Research
------------------

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


    @article{Fonseca2021,
      doi = {10.3390/RS13132619},
      url = {https://doi.org/10.3390/RS13132619},
      keywords = {SMOTE,active learning,artificial data generation,land use/land cover classification,oversampling},
      year = {2021},
      month = {jul},
      publisher = {Multidisciplinary Digital Publishing Institute},
      volume = {13},
      pages = {2619},
      author = {Fonseca, Joao and Douzas, Georgios and Bacao, Fernando},
      title = {{Increasing the Effectiveness of Active Learning: Introducing Artificial Data Generation in Active Learning for Land Use/Land Cover Classification}},
      journal = {Remote Sensing}
    }


.. |Python Versions| image:: https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9-blue

.. |Documentation Status| image:: https://readthedocs.org/projects/mlresearch/badge/?version=latest
   :target: https://mlresearch.readthedocs.io/en/latest/?badge=latest

.. |Pypi Version| image:: https://badge.fury.io/py/ml-research.svg
   :target: https://badge.fury.io/py/ml-research

.. |DOI| image:: https://zenodo.org/badge/DOI/10.3390/RS13132619.svg
   :target: https://doi.org/10.3390/RS13132619

.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black

.. |CircleCI| image:: https://circleci.com/gh/joaopfonseca/ml-research/tree/master.svg?style=shield
    :target: https://circleci.com/gh/joaopfonseca/ml-research/tree/master

.. |Codecov| image:: https://codecov.io/gh/joaopfonseca/ml-research/branch/master/graph/badge.svg?token=J2EBA4YTMN
      :target: https://codecov.io/gh/joaopfonseca/ml-research
    


