Skip to content

Latest commit

 

History

History
91 lines (54 loc) · 3.86 KB

README.md

File metadata and controls

91 lines (54 loc) · 3.86 KB
Raw

GitHub issues GitHub stars GitHub forks GitHub license

Machine Learning Docker Environment

Introduction

This is the Git repository for the source code of the framework used for realizing GTI770-Systèmes intelligents et apprentissage machine course's labs.

This code is only the framework and is incomplete to let the student explore several machine learning algorithms. It is used jointly with multiple datasets, such as GalaxyZoo, Million Song Dataset and Spambase Data Set.

Students need to complete with their own code to solve classification problems automatically using different machine learning algorithms such as KNN, Naive Bayes, SVM, Neural Networks and Decision tree/Random Forests.

This framework has many dependencies, such as OpenCV 3.x.x, scikit-learn and TensorFlow. A best practice consists of running the code using a Docker environment built with all dependencies : Machine Learning Docker Environment. This framework has some code that can be GPU-accelerated using the GPU-enabled Docker environment and an NVIDIA GPU.

Quick references

Minimum requirements

  • 1.5 GB free hard disk space
  • A minimum of a 4-core, 4-thread x86 CPU.
  • A minimum of 8 GB of RAM, 16 GB or more is highly recommended.
  • PyCharm Professional IDE (optional, recommended when using a Docker container as execution environment).

Notes

OpenCV and TensorFlow, can be GPU-accelerated using NVIDIA GPU.

The OpenCV version required to run this code is OpenCV 3.3.x. OpenCV must be compiled for Python3.

Usage

Getting started

Ensure you have an environment variable according to this table :

With Docker Without Docker
Name Value Name Value
VIRTUAL_ENV /home/ubuntu/ml_venv/project VIRTUAL_ENV /home/ubuntu/ml_venv/

To launch the script :
cd core
python3 main.py

How to contribute ?

  • Create a branch by feature and/or bug fix
  • Get the code
  • Commit and push
  • Create a pull request

Branch naming

Feature branch

feature/ [Short feature description] [Issue number]

Bug branch

fix/ [Short fix description] [Issue number]

Commits syntax:
Adding code:

+ Added [Short Description] [Issue Number]

Deleting code:

- Deleted [Short Description] [Issue Number]

Modifying code:

* Changed [Short Description] [Issue Number]

Credits

Icons made by Smashicons from www.flaticon.com is licensed by CC 3.0 BY