This is a work in progress.

• Introduction

• Installation

• Data sources

• Instructions

• Architecture

• Next steps

It is a project started on April 28, 2021.

To run the program and see a demo of the code, you need:

• To install the libraries below
• To download the datasets (see Data sources for information).

Follow these instructions to install the required libraries: on terminal

1. Open your terminal;
2. cd to the directory where the requirements.txt file is located;
3. Create and activate your virtual environment.
4. Run the command: pip3 install -r requirements.txt

Note that I develop the source code on macOS Big Sur

On your terminal:

1. Open your terminal;
2. cd to the directory
3. Activate your virtual environment.
4. Run the command: flask run and browse to the link provided (to run the app locally in your browser)

The project is structured as follows:

nlp-text-summarizer
│   README.md               :explains the project
│   main.py                 :script to run in order to start the program
│   requirements.txt        :packages to install to run the program
│   .gitignore              :files to ignore when pushing to the GitHub repository
│
└───app                    :directory contains all the core scripts of the app

This project is carried out by Van Frausum Derrick from Theano 2.27 promotion at BeCode.

I would like to thank:

• my colleagues and coaches at BeCode for their help and guidance.
• nicknochnack GitHub and HuggingFace community for their solutions on how to summarize long texts

• Progress in roadmap