Code Monkey home page Code Monkey logo

konla's Introduction

KONLA

KONLA (Knowledge Organisation through Natural Language Analysis) is being developed as part of the COMP0016 Systems Engineering module at UCL. It aims to provide an effective and easy to use software solution that helps with conducting research, in particular shortening the time and effort of finding relevant research papers.

Features

  • whole text summarization
  • partial (segment) text summarization
  • extraction and display of metadata
  • keyword extraction
  • extraction and organisation of references
  • computation of text metrics (reading time, speaking time)

Documentation

  1. README
  2. Deployment Guide
  3. User Manual
  4. Docs
  5. API

Dependencies

(all are installed using Dockerfile, Docker running Ubuntu:20.04)

Tools

  • poppler-utils
  • python3
  • python3-pip
  • supervisor
  • npm
  • redis
  • nginx
  • en_core_web_trf (language model installed with spacy)

Python Libraries (described in requirements.txt)

  • PyPDF2==1.26.0
  • spacy==3.2.0
  • redis==4.1.4
  • django==4.0.2
  • requests==2.27.1
  • django-cors-headers==3.11.0
  • uwsgi==2.0.20

Running the project locally

To run the project locally, download or clone the project from the repositoy. To run, you will need to have docker installed on your machine. Navigate to the project folder, open the terminal and follow these steps to start the production server locally:

Step 1 Build the docker image

docker build -t konla .

Step 2 Run the server using the safe port 443

docker run -p 443:443 -d konla

Step 3 Open the browser and try out the app

Open your browser and navigate to https://127.0.0.1

You should see the application interface. You now can use the UI or the underlying API to analyse your research papers.

Note: Some browsers may block the website due to security issues. For example, Google Chrome may show a message "Your connection is not private", but you can still click "Advanced" and then on the label "Proceed to 127.0.0.1 (unsafe)" to use the app.

konla's People

Contributors

bartosz7 avatar hzlmy2002 avatar surajvkothari avatar

Stargazers

 avatar

Watchers

 avatar

konla's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.