lorenzoscottb commited on
Commit
fe27499
Β·
1 Parent(s): f590687

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +7 -8
README.md CHANGED
@@ -1,17 +1,16 @@
1
  ---
2
- title: README
3
- emoji: πŸ“š
4
  colorFrom: green
5
- colorTo: yellow
6
  sdk: static
7
  pinned: false
8
  ---
9
 
10
 
11
- DReAMy is a python library to automatically analyse (for now only) textual dream reports. At the moment, annotations are exclusively based on the [Hall & Van de Castle](https://link.springer.com/chapter/10.1007/978-1-4899-0298-6_2) emotions framework, but we are looking forward to expanding our set applications. As for the theoretical backbone, DReAMy and its model are based on a fruitful collaboration between NLP and sleep research. For more details, please refer to the [pre-print](https://arxiv.org/abs/2302.14828)
 
 
12
 
13
  # Installation and usage
14
- DReAMy can be easily installed via pip, and we do recommend using a virtual environment with python 3.9 installed. If you wish to play/query a set of DReAMy's model, you can do so using the [`DReAMv.1`](https://huggingface.co/spaces/DReAMy-lib/dream) πŸ€— Space.
15
- ```
16
- pip install dreamy
17
- ```
 
1
  ---
2
+ title: DReAMy
3
+ emoji: πŸ§ πŸ˜΄πŸ“πŸ€–
4
  colorFrom: green
5
+ colorTo: green
6
  sdk: static
7
  pinned: false
8
  ---
9
 
10
 
11
+ DReAMy is an open-source toolkit to automatically analyse (for now only) textual dream reports. At the moment, annotations are exclusively based on the [Hall & Van de Castle](https://link.springer.com/chapter/10.1007/978-1-4899-0298-6_2) emotions framework, but we are looking forward to expanding our set applications. As for the theoretical backbone, DReAMy and its model are based on a fruitful collaboration between NLP and sleep research. For more details, please refer to the [Bertolini et al., 23](https://arxiv.org/abs/2302.14828) pre-print.
12
+
13
+ Here you can find the models used by DReAMy that were specifically tuned to analyse dream reports, as well as two datasets containing (non-annotated) dream reports from [DreamBank](https://www.dreambank.net/). Specialised models focus on two main tasks: sentiment analysis and character identification (i.e., NER), with both a multi-label classification and/or generation format.
14
 
15
  # Installation and usage
16
+ DReAMy can be easily installed via `pip install dreamy`. We do recommend using a virtual environment with python 3.9 installed. If you wish to play/query a set of DReAMy's model, you can do so using the two Spaces below.