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

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -1
README.md CHANGED
@@ -7,4 +7,11 @@ sdk: static
7
  pinned: false
8
  ---
9
 
10
- Edit this `README.md` markdown file to author your organization card πŸ”₯
 
 
 
 
 
 
 
 
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
+ ```