Skip to content

Latest commit

 

History

History
141 lines (96 loc) · 4.29 KB

README.md

File metadata and controls

141 lines (96 loc) · 4.29 KB
Raw

Thales Machine-Learning-Robot

JavaScript Style Guide: Good Parts License Maintenance Website shields.io Ask Me Anything ! Vue Deploy to GitHub Pages

Table of Contents

About

This is a playground for Machine Learning. It visualises a simple example in which the user is prompted to enrich the training set of a Decision Tree algorithm.

A demo (in English and Greek) can be found here.

This project uses the decision-tree-js library.

All dataset images are royalty-free and were taken from Pexels and Unsplash.

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

Pre-setup steps

It is very easy to install multiple versions of NodeJS and npm, by using Node Version Manager (nvm).

Make sure the right NodeJS and npm versions are installed:

nvm install lts/fermium # (or nvm install v14.21.1)

node -v
v20.13.1

npm -v
10.17.0

Alternatively, if you are using nvm, run this command in order to sync to the correct NodeJS version for the project:

nvm use

Project setup

Install the npm dependencies:

npm install

Create the local .env file:

cp .env.example .env

Compile and hot-reload for development

npm run serve

Compile and minify for production

npm run build

Run your tests

npm run test

Lints and fixes files

npm run lint

Beautify files

npm run format

Deploy to GitHub Pages

This application is deployed to GitHub Pages using the Deploy to GitHub Pages GitHub Action.

This action is triggered by a push to the master branch, and is defined in the .github/workflows/vue-deploy-github-pages.yml file.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

Acknowledgements

Contributing

To contribute to this application, follow these steps:

  1. Fork this repository.
  2. Read the CONTRIBUTING file.
  3. Create a branch: git checkout -b <branch_name>.
  4. Make your changes and commit them: git commit -m '<commit_message>'
  5. Push to the original branch: git push origin <project_name>/<location>
  6. Create the pull request.

Changelog

Please see CHANGELOG for more information on what has changed recently.