A simple summarization tool developed in collaboration with @chinhong11, @ChunKeatTan, and @yuanqinong for subject TNL3221 Natural Language Processing
- Download the ZIP of this repository and extract the zipped folder to Summer.
- Open the Summer-Backend folder with Visual Studio Code.
- Make sure you have Python < 3.10 installed on your computer. If you do not have Python installed on your computer, we recommend getting Python 3.9.10 from here.
- Run command
python -m venv env-name, whereenv-namecan be any name for your Python environment. - Activate the environment by creating a new
Command Promptterminal. You can make sure your environment is activated by observing the(env-name)at the terminal. - Run command
pip install -r requirements.txtto install all dependencies for the server backend. This could take up to 10 minutes depending on your network condition. - Navigate to the summer folder in the Summer-Backend folder with
cd summer. - Open
views.pyinsummarizationfolder, replace the model path with your model path. - Start the Django server with command
python manage.py runserver.
The Summer webpage can be launched with two ways.
- (Recommended) Open the Summer-Frontend folder with Visual Studio Code and start the live server for the Summer webpage frontend. The Live Server extension can be installed in Visual Studio Code.
- Navigate to the Summer-Frontend folder and open the
index.htmlfile directly from the file explorer.
The Summer extension is a simplified version of the Summer webpage, providing only the summarization function for users' browsing sessions.
- On your chromium-based browser, open the
Manage Extensionspage. - Enable
Developer mode, then selectLoad unpackedand select the Summer-Extension folder. Remember to switch offDeveloper modeafter this step.