malmarjeh commited on
Commit
2a62d4c
1 Parent(s): 5655b29

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +164 -3
README.md CHANGED
@@ -1,3 +1,164 @@
1
- ---
2
- license: cdla-sharing-1.0
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: cdla-sharing-1.0
3
+ task_categories:
4
+ - question-answering
5
+ - table-question-answering
6
+ language:
7
+ - en
8
+ tags:
9
+ - question-answering
10
+ - llm
11
+ - chatbot
12
+ - mortgage
13
+ - loans
14
+ - conversational-ai
15
+ - generative-ai
16
+ - natural-language-understanding
17
+ - fine-tuning
18
+ pretty_name: >-
19
+ Bitext - Mortgage and Loans Tagged Training Dataset for LLM-based Virtual Assistants
20
+ size_categories:
21
+ - 10K<n<100K
22
+ ---
23
+ # Bitext - Mortgage and Loans Tagged Training Dataset for LLM-based Virtual Assistants
24
+
25
+ ## Overview
26
+
27
+ This hybrid synthetic dataset is designed to be used to fine-tune Large Language Models such as GPT, Mistral and OpenELM, and has been generated using our NLP/NLG technology and our automated Data Labeling (DAL) tools. The goal is to demonstrate how Verticalization/Domain Adaptation for the [Mortgage and Loans] sector can be easily achieved using our two-step approach to LLM Fine-Tuning. For example, if you are [ACME Bank], you can create your own customized LLM by first training a fine-tuned model using this dataset, and then further fine-tuning it with a small amount of your own data. An overview of this approach can be found at: [From General-Purpose LLMs to Verticalized Enterprise Models](https://www.bitext.com/blog/general-purpose-models-verticalized-enterprise-genai/)
28
+
29
+ The dataset has the following specifications:
30
+
31
+ - Use Case: Intent Detection
32
+ - Vertical: Mortgage and Loans
33
+ - 37 intents assigned to 8 categories
34
+ - 36778 question/answer pairs, with approximately 1000 per intent
35
+ - 2141 entity/slot types
36
+ - 10 different types of language generation tags
37
+
38
+ The categories and intents are derived from Bitext's extensive experience across various industry-specific datasets, ensuring the relevance and applicability across diverse contexts.
39
+
40
+ ## Dataset Token Count
41
+
42
+ The dataset contains a total of 7.73 million tokens across 'instruction' and 'response' columns. This extensive corpus is crucial for training sophisticated LLMs that can perform a variety of functions including conversational AI, question answering, and virtual assistant tasks in the mortgage and loans domain.
43
+
44
+ ## Fields of the Dataset
45
+
46
+ Each entry in the dataset comprises the following fields:
47
+
48
+ - flags: tags
49
+ - instruction: a user request from the Mortgage and Loans domain
50
+ - category: the high-level semantic category for the intent
51
+ - intent: the specific intent corresponding to the user instruction
52
+ - response: an example of an expected response from the virtual assistant
53
+
54
+ ## Categories and Intents
55
+
56
+ The dataset covers a wide range of mortgage and loans-related categories and intents, which are:
57
+
58
+ - **CONTACT**: contact_agent, customer_service, human_agent
59
+ - **FEES**: check_late_payment_fee, lock_interest_rate
60
+ - **INFORMATION_REQUEST**: borrowing_limit, check_fees, check_loans, compare_loans, estimate_loan_payment
61
+ - **LOAN_APPLICATION**: apply_for_joint_loan, apply_for_loan, consolidate_debt, reapply_for_loan
62
+ - **LOAN_APPLICATION_PROCESS**: change_application, check_application_status, closing, submit_documentation, withdraw_application
63
+ - **LOAN_MODIFICATIONS**: add_coborrower, change_due_date, extend_loan
64
+ - **PAYMENT**: check_loan_terms, check_repayment_methods, make_additional_payments, pay_off_loan, refinance_loan, request_payment_arrangement, split_payment, turn_off_recurring_payments, turn_on_recurring_payments
65
+ - **PERSONAL_INFORMATION**: change_personal_data, change_preferred_bank_account, check_credit_report, check_credit_score, check_loan_details, check_privacy_policy
66
+
67
+ ## Entities
68
+
69
+ The entities covered by the dataset include:
70
+
71
+ - **{{Customer Support Phone Number}}**, **{{Company Website URL}}**, common with all intents.
72
+ - **{{Email Address}}**, **{{Name}}**, common with most intents.
73
+ - **{{Payment Settings}}**, featured in intents like request_payment_arrangement, change_preferred_bank_account.
74
+ - **{{Billing Preferences}}**, relevant to intents such as turn_on_recurring_payments, turn_off_recurring_payments, split_payment.
75
+ - **{{Payment Options}}**, associated with intents like make_additional_payments,check_repayment_methods.
76
+ - **{{Account Settings}}**, important for intents including change_personal_data, submit_documentation.
77
+ - **{{Application ID}}**, typically present in intents such as change_application, withdraw_application.
78
+ - **{{Loan Account Number}}**, featured in intents like extend_loan, add_coborrower.
79
+ - **{{Loan Details}}**, relevant to intents such as extend_loan, check_loan_details.
80
+ - **{{Application Status}}**, associated with intents like change_application, check_application_status.
81
+ - **{{Interest Rates}}**, important for intents including compare_loans, check_loan_terms.
82
+
83
+ This comprehensive list of entities ensures that the dataset is well-equipped to train models that are highly adept at understanding and processing a wide range of mortgage and loans-related queries and tasks.
84
+
85
+ ## Language Generation Tags
86
+
87
+ The dataset includes tags indicative of various language variations and styles adapted for Mortgage and Loans, enhancing the robustness and versatility of models trained on this data. These tags categorize the utterances into different registers such as colloquial, formal, or containing specific mortgage and loans jargon, ensuring that the trained models can understand and generate a range of conversational styles appropriate for different customer interactions in the mortgage and loans sector.
88
+
89
+ ## Language Generation Tags
90
+
91
+ The dataset includes tags that reflect various language variations and styles, crucial for creating adaptable and responsive conversational AI models within the mortgage and loans sector. These tags help in understanding and generating appropriate responses based on the linguistic context and user interaction style.
92
+
93
+ ### Tags for Lexical variation
94
+
95
+ - **M - Morphological variation**: Adjusts for inflectional and derivational forms in mortgage and loans terminology.
96
+ - Example: "is my account active", "is my account activated"
97
+ - **L - Semantic variations**: Handles synonyms, use of hyphens, compounding common in mortgage and loans communications.
98
+ - Example: “what's my balance date", “what's my billing date”
99
+
100
+ ### Tags for Syntactic structure variation
101
+
102
+ - **B - Basic syntactic structure**: Simple, direct commands or statements.
103
+ - Example: "activate my card", "I need to check my balance"
104
+ - **I - Interrogative structure**: Structuring sentences in the form of questions.
105
+ - Example: “can you show my balance?”, “how do I transfer money?”
106
+ - **C - Coordinated syntactic structure**: Complex sentences coordinating multiple ideas or tasks.
107
+ - Example: “I want to transfer money and check my balance, what should I do?”
108
+ - **N - Negation**: Expressing denial or contradiction.
109
+ - Example: "I do not wish to proceed with this transaction, how can I stop it?"
110
+
111
+ ### Tags for language register variations
112
+
113
+ - **P - Politeness variation**: Polite forms often used in customer service.
114
+ - Example: “could you please help me check my account balance?”
115
+ - **Q - Colloquial variation**: Informal language that might be used in casual customer interactions.
116
+ - Example: "can u tell me my balance?"
117
+ - **W - Offensive language**: Handling potentially offensive language which might occasionally appear in frustrated customer interactions.
118
+ - Example: “I’m upset with these charges, this is ridiculous!”
119
+
120
+ ### Tags for stylistic variations
121
+
122
+ - **K - Keyword mode**: Responses focused on keywords relevant to mortgage and loans tasks.
123
+ - Example: "balance check", "account status"
124
+ - **E - Use of abbreviations**: Common abbreviations in the context of mortgage and loans.
125
+ - Example: “acct for account”, “trans for transaction”
126
+ - **Z - Errors and Typos**: Includes common misspellings or typographical errors found in customer inputs.
127
+ - Example: “how can I chek my balance”
128
+
129
+ ### Other tags not in use in this Dataset
130
+
131
+ - **D - Indirect speech**: Expressing commands or requests indirectly.
132
+ - Example: “I was wondering if you could show me my last transaction.”
133
+ - **G - Regional variations**: Adjustments for regional language differences.
134
+ - Example: American vs British English: "checking account" vs "current account"
135
+ - **R - Respect structures - Language-dependent variations**: Formality levels appropriate in different languages.
136
+ - Example: Using “vous” in French for formal addressing instead of “tu.”
137
+ - **Y - Code switching**: Switching between languages or dialects within the same conversation.
138
+ - Example: “Can you help me with my cuenta, please?”
139
+
140
+ These tags not only aid in training models for a wide range of customer interactions but also ensure that the models are culturally and linguistically sensitive, enhancing the customer experience in mortgage and loans environments.
141
+
142
+ ## License
143
+
144
+ The `Bitext-mortgage-loans-llm-chatbot-training-dataset` is released under the **Community Data License Agreement (CDLA) Sharing 1.0**. This license facilitates broad sharing and collaboration while ensuring that the freedom to use, share, modify, and utilize the data remains intact for all users.
145
+
146
+ ### Key Aspects of CDLA-Sharing 1.0
147
+
148
+ - **Attribution and ShareAlike**: Users must attribute the dataset and continue to share derivatives under the same license.
149
+ - **Non-Exclusivity**: The license is non-exclusive, allowing multiple users to utilize the data simultaneously.
150
+ - **Irrevocability**: Except in cases of material non-compliance, rights under this license are irrevocable.
151
+ - **No Warranty**: The dataset is provided without warranties regarding its accuracy, completeness, or fitness for a particular purpose.
152
+ - **Limitation of Liability**: Both users and data providers limit their liability for damages arising from the use of the dataset.
153
+
154
+ ### Usage Under CDLA-Sharing 1.0
155
+
156
+ By using the `Bitext-mortgage-loans-llm-chatbot-training-dataset`, you agree to adhere to the terms set forth in the CDLA-Sharing 1.0. It is essential to ensure that any publications or distributions of the data, or derivatives thereof, maintain attribution to the original data providers and are distributed under the same or compatible terms of this agreement.
157
+
158
+ For a detailed understanding of the license, refer to the [official CDLA-Sharing 1.0 documentation](https://cdla.dev/sharing-1-0/).
159
+
160
+ This license supports the open sharing and collaborative improvement of datasets within the AI and data science community, making it particularly suited for projects aimed at developing and enhancing AI technologies in the mortgage and loans sector.
161
+
162
+ ---
163
+
164
+ (c) Bitext Innovations, 2024