Update README.md

README.md

@@ -26,7 +26,7 @@ FinanceConnect is a state-of-the-art, open-source chat model tailored for financ
 
 Drawing strength from the FinTalk-19k and Alpaca dataset, a curated collection focused on financial knowledge, this model provides insights and information related to the finance industry. For a deeper dive into the dataset, visit: [FinTalk-19k](https://huggingface.co/datasets/ceadar-ie/FinTalk-19k), [Alpaca](https://huggingface.co/datasets/tatsu-lab/alpaca)
 
-### Model Specification
+## Model Specification
 
 - **Developed by:** CeADAR Connect Group
 - **Model type:** Large Language Model
@@ -35,21 +35,16 @@ Drawing strength from the FinTalk-19k and Alpaca dataset, a curated collection f
 
 ## Key Features and Functionalities
 
-### Domain Specialization
-The FinanceConnect model is specialized in Finance conversations, serving as a resource for financial researchers, and enthusiasts.
-### Model API Accessibility
-Offers a straightforward Python integration for generating financial content insights.
-### Performance Optimisation
-Efficient performance across both CPU and GPU platforms.
-### Data Representation
-Utilises a combination of comprehensive Finance dataset, enabling content generation to professional standards.
+**Domain Specialization:** The FinanceConnect model is specialized in Finance conversations, serving as a resource for financial researchers, and enthusiasts.
+**Model API Accessibility:** Offers a straightforward Python integration for generating financial content insights.
+**Performance Optimisation:** Efficient performance across both CPU and GPU platforms.
+**Data Representation:** Utilises a combination of comprehensive Finance dataset, enabling content generation to professional standards.
 
 ## Model Usage
-
 Experience the capabilities of the FinanceConnect model through a well-structured Python interface. To kick-start your exploration, follow the steps and snippets given below:
 
-## Prerequisites
-### 1. Ensure required packages are available
+### Prerequisites
+#### 1. Ensure required packages are available
 
 ```python
 import torch
@@ -67,7 +62,7 @@ from transformers import (
 import time
 ```
 
-### 2. Initiate the model and tokenizer
+#### 2. Initiate the model and tokenizer
 
 ```python
 model_name = "ceadar-ie/FinanceConnect-13B"
@@ -75,7 +70,7 @@ tokenizer = AutoTokenizer.from_pretrained(model_name)
 model = AutoModelForCausalLM.from_pretrained(model_name, torch_dtype=torch.float16, load_in_8bit = True, device_map = "auto", trust_remote_code=True)
 ```
 
-### 3. Create a function for generating text
+#### 3. Create a function for generating text
 
 ```python
 def generate_text(input_text):
@@ -104,11 +99,10 @@ def generate_text(input_text):
 ```
 
 ## Example Evaluation and Use
-
 ### Example Prompt 1:
 List in detail ten key factors influencing the current state of the global economy.
 
-#### Generated Output:
+### Generated Output:
 The current state of the global economy is influenced by several factors, including:
 
 1. Globalization: The increasing interconnectedness of economies through trade, investment, and the movement of people.
@@ -125,10 +119,10 @@ The current state of the global economy is influenced by several factors, includ
 ### Example Prompt 2:
 Explain the concept of quantitative easing and its impact on financial markets.
 
-#### Generated Output:
+### Generated Output:
 Quantitative easing is a monetary policy tool used by central banks to stimulate economic growth and combat inflation. It involves the purchase of assets such as government bonds, mortgage-backed securities, and corporate bonds by a central bank. This increases the amount of money in circulation, lowers interest rates, and encourages banks to lend more, which can boost economic growth. However, quantitative easing can also lead to inflation if it is not implemented carefully, as it can cause prices to rise more than wages can keep up with.
-## Training Details
 
+## Training Details
 ### Training Hyperparameters
 - per_device_train_batch_size = 10
 - gradient_accumulation_steps = 4
@@ -139,20 +133,24 @@ Quantitative easing is a monetary policy tool used by central banks to stimulate
 
 ## Model Limitations
 Potential Biases: With its fine-tuning centered on financial conversations sources, inherent biases from these sources may reflect in the model's outputs.
+
 ## Licensing
 The FinanceConnect model, developed by CeADAR Connect Group, combines the licensing frameworks of Llama2, FinTalk-8k and Alpaca. Under Meta's terms, users are granted a non-exclusive, worldwide, non-transferable, royalty-free limited license for the use and modification of Llama Materials, inclusive of the Llama2 model and its associated documentation. When redistributing, the provided Agreement and a specific attribution notice must be included. In alignment with the FinTalk dataset's licensing and Alpaca dataset's licensing, the model is also distributed under the "cc-by-nc-4.0" license.
+
 ## Out-of-Scope Use
 FinanceConnect is specifically tailored for finanical discussions and knowledge. It is not optimized for:
 - General, non-AI-related conversations.
 - Domain-specific tasks outside financial tasks.
 - Direct interfacing with physical devices or applications.
+
 ## Bias, Risks, and Limitations
 - Dataset Biases: The FinTalk-19k and Alpaca dataset may contain inherent biases that influence the model's outputs.
 - Over-reliance: The model is an aid, not a replacement for human expertise. Decisions should be made with careful consideration.
 - Content Understanding: The model lacks human-like understanding and cannot judge the veracity of knowledge.
 - Language Limitations: The model's primary language is English. Performance may decrease with other languages.
 - Knowledge Cut-off: The model may not be aware of events or trends post its last training update.
-## Citation:
 
-## Contact:
+## Citation
+
+## Contact
 For any further inquiries or feedback concerning FinanceConnect, please forward your communications to ahtsham.zafar@ucd.ie