Update README.md

README.md

@@ -4,4 +4,53 @@ language:
 - en
 tags:
 - finance
----
+---
+
+
+On
+Home
+Settings
+Close popup
+Institution Logo
+Lean Library
+Lean Library is brought to you by the Utrecht University Library
+
+Contact the Utrecht University Library
+
+# FinTwitBERT
+
+FinTwitBERT is a language model specifically pre-trained on a large dataset of financial tweets. This specialized BERT model aims to capture the unique jargon and communication style found in the financial Twitter sphere, making it an ideal tool for sentiment analysis, trend prediction, and other financial NLP tasks.
+
+## Table of Contents
+- [Dataset](#dataset)
+- [Model Details](#model-details)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Training](#training)
+- [Evaluation](#evaluation)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Dataset
+FinTwitBERT is pre-trained on Taborda et al.'s [Stock Market Tweets Data](https://ieee-dataport.org/open-access/stock-market-tweets-data) consisting of 943,672 tweets, including 1,300 labeled tweets. All labeled tweets are used for evaluation of the pre-trained model, using perplexity as a measurement. The other tweets are used for pre-training with 10% being used for model validation.
+
+## Model details
+We use the [FinBERT](https://huggingface.co/ProsusAI/finbert) model and tokenizer from ProsusAI as our base. We added two masks to the tokenizer: `@USER` for user mentions and `[URL]` for URLs in tweets. The model is then pre-trained for 10 epochs using loss at the metric for the best model. We apply early stopping to prevent overfitting the model.
+
+The latest pre-trained model and tokenizer can be found here on huggingface: https://huggingface.co/StephanAkkerman/FinTwitBERT.
+
+## Installation
+```bash
+# Clone this repository
+git clone https://github.com/TimKoornstra/FinTwitBERT
+# Install required packages
+pip install -r requirements.txt
+```
+## Usage
+The model can be finetuned for specific tasks such as sentiment classification. For more information about it, you can visit our other repository: https://github.com/TimKoornstra/stock-sentiment-classifier.
+
+## Contributing
+Contributions are welcome! If you have a feature request, bug report, or proposal for code refactoring, please feel free to open an issue on GitHub. I appreciate your help in improving this project.
+
+## License
+This project is licensed under the GPL-3.0 License. See the [LICENSE](LICENSE) file for details.