molokhovdmitry commited on
Commit
5aae3b2
1 Parent(s): edbee8b

Update README

Browse files
Files changed (1) hide show
  1. README.md +56 -0
README.md CHANGED
@@ -1,2 +1,58 @@
1
  # social-stat
2
  API application for social network analysis.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  # social-stat
2
  API application for social network analysis.
3
+
4
+ # Endpoints
5
+ ## Get /predict/{video_id}
6
+ Returns `pandas` DataFrame with all `commentThreads` of a `YouTube` video with emotion scores estimated by [SamLowe/roberta-base-go_emotions](https://huggingface.co/SamLowe/roberta-base-go_emotions).
7
+ <details>
8
+ <summary>All DataFrame columns:</summary>
9
+
10
+ - comment_id
11
+ - video_id
12
+ - channel_id
13
+ - author_display_name
14
+ - text_original
15
+ - text_display
16
+ - published_at
17
+ - updated_at
18
+ - like_count
19
+ - can_reply
20
+ - total_reply_count
21
+ - neutral
22
+ - approval
23
+ - annoyance
24
+ - disapproval
25
+ - realization
26
+ - admiration
27
+ - disappointment
28
+ - excitement
29
+ - disgust
30
+ - confusion
31
+ - joy
32
+ - anger
33
+ - optimism
34
+ - amusement
35
+ - gratitude
36
+ - surprise
37
+ - sadness
38
+ - fear
39
+ - curiosity
40
+ - love
41
+ - embarrassment
42
+ - desire
43
+ - caring
44
+ - pride
45
+ - relief
46
+ - grief
47
+ - remorse
48
+ - nervousness
49
+
50
+ </details>
51
+
52
+ # Installation and Running
53
+ ```
54
+ git clone https://github.com/molokhovdmitry/social-stat
55
+ python -m pip install --upgrade pip
56
+ pip install -r requirements.txt
57
+ uvicorn main:app --reload
58
+ ```