harvic3 / sspe-project-api

API for CLI web interface of sspe-project

SSPE

API for sspe-web-cli project for process text files with numbers in seven-segment format with web sockets.

This API is a version based of previous CLI sspe-project.

$ sspe showme
executing with EXAMPLE file... ✏️
File data:
 _       _   _   _       _   _   _   _       _
  |   | |_|   | |_| |_| |_  |_| |_| |_|   | |_|
  |   | |_|   |   |   |  _| |_|   | |_|   |   |

String number:
718794589819
time-process: 2.896ms

Environment

This application was made for the NodeJs runtime environment wit web sockets.

Installation

• Clone the repository
• Open your favorite terminal and go to the project root directory and Run the following commands:

npm install

npm run start

Plus -> machine learning (is experimental)

Use a neural network (LSTM) to process the text files and throw a string with the result equivalent to the number contained in seven-segment format within the file.

The neural network can be trained, you can create data for the training too and process files with the last training done.

Test

Part of the code of this application is covered by unit tests and the idea is to add the missing ones as they are finished.

• Execute tests

npm run test

Usage

For use you must download the project sspe-web-cli. developed in Vue Js.

• Get help

sspe hi

• Run process with example file

sspe showme

• Create a file with seven-segments format

sspe create --name theFileName --number 31039064

• List the created files

sspe list

• Select a local file for process

sspe select --path D:/Test/Foo.dat

• Add data for train the neural network

sspe ml --add 310390 OR sspe m --add auto

• Training the neural network

sspe ml --iter 25000 OR sspe ml

• Select a local file for process with Neural network

sspe ml --path D:/Test/Foo.txt

File Structure

root
|_src
| |__lib // Contains the business logic
| |__utils // Contains utilities to support business logic
|__test // Contains the unit tests