rescuebox-flaskml-0.1.0

This is a repo to consolidate the code from various FlaskML based RescueBox projects that we plan on releasing as 0.1.0

https://github.com/umass-rescue/rescuebox-flaskml-0.1.0

Science Score: 31.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
○
.zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (17.0%) to scientific vocabulary

Last synced: 10 months ago · JSON representation ·

Repository

This is a repo to consolidate the code from various FlaskML based RescueBox projects that we plan on releasing as 0.1.0

Basic Info

Host: GitHub
Owner: UMass-Rescue
License: gpl-3.0
Language: C++
Default Branch: main
Size: 109 MB

Statistics

Stars: 0
Watchers: 1
Forks: 0
Open Issues: 15
Releases: 0

Created over 1 year ago · Last pushed over 1 year ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation

RescueBox Desktop

RescueBox Desktop (RBox) is a self-contained binary offering a UI interface to a library of ML models for various forensic applications. To use RescueBox Desktop, start up a model application in the background adhering to the FlaskML interface.

Then, register the model application's IP Host address and port. You can now run the model by specifying its inputs on the UI and analyzing outputs when ready. RBox handles the rest: running the jobs, and interfacing with different ML models. Since RBox is aimed toward forensic analysts, it is designed to operate on local, or drive-mounted storage.

For a review of the project's goals, read What is RescueBox Desktop?. For a view into how RBox-Desktop works, read the architecture section.

Getting Started

Step 1: Download the Latest Release for Windows 10 or 11 Only deployment.

Get the latest release of the binary for your operating system (Windows) from the release page. For Linux, see Additional Instructions for Linux.

Step 2: Deploy the RescueBox Download

Double click the RescueBox-Desktop Setup 1.0.exe. The first input is the install directory. choose any path that exists and has at least 5 GB of free space. The time taken to unzip the files and put them in the install directory is a few minutes. Continue to run the Desktop when prompted. This proces now setups a Python local to RescueBox and starts up the Model Severs . This takes several minutes. It also downloads python modules from internet connection. After Model servers are started the progress bar of the install reaches completion and now the Application is ready to use.

Run the model application, which should provide you with a URL to register with RBox.

Step 3: Using the App

Launch the binary you downloaded in step 1, and register the model application.

You should now be able to see the model application in the app, and be able to run inference tasks on it!

Logs:

the UI shows the logs in reverse order ie: more recent messages first. Files are located here : C:\Users<USERNAME>\AppData\Roaming\RescueBox-Desktop\logs

Troubleshooting:

First look at the eror in the task execution result or the log in the UI.
Typical errors are due to : image /video /audio files not readable , perhaps due to unsupported format.
Other errors are due to not able to read from the input path or write to output path.
rb_py.log tracks pip and pienv cmdlines , about dependencies for model code.
main.log is the overall rescuebox UI and Model server logs
other logs are from python installer.

Development

RescueBox Desktop is built using Electron, React, TypeScript, TailwindCSS, and SQlite (with Sequelize).

RescueBox implments the "Flask-ML" protocol, which is a simple interface for running ML models. See Flask-ML Protocol.

Developer Prerequisites

Node v18 (newer versions may work)

Developer Install

Clone the repo and install dependencies:

bash git clone https://github.com/UMass-Rescue/RescueBox-Desktop.git cd RescueBox-Desktop npm install

Having issues installing? See this debugging guide

Starting Development

Start the app in the dev environment:

bash npm start

Packaging for Production

To package apps for the local platform:

bash npm run package

Docs

See electron-react's docs and guides here

Owner

Name: UMass Rescue
Login: UMass-Rescue
Kind: organization

Repositories: 27
Profile: https://github.com/UMass-Rescue

Citation (CITATION.md)

Facial Recognition
If you use deepfake ImageViewer in your research for facial recogntion purposes, please cite these publications:
```
@article{serengil2024lightface,
  title         = {A Benchmark of Facial Recognition Pipelines and Co-Usability Performances of Modules},
  author        = {Serengil, Sefik Ilkin and Ozpinar, Alper},
  journal       = {Bilisim Teknolojileri Dergisi},
  volume        = {17},
  number        = {2},
  pages         = {95-107},
  year          = {2024},
  doi           = {10.17671/gazibtd.1399077},
  url           = {https://dergipark.org.tr/en/pub/gazibtd/issue/84331/1399077},
  publisher     = {Gazi University}
}
```
```
@inproceedings{serengil2020lightface,
  title        = {LightFace: A Hybrid Deep Face Recognition Framework},
  author       = {Serengil, Sefik Ilkin and Ozpinar, Alper},
  booktitle    = {2020 Innovations in Intelligent Systems and Applications Conference (ASYU)},
  pages        = {23-27},
  year         = {2020},
  doi          = {10.1109/ASYU50717.2020.9259802},
  url          = {https://ieeexplore.ieee.org/document/9259802},
  organization = {IEEE}
}
```
```
@inproceedings{serengil2021lightface,
  title        = {HyperExtended LightFace: A Facial Attribute Analysis Framework},
  author       = {Serengil, Sefik Ilkin and Ozpinar, Alper},
  booktitle    = {2021 International Conference on Engineering and Emerging Technologies (ICEET)},
  pages        = {1-4},
  year         = {2021},
  doi          = {10.1109/ICEET53442.2021.9659697},
  url          = {https://ieeexplore.ieee.org/document/9659697/},
  organization = {IEEE}
}
```
```
@misc{serengil2023db,
  title         = {An evaluation of sql and nosql databases for facial recognition pipelines},
  author        = {Serengil, Sefik Ilkin and Ozpinar, Alper},
  year          = {2023},
  archivePrefix = {Cambridge Open Engage},
  doi           = {10.33774/coe-2023-18rcn},
  url           = {https://www.cambridge.org/engage/coe/article-details/63f3e5541d2d184063d4f569}
}
```
```
@InProceedings{Lanzino_2024_CVPR,
    author    = {Lanzino, Romeo and Fontana, Federico and Diko, Anxhelo and Marini, Marco Raoul and Cinque, Luigi},
    title     = {Faster Than Lies: Real-time Deepfake Detection using Binary Neural Networks},
    booktitle = {Proceedings of the IEEE/CVF Conference on Computer Vision and Pattern Recognition (CVPR) Workshops},
    month     = {June},
    year      = {2024},
    pages     = {3771-3780}
}
```
```
@article{guo2022join,
  title={Join the High Accuracy Club on ImageNet with A Binary Neural Network Ticket},
  author={Guo, Nianhui and Bethge, Joseph and Meinel, Christoph and Yang, Haojin},
  journal={arXiv preprint arXiv:2211.12933},
  year={2022}
}
```

GitHub Events

Total

Issues event: 23
Delete event: 16
Issue comment event: 16
Member event: 2
Push event: 54
Pull request review event: 8
Pull request event: 37
Create event: 22

Last Year

Issues event: 23
Delete event: 16
Issue comment event: 16
Member event: 2
Push event: 54
Pull request review event: 8
Pull request event: 37
Create event: 22

Issues and Pull Requests

Last synced: 10 months ago

All Time

Total issues: 6
Total pull requests: 13
Average time to close issues: 22 days
Average time to close pull requests: 2 days
Total issue authors: 2
Total pull request authors: 2
Average comments per issue: 0.83
Average comments per pull request: 0.15
Merged pull requests: 5
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 6
Pull requests: 13
Average time to close issues: 22 days
Average time to close pull requests: 2 days
Issue authors: 2
Pull request authors: 2
Average comments per issue: 0.83
Average comments per pull request: 0.15
Merged pull requests: 5
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

sahilx13 (14)
nb950 (1)

Pull Request Authors

nb950 (14)
sahilx13 (4)

Top Labels

Issue Labels

Pull Request Labels

Dependencies

build_files/requirements.txt pypi

cmake *
flask-ml *
psutil *

plugin_apps/DeepFakeDetector/image_model/Pipfile pypi

einops *
flask-ml *
fvcore *
lightning *
matplotlib *
opencv-python *
pandas *
pyarrow *
pyinstaller *
retina-face *
scikit-image *
scikit-learn *
scipy *
tf-keras *
timm *
torch *
torchinfo *
torchmetrics *
torchvision *

plugin_apps/DeepFakeDetector/image_model/Pipfile.lock pypi

123 dependencies

plugin_apps/DeepFakeDetector/image_model/binary_deepfake_detection/requirements.txt pypi

einops *
flask-ml *
fvcore *
lightning *
matplotlib *
opencv-python *
pandas *
pyarrow *
retina-face *
scikit-image *
scikit-learn *
scipy *
tf-keras *
timm *
torch *
torchinfo *
torchmetrics *
torchvision *

plugin_apps/DeepFakeDetector/video_detector/Pipfile pypi

absl-py ==2.1.0
annotated-types ==0.7.0
argcomplete ==3.5.1
astor ==0.8.1
black ==24.10.0
blinker ==1.8.2
certifi ==2024.8.30
cffi ==1.17.1
charset-normalizer ==3.4.0
click ==8.1.7
cmake ==3.30.5
datamodel-code-generator ==0.26.2
dlib ==19.24.6
dnspython ==2.7.0
email-validator ==2.2.0
face-recognition ==1.3.0
face-recognition-models ==0.3.0
ffmpy ==0.4.0
filelock ==3.16.1
flask ==3.0.3
flask-ml ==0.2.5
fsspec ==2024.10.0
gast ==0.6.0
genson ==1.3.0
grpcio ==1.67.1
h5py ==3.12.1
idna ==3.10
inflect ==5.6.2
isort ==5.13.2
itsdangerous ==2.2.0
jinja2 ==3.1.4
keras ==3.6.0
markdown ==3.7
markdown-it-py ==3.0.0
markupsafe ==3.0.2
mdurl ==0.1.2
ml-dtypes ==0.5.0
mpmath ==1.3.0
munch ==4.0.0
mypy-extensions ==1.0.0
namex ==0.0.8
networkx ==3.4.2
numpy ==2.1.3
nvidia-ml-py3 ==7.352.0
olefile ==0.47
opencv-python ==4.10.0.84
optree ==0.13.0
packaging ==24.1
pandas ==2.2.3
pathspec ==0.12.1
pillow ==11.0.0
platformdirs ==4.3.6
pretrainedmodels ==0.7.4
protobuf ==5.28.3
pycparser ==2.22
pydantic ==2.9.2
pydantic-core ==2.23.4
pygments ==2.18.0
pyinstaller *
pyyaml ==6.0.2
requests ==2.32.3
rich ==13.9.4
scandir ==1.10.0
six ==1.16.0
sympy ==1.13.1
termcolor ==2.5.0
torch ==2.5.1
torchvision ==0.20.1
tqdm ==4.66.6
typing-extensions ==4.12.2
urllib3 ==2.2.3
werkzeug ==3.1.1

plugin_apps/DeepFakeDetector/video_detector/Pipfile.lock pypi

absl-py ==2.1.0
altgraph ==0.17.4
annotated-types ==0.7.0
argcomplete ==3.5.1
astor ==0.8.1
black ==24.10.0
blinker ==1.8.2
certifi ==2024.8.30
cffi ==1.17.1
charset-normalizer ==3.4.0
click ==8.1.7
cmake ==3.30.5
colorama ==0.4.6
datamodel-code-generator ==0.26.2
dlib ==19.24.6
dnspython ==2.7.0
email-validator ==2.2.0
face-recognition ==1.3.0
face-recognition-models ==0.3.0
ffmpy ==0.4.0
filelock ==3.16.1
flask ==3.0.3
flask-ml ==0.2.5
fsspec ==2024.10.0
gast ==0.6.0
genson ==1.3.0
grpcio ==1.67.1
h5py ==3.12.1
idna ==3.10
inflect ==5.6.2
isort ==5.13.2
itsdangerous ==2.2.0
jinja2 ==3.1.4
keras ==3.6.0
markdown ==3.7
markdown-it-py ==3.0.0
markupsafe ==3.0.2
mdurl ==0.1.2
ml-dtypes ==0.5.0
mpmath ==1.3.0
munch ==4.0.0
mypy-extensions ==1.0.0
namex ==0.0.8
networkx ==3.4.2
numpy ==2.1.3
nvidia-ml-py3 ==7.352.0
olefile ==0.47
opencv-python ==4.10.0.84
optree ==0.13.0
packaging ==24.1
pandas ==2.2.3
pathspec ==0.12.1
pefile ==2023.2.7
pillow ==11.0.0
platformdirs ==4.3.6
pretrainedmodels ==0.7.4
protobuf ==5.28.3
pycparser ==2.22
pydantic ==2.9.2
pydantic-core ==2.23.4
pygments ==2.18.0
pyinstaller ==6.11.1
pyinstaller-hooks-contrib ==2024.11
python-dateutil ==2.9.0.post0
pytz ==2024.2
pywin32-ctypes ==0.2.3
pyyaml ==6.0.2
requests ==2.32.3
rich ==13.9.4
scandir ==1.10.0
setuptools ==75.6.0
six ==1.16.0
sympy ==1.13.1
termcolor ==2.5.0
torch ==2.5.1
torchvision ==0.20.1
tqdm ==4.66.6
typing-extensions ==4.12.2
tzdata ==2024.2
urllib3 ==2.2.3
werkzeug ==3.1.1

plugin_apps/FaceMatch/Pipfile pypi

black *
cx-freeze *
deepface *
faiss-cpu *
flask-ml *
isort *
jax *
pandas *
pyinstaller *
ruff *
scikit-learn *
tf-keras *
ultralytics *

plugin_apps/FaceMatch/Pipfile.lock pypi

113 dependencies

plugin_apps/audio-transcription/audio_transcription/requirements.txt pypi

flask-ml *
whisper *

RescueBox-Desktop/package-lock.json npm

1625 dependencies

RescueBox-Desktop/package.json npm

@electron/rebuild ^3.3.0 development
@pmmmwh/react-refresh-webpack-plugin ^0.5.11 development
@radix-ui/react-icons ^1.3.0 development
@radix-ui/react-tooltip ^1.1.2 development
@svgr/webpack ^8.1.0 development
@tailwindcss/typography ^0.5.15 development
@teamsupercell/typings-for-css-modules-loader ^2.5.2 development
@testing-library/jest-dom ^6.1.3 development
@testing-library/react ^14.0.0 development
@types/jest ^29.5.5 development
@types/md5 ^2.3.5 development
@types/node ^20.6.2 development
@types/papaparse ^5.3.15 development
@types/react ^18.2.21 development
@types/react-dom ^18.2.7 development
@types/react-syntax-highlighter ^15.5.13 development
@types/react-test-renderer ^18.0.1 development
@types/sequelize ^4.28.20 development
@types/sqlite3 ^3.1.11 development
@types/uuid ^10.0.0 development
@types/webpack-bundle-analyzer ^4.6.0 development
@typescript-eslint/eslint-plugin ^6.7.0 development
@typescript-eslint/parser ^6.7.0 development
autoprefixer ^10.4.20 development
browserslist-config-erb ^0.0.3 development
chalk ^4.1.2 development
class-variance-authority ^0.7.0 development
clsx ^2.1.1 development
concurrently ^8.2.1 development
core-js ^3.32.2 development
cross-env ^7.0.3 development
css-loader ^6.8.1 development
css-minimizer-webpack-plugin ^5.0.1 development
detect-port ^1.5.1 development
electron ^31.3.0 development
electron-builder ^25.1.8 development
electron-devtools-installer ^3.2.0 development
electronmon ^2.0.2 development
eslint ^8.49.0 development
eslint-config-airbnb-base ^15.0.0 development
eslint-config-erb ^4.1.0-0 development
eslint-import-resolver-typescript ^3.6.0 development
eslint-import-resolver-webpack ^0.13.7 development
eslint-plugin-compat ^4.2.0 development
eslint-plugin-import ^2.28.1 development
eslint-plugin-jest ^27.4.0 development
eslint-plugin-jsx-a11y ^6.7.1 development
eslint-plugin-promise ^6.1.1 development
eslint-plugin-react ^7.33.2 development
eslint-plugin-react-hooks ^4.6.0 development
file-loader ^6.2.0 development
html-webpack-plugin ^5.5.3 development
identity-obj-proxy ^3.0.0 development
jest ^29.7.0 development
jest-environment-jsdom ^29.7.0 development
mini-css-extract-plugin ^2.7.6 development
postcss ^8.4.47 development
postcss-loader ^8.1.1 development
prettier ^3.0.3 development
react-refresh ^0.14.0 development
react-test-renderer ^18.2.0 development
rimraf ^5.0.1 development
sass ^1.67.0 development
sass-loader ^13.3.2 development
style-loader ^3.3.3 development
tailwind-merge ^2.5.2 development
tailwindcss ^3.4.13 development
tailwindcss-animate ^1.0.7 development
terser-webpack-plugin ^5.3.9 development
ts-jest ^29.1.1 development
ts-loader ^9.4.4 development
ts-node ^10.9.1 development
tsconfig-paths-webpack-plugin ^4.1.0 development
typescript ^5.6.3 development
url-loader ^4.1.1 development
webpack ^5.88.2 development
webpack-bundle-analyzer ^4.9.1 development
webpack-cli ^5.1.4 development
webpack-dev-server ^4.15.1 development
webpack-merge ^5.9.0 development
@electron/notarize ^2.3.2
@electron/remote ^2.1.2
@hookform/resolvers ^3.9.0
@radix-ui/react-accordion ^1.2.0
@radix-ui/react-collapsible ^1.1.1
@radix-ui/react-dialog ^1.1.1
@radix-ui/react-dropdown-menu ^2.1.2
@radix-ui/react-label ^2.1.0
@radix-ui/react-navigation-menu ^1.2.0
@radix-ui/react-select ^2.1.2
@radix-ui/react-slider ^1.2.1
@radix-ui/react-slot ^1.1.0
@tanstack/react-table ^8.20.5
bindings ^1.5.0
camelcase-keys ^9.1.3
electron-debug ^3.2.0
electron-log ^5.2.0
electron-updater ^6.1.4
lucide-react ^0.454.0
md5 ^2.3.0
papaparse ^5.4.1
pg-hstore ^2.3.4
react ^18.2.0
react-dom ^18.2.0
react-error-boundary ^4.0.13
react-focus-lock ^2.13.2
react-h5-audio-player ^3.9.3
react-hook-form ^7.53.0
react-markdown ^9.0.1
react-paginate ^8.2.0
react-player ^2.16.0
react-router-dom ^6.16.0
react-syntax-highlighter ^15.6.1
rehype-external-links ^3.0.0
remark-gfm ^4.0.0
swr ^2.2.5
ts-pattern ^5.5.0
umzug ^3.8.2
uuid ^10.0.0
yup ^1.4.0

RescueBox-Desktop/release/app/package-lock.json npm

141 dependencies

RescueBox-Desktop/release/app/package.json npm

sequelize ^6.37.3
sqlite3 ^5.1.7

plugin_apps/DeepFakeDetector/video_detector/requirements.txt pypi

Flask ==3.0.3
Jinja2 ==3.1.4
Markdown ==3.7
MarkupSafe ==3.0.2
PyYAML ==6.0.2
Pygments ==2.18.0
Werkzeug ==3.1.1
absl-py ==2.1.0
annotated-types ==0.7.0
argcomplete ==3.5.1
astor ==0.8.1
black ==24.10.0
blinker ==1.8.2
certifi ==2024.8.30
cffi ==1.17.1
charset-normalizer ==3.4.0
click ==8.1.7
cmake ==3.30.5
datamodel-code-generator ==0.26.2
dlib ==19.24.6
dnspython ==2.7.0
email_validator ==2.2.0
face-recognition ==1.3.0
face-recognition-models ==0.3.0
ffmpy ==0.4.0
filelock ==3.16.1
flask_ml ==0.2.5
fsspec ==2024.10.0
gast ==0.6.0
genson ==1.3.0
grpcio ==1.67.1
h5py ==3.12.1
idna ==3.10
inflect ==5.6.2
isort ==5.13.2
itsdangerous ==2.2.0
keras ==3.6.0
markdown-it-py ==3.0.0
mdurl ==0.1.2
ml_dtypes ==0.5.0
mpmath ==1.3.0
munch ==4.0.0
mypy-extensions ==1.0.0
namex ==0.0.8
networkx ==3.4.2
numpy ==2.1.3
nvidia-ml-py3 ==7.352.0
olefile ==0.47
opencv-python ==4.10.0.84
optree ==0.13.0
packaging ==24.1
pathlib ==1.0.1
pathspec ==0.12.1
pillow ==11.0.0
platformdirs ==4.3.6
pretrainedmodels ==0.7.4
protobuf ==5.28.3
pycparser ==2.22
pydantic ==2.9.2
pydantic_core ==2.23.4
requests ==2.32.3
rich ==13.9.4
scandir ==1.10.0
six ==1.16.0
sympy ==1.13.1
termcolor ==2.5.0
torch ==2.5.1
torchvision ==0.20.1
tqdm ==4.66.6
typing_extensions ==4.12.2
urllib3 ==2.2.3

plugin_apps/FaceMatch/requirements.txt pypi

plugin_apps/audio-transcription/Pipfile pypi

flask-ml *
openai-whisper *

plugin_apps/audio-transcription/Pipfile.lock pypi

blinker ==1.8.2
certifi ==2024.8.30
charset-normalizer ==3.3.2
click ==8.1.7
filelock ==3.15.4
flask ==3.0.3
flask-ml ==0.0.1
fsspec ==2024.9.0
idna ==3.8
itsdangerous ==2.2.0
jinja2 ==3.1.4
llvmlite ==0.43.0
markupsafe ==2.1.5
more-itertools ==10.5.0
mpmath ==1.3.0
networkx ==3.3
numba ==0.60.0
numpy ==2.0.2
nvidia-cublas-cu12 ==12.1.3.1
nvidia-cuda-cupti-cu12 ==12.1.105
nvidia-cuda-nvrtc-cu12 ==12.1.105
nvidia-cuda-runtime-cu12 ==12.1.105
nvidia-cudnn-cu12 ==8.9.2.26
nvidia-cufft-cu12 ==11.0.2.54
nvidia-curand-cu12 ==10.3.2.106
nvidia-cusolver-cu12 ==11.4.5.107
nvidia-cusparse-cu12 ==12.1.0.106
nvidia-nccl-cu12 ==2.20.5
nvidia-nvjitlink-cu12 ==12.6.68
nvidia-nvtx-cu12 ==12.1.105
openai-whisper ==20231117
regex ==2024.7.24
requests ==2.32.3
sympy ==1.13.2
tiktoken ==0.7.0
torch ==2.3.1
tqdm ==4.66.5
triton ==2.3.1
typing-extensions ==4.12.2
urllib3 ==2.2.2
werkzeug ==3.0.4

.github/workflows/build.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite