Giter Club home page Giter Club logo

gsoc2019-text-extraction's Introduction

โ˜€๏ธ Google Summer of Code 2019 - Development of a Tool for Extracting Quantitative Text Profiles

About the project

Text analysis is a fascinating field that attracts people from many scientific fields. As of today, text analysis is executed through powerful scripts, scattered to many packages and libraries of different programming languages, each of which contains only a subset of available linguistic features and requires high technical knowledge to be operated. As a result, it is difficult to obtain a unified result, with all the desired features and many people, who lack a computer science background, are excluded from using them.

The goal of the project is to build a desktop GUI, that provides its users with an easy way to extract quantitative text profiles from multilingual texts. The text analysis will come from scripts that combine many existing NLP packages, written in R. The tool is going to be modular and open source, in order to be easily accessible and adaptable to everyone's needs. The project is going to boost and facilitate scientific research in NLP fields, as it will make text analysis available to people with little to none computer science knowledge, such as linguistics students.

This project is one of the projects that got accepted for the 2019 session of the Google Summer of Code. The final report, which includes a summary of the work that was done during the program, can be found here.

Project Timeline

The timeline of the development must comply with the official GSoC timeline and is the following:

  • Community Bonding (May 6 - May 26)

    • Meet with my mentors and discuss about the project's architecture and implementation details.
    • Get familiar with the tools and packages that are going to be used.
  • Coding - 1st Phase (May 27 - June 28)

    • Choose the necessary NLP packages and functions based on their usability and accuracy.
    • Code the NLP scripts, using already implemented functions and ensure their compatibility.
    • Design GUI's layout and implement a simple, prototype GUI to test the above scripts.
  • Coding - 2nd Phase (June 29 - July 26)

    • Design the database.
    • Develop a REST API for frontend - backend communication.
    • Continue working on GUI.
  • Coding - 3rd Phase (July 27 - August 26)

    • Add export and visualization options.
    • Test the application with real users and adapt to the feedback

Execution

Instructions on how to install and operate the application can be found at the relevant wiki page.

To run the application in development mode, firstly install the necessary npm package, by executing

npm install at the project's directory. Then run with

npm run electron-dev

This will run reactJS on port 3000, but instead of opening it in a browser, an electron window will open, hosting is.

Demo

The performance of the processing is good enough, although there are many changes that can be done to improve it. Below is an example of calculating all of the currently supported indices on 24 files of 10MB total size (RAM peaked at ~1800 MB). performance

Future Work

The application at the current state can be considered to be in alpha version. As such, it is expected to have many bugs and many areas for improvement. Some future enhancements that can be done are the following:

  1. Adopt Typescript
  2. Improve performance
  3. Add more indices
  4. Add workspaces
  5. Improve appearance

A full list of planned features and future work can be found here.

Contributors

gsoc2019-text-extraction's People

Contributors

fitsilisf avatar panagiotisp avatar sotirisleventis avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

gsoc2019-text-extraction's Issues

[Bug] Finished execution of scripts\initializeR.R unsuccessfully

Hello there,

I am facing a critical problem during initialization.

Here is the console log:

Main.js:285 trying URL 'http://cran.us.r-project.org/bin/windows/contrib/3.6/readtext_0.75.zip'

Main.js:285 Content type 'application/zip' length 1895251 bytes (1.8 MB)

Main.js:285 Error in read.dcf(file.path(pkgname, "DESCRIPTION"), c("Package", "Type")) :
cannot open the connection
Calls: install.packages -> .install.winbinary -> unpackPkgZip -> read.dcf
In addition: Warning messages:
1:
Main.js:285 In library(package, lib.loc = lib.loc, character.only = TRUE, logical.return = TRUE, :
there is no package called 'readtext'
2: In download.file(url, destfile, method, mode = "wb", ...) :
downloaded length 1757184 != reported length 2974210
3: In unzip(zipname, exdir = dest) : error 1 in extracting from zip file
4: In read.dcf(file.path(pkgname, "DESCRIPTION"), c("Package", "Type")) :
cannot open compressed file 'RCurl/DESCRIPTION', probable reason 'No such file or directory'

Main.js:285 Execution halted

Main.js:300 child process exited with code 1

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.