Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.6 KB

README.md

File metadata and controls

34 lines (22 loc) · 1.6 KB

Project-Amalgam

A resource Standardization Utility with a Machine Learning backend for Relevance analysis and automated Skimming

The system aims to provide alternative formatting to study material such that distractions are minimized. In extension, a lot of internal analysis has been implemented to dictate how resources are organized by metrics such as Cosine Score and Jaccard Analysis. Ease of use is a key feature thus a lot of the resource compilation is intended to be drag and drop, Copy and Pasting and Direct Uploads.

To run the demo, clone the repo. You may use the command:

git clone https://github.com/GitWahome/Project-Amalgam/edit/master

Afterwards, navigate to the project directory. You may wish to create a virtual environment within which to work but that is all up to you. Whether in a virtual env or your global environment, you will need to install several Packages to make the system work. I have generated a requirements.txt file which you can install from using the command:

pip3 install -r requirements.txt

After that, you should be able to launch the program by running the run.py file

python3 run.py

Note

The project is still a work in progress so some modules may not yet be functional. I have also automated the process of db and model creation under the run.py file hence why it is sufficient to just run it. It will automatically generate a site.db file which will save all the data.

After that, launch the system in your browser at the url:

http://127.0.0.1:5000/

Play around with the features, and to see the demo live, you may follow the youtube link below: