StephanAkkerman commited on
Commit
6f40f19
1 Parent(s): bb9fdaf

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +27 -0
README.md CHANGED
@@ -82,5 +82,32 @@ pipe = pipeline(
82
  print(pipe("Bitcoin is a [MASK] coin."))
83
  ```
84
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
85
  ## License
86
  This project is licensed under the MIT License. See the [LICENSE](https://choosealicense.com/licenses/mit/) file for details.
 
82
  print(pipe("Bitcoin is a [MASK] coin."))
83
  ```
84
 
85
+ ## Citing & Authors
86
+
87
+ If you use FinTwitBERT or FinTwitBERT-sentiment in your research, please cite us as follows, noting that both authors contributed equally to this work:
88
+
89
+ ```
90
+ @misc{FinTwitBERT,
91
+ author = {Stephan Akkerman, Tim Koornstra},
92
+ title = {FinTwitBERT: A Specialized Language Model for Financial Tweets},
93
+ year = {2023},
94
+ publisher = {GitHub},
95
+ journal = {GitHub repository},
96
+ howpublished = {\url{https://github.com/TimKoornstra/FinTwitBERT}}
97
+ }
98
+ ```
99
+
100
+ Additionally, if you utilize the sentiment classifier, please cite:
101
+
102
+ ```
103
+ @misc{FinTwitBERT-sentiment,
104
+ author = {Stephan Akkerman, Tim Koornstra},
105
+ title = {FinTwitBERT-sentiment: A Sentiment Classifier for Financial Tweets},
106
+ year = {2023},
107
+ publisher = {Hugging Face},
108
+ howpublished = {\url{https://huggingface.co/StephanAkkerman/FinTwitBERT-sentiment}}
109
+ }
110
+ ```
111
+
112
  ## License
113
  This project is licensed under the MIT License. See the [LICENSE](https://choosealicense.com/licenses/mit/) file for details.