Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/harvic3/sspe-project-api

API for CLI web interface of sspe-project
https://github.com/harvic3/sspe-project-api

Last synced: about 1 month ago
JSON representation

API for CLI web interface of sspe-project

Host: GitHub
URL: https://github.com/harvic3/sspe-project-api
Owner: harvic3
Created: 2019-08-04T01:55:14.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-09-14T09:49:00.000Z (2 months ago)
Last Synced: 2024-09-14T20:30:18.994Z (about 2 months ago)
Language: JavaScript
Homepage: https://sspe-project-api.vickodev.now.sh
Size: 770 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

# 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.

```console
$ 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:

```console
npm install
```

```console
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

```console
npm run test
```

## Usage

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

- Get help

```console
sspe hi
```

- Run process with example file

```console
sspe showme
```

- Create a file with seven-segments format

```console
sspe create --name theFileName --number 654123
```

- List the created files

```console
sspe list
```

- Select a local file for process

```console
sspe select --name Foo.dat
```

- Add data for train the neural network

```console
sspe ml --add 654123 OR sspe m --add auto
```

- Training the neural network

```console
sspe ml --iter 25000 OR sspe ml
```

- Select a local file for process with Neural network

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

## File Structure