regrets

Regrets Data Collection Tool

https://github.com/algorithmic-alignment-lab/regrets

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.5%) to scientific vocabulary
Last synced: 8 months ago · JSON representation ·

Repository

Regrets Data Collection Tool

Basic Info
  • Host: GitHub
  • Owner: Algorithmic-Alignment-Lab
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 30.3 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme Contributing License Citation

README.md

DOI

Regrets Data Collection Tool

Users' decisions in recommendation systems are prone to be similar in similar decision frames. Even after watching a video, a socially engineered interface may make them signal their like of content that they do not like. RegretBlocker deletes content that users state they regret outside of a platform. This data collection tool can be run and deployed on any server capable of running docker. We provide installation instructions and our data collection tool. We provide learning tools for your personal RegretBlocker in the future.

Table of Contents

  1. Installation
  2. Usage
  3. Project Structure
  4. Contact

Installation

  1. Clone the repository: git clone https://github.com/Algorithmic-Personalization/Regret-Blocker.git
  2. Navigate to the project directory: cd Regret-Blocker
  3. Install Docker Compose
  4. Install dependencies: pip install -r requirements.txt
  5. Fill

Usage

To start the application, run: bash docker-compose up -d # start the docker image in the background docker-compose exec flask db init # Initialize a new database schema docker-compose exec flask db migrate -m "Initial migration" # Apply the migration to the database flask db upgrade docker-compose restart Then, the application should be accessible under http://127.0.0.1:5001/upload?uid=userid for any `userid`.

Project Structure

app/ contains the main application logic. - migrations/: Database migration files. - static/: contains css and js files - templates/: contains html templates - uploads/: stores uploaded data for regrets - utils/: Utility functions.

Contact

For questions or support, contact haupt@csail.mit.edu.

Owner

  • Name: Algorithmic Alignment Group
  • Login: Algorithmic-Alignment-Lab
  • Kind: organization
  • Location: United States of America

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 0.9.0
title: Regret Data Collection Tool
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Andreas
    family-names: Haupt
    email: haupt@mit.edu
    affiliation: M.I.T.
    orcid: 'https://orcid.org/0000-0002-2952-4188'
  - given-names: Mihaela
    family-names: Curmei
    email: mcurmei@berkeley.edu
    affiliation: UC-Berkeley
repository-code: >-
  https://github.com/Algorithmic-Personalization/Regrets
abstract: >-
  Users' decisions in recommendation systems are prone to be
  similar in similar decision frames. Even after watching a
  video, a socially engineered interface may make them
  signal their like of content that they do not like.
  The regret data collection tool allows to elicit what 
  users regret having consumed.
keywords:
  - social media
  - regret
  - behavioral engineering
license: MIT
commit: ' 1af8ca4'
version: '0.9'
date-released: '2024-09-16'

GitHub Events

Total
  • Issues event: 2
  • Watch event: 1
  • Issue comment event: 1
Last Year
  • Issues event: 2
  • Watch event: 1
  • Issue comment event: 1

Dependencies

app/Dockerfile docker
  • python 3.12 build
app/docker-compose.yml docker
  • postgres 14
  • redis alpine
app/requirements.txt pypi
  • Flask-Session *
  • PyYAML *
  • debugpy *
  • flask *
  • flask_migrate *
  • flask_sqlalchemy *
  • google-api-python-client *
  • gunicorn *
  • isodate *
  • pandas *
  • psycopg2-binary *
  • python-dotenv *
  • redis *
  • setuptools *
  • sqlalchemy *
  • uuid *
  • werkzeug *