sentiment3d

COMPASS Pathways three-dimensional model of sentiment

https://github.com/compasspathways/sentiment3d

Science Score: 44.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
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

COMPASS Pathways three-dimensional model of sentiment

Basic Info
  • Host: GitHub
  • Owner: compasspathways
  • License: cc-by-4.0
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 3.12 MB
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 1
  • Open Issues: 1
  • Releases: 0
Created almost 3 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Code of conduct Citation Security

README.md

COMPASS Pathways Three-dimensional Sentiment Model

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/compasspathways/SentimentDD/blob/main/.pre-commit-config.yaml) [![License: CC BY 4.0](https://img.shields.io/badge/License-CC_BY_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/) A package for computing the three-dimensional sentiment scores and a Jupyter notebook for replicating the figures in the paper "[From a Large Language Model to Three-Dimensional Sentiment](https://psyarxiv.com/kaeqy)".

Contents

The sentiment model code is in "sentiment3d" and an example that demonstrates the use of this model is in the notebook example.ipynb. To reproduce all the figures in our paper, have a look at sentiment3d_paper.ipynb. The 3d sentiment model should run on any machine with 4GB of RAM or more.

Installation

```bash

python -m pip install git+https://github.com/compasspathways/Sentiment3D ```

Contributing

Install from source and run in a virtual env:

bash git clone git@github.com:compasspathways/Sentiment3D.git cd Sentiment3D python3 -m venv venv-s3d source venv-s3d/bin/activate pip install -e ."[explore,dev]" pre-commit install

To run the notebooks:

bash python -m ipykernel install --name "venv-s3d" --user

After you start the notebook server, be sure to switch to the venv-s3d kernel.

Interactive Demo

Please check out the interactive demo on Hugging Face at https://huggingface.co/spaces/compasspathways/Sentiment3D

Citation

Please cite our paper titled "From a Large Language Model to Three-Dimensional Sentiment".

Owner

  • Name: Compass Pathways
  • Login: compasspathways
  • Kind: organization

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Clarke
    given-names: Patrick
  - family-names: Dougherty
    given-names: Robert
    orcid: https://orcid.org/0000-0002-1254-5943
  - family-names: Principato
    given-names: Cristiana
  - family-names: Staples
    given-names: Patrick
title: "COMPASS Pathways 3d Sentiment Model"
version: 1.0.0
doi: TBD
date-released: 2023-06-01

GitHub Events

Total
Last Year

Dependencies

setup.py pypi
  • codenamize *
  • kaleido *
  • numpy *
  • pandas *
  • patsy *
  • plotly *
  • scikit-learn *
  • scipy *
  • statsmodels *
  • torch *
  • transformers *
.github/workflows/production.yml actions
  • actions/checkout v3 composite
.github/workflows/pull_request.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite