Code Monkey home page Code Monkey logo

venue-accessibility-google-reviews's Introduction

Venue Accessibility with Google Reviews

This project aims to highlight the perspective of people with Reduced Mobility (RM) living in Amsterdam via analysis of public venue reviews. This is done using Natural Language Processing (NLP) techniques such as Aspect Based Sentiment Analysis and Opinion Summarisation.

It is an extension of the work carried out by L. Da Rocha Bazilio, to understand how different models are able to extract aspects in reference to accessibility with data that is noisy e.g. a mixture of topics, instead of accessibility focused only.

In addition, understanding the impact of Opinion Summarisation on the reviews about accessibility. Also, how this can make activity and journey planning for those with RM easier.

This is an example of the UI of the application that pipeline will be connected to:


Project Folder Structure

There are the following folders in the structure:

  1. data: This folder includes data for the following purposes:
    1. external: This includes data from third party sources.
    2. interim: Intermediate data that has been transformed.
    3. processed: Finalised datasets for modelling.
    4. raw: The original immutable data.
  2. datasets: This is where you should place your data for training and testing.
  3. media: This is where results of each step of the pipeline are stored as images.
  4. models:Trained and serialized models, model predictions, or model summaries
  5. notebooks: This contains the notebooks of the pipeline.
  6. reports: Generated analysis as HTML, PDF, LaTeX, etc.
    1. figures: Generated graphics and figures to be used in reporting.
  7. results: Here you will find the txt form of the results.
  8. src: Folder for all source files specific to this project
  9. scripts: Folder with example scripts for performing different tasks (could serve as usage documentation)
  10. tests Here I store all of the tests for project

Installation

  1. Clone this repository:

    git clone [email protected]:Amsterdam-Internships/Venue-Accessibility-Google-Reviews.git
  2. Install all dependencies:

    conda install environment.yml or pip install requirements.txt

Setup

In order to setup the pipeline you need to download the google test data from here and the euan's guide data here

place the google test data in the test folder and the euans dataset in the train folder.

To setup the environment please create your own .env file with a variable called $LOCAL_ENV this is where you should keep the file path of your home directory. Then you will be able to connect this to the relative paths of this repo.

E.g. $LOCAL_ENV = /Users/yourname/Venue-Accessibility-Google-Reviews

To run this pipeline run the bash script titled 'full_pipeline.sh'

How it works

The image below displays the workflow of the pipeline, these steps correspond to the folder structure of the pipeline.


Acknowledgements

This repository was created in collaboration with Amsterdam Intelligence for the City of Amsterdam. It is based on the prior work of Lizzy Da Rocha Bazilio.

venue-accessibility-google-reviews's People

Contributors

mmbc2008 avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

venue-accessibility-google-reviews's Issues

Review 2023-03-14

update readme

  • update description (can be 1 sentence)
  • update image (e.g. use general image from this post)
  • update folder structure
  • update installation (e.g. the link)

Other

  • add/update required packages (pip requirements, some conda yml, whatever). Requirements slide around here (for conda - something like conda env export > env.yml )
  • move requirements out of src
  • keep usage in mind (no need to have all args figured out right away though)
  • remove sections/content from the template that you definitely not need
  • slowly remove template content (example images, tests?)
  • ! please rename functions and arguments

Data

  • remove all data
  • possibly keep small files with sample data so people know what is expected (e.g. just a few FAKE reviews)
  • add in installation / setup section remark that you expect these files under that folder (feel free to add a remark that people can contact me or someone form the gemeente for the full dataset)
  • a warning for missing dataset before the code has crashed? :D

Random

  • metrics to plots and tables instead of prints (e.g. straight to latex
  • Iva to send set path example

Have a look at Lizzie’s code

  • Create your own environment in Visual Studio Code so that you can run your code.
  • Look at the parts of Lizzie’s code that you think is useful.

Review 2023-05-02

  • update readme with setting up and usage instructions (.env + paths + scripts + args)
  • update steps -> make_dataset -> train -> ???
  • clean up / document dataset making/cleaning - no need for the 1line functions, improve naming (e.g. select aspects?!, removing nans does more than removing nans, etc)
  • no spaces in folder/file names (in processed)

Papers to read

Look at papers from the conferences that Iva suggested

Thesis Readings

You need to start looking at academic papers from conferences related to disability access to venues and NLP.

Clean Up Repo

Make the edits to your GitHub repo that Iva suggested.

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.