commit from root

README.md

@@ -10,106 +10,32 @@ This repository contains the DISC-FinLLM, version of Baichuan-13B-Chat as the ba
 
 <div align="center">
   
-[Demo](https://law.fudan-disc.com) | [技术报告](https://arxiv.org/abs/2309.11325)
+[Demo](https://finllm.fudan-disc.com) | [技术报告](https://arxiv.org/abs/2309.11325)
 </div>
 
 **Please note that due to the ongoing development of the project, the model weights in this repository may differ from those in our currently deployed demo.**
 
 
-DISC-LawLLM is a large language model specialized in Chinese legal domain, developed and open-sourced by [Data Intelligence and Social Computing Lab of Fudan University  (Fudan-DISC)](http://fudan-disc.com), to provide comprehensive intelligent legal services. The advtantages is:
-* **Legal Texts Generic Processing Capability** 
-* **Legal Thinking and Reasoning** 
-* **Legal knowledge Retrieval Capacity** 
+DISC-FinLLM is a large model in the financial field specifically designed to provide users with professional, intelligent, and comprehensive **financial consulting services** in financial scenarios. It is developed by [Fudan University Data Intelligence and Social Computing Laboratory (Fudan-DISC)](http://fudan-disc.com) developed and open source. It is a multi-expert smart financial system composed of four modules for different financial scenarios: financial consulting, financial text analysis, financial calculation, and financial knowledge retrieval and question answering. These modules showed clear advantages in four evaluations including financial NLP tasks, human test questions, data analysis and current affairs analysis, proving that DISC-FinLLM can provide strong support for a wide range of financial fields. DISC-FinLLM can help in different application scenarios and can be used to implement different functions:
 
-In addition, the contributions include:
-
-* **High-quality SFT datasets and effective training paradigms**
-* **Chinese legal LLMs evaluation framework**
+* **Financial Consultation:** This module can start multiple rounds of dialogue with users on financial topics in the Chinese financial context, or explain relevant knowledge of financial majors to users. It is composed of the financial consulting instructions part of the data set.
+* **Financial Text Analysis:** This module can help users complete NLP tasks such as information extraction, sentiment analysis, text classification, and text generation on financial texts. It is trained by the financial task instructions in the data set.
+* **Financial Calculation:** This module can help users complete tasks related to mathematical calculations. In addition to basic calculations such as interest rates and growth rates, it also supports statistical analysis and includes the Black-Scholes option pricing model and the EDF expected default probability model. Financial model calculations included. This module is partially trained from the financial computing instructions in the data set.
+* **Financial Knowledge Retrieval Q&A:** This module can provide users with investment advice, current affairs analysis, and policy interpretation based on financial news, research reports, and related policy documents. It is partially trained from the retrieval-enhanced instructions in the dataset.
   
-Check our [HOME](https://github.com/FudanDISC/DISC-LawLLM) for more information. 
-
-# DISC-Law-SFT Dataset
-
-we construct a high-quality supervised fine-tuning dataset, DISC-Law-SFT with two subsets, namely DISC-Law-SFT-Pair and DISC-Law-SFT-Triplet.  Our dataset converge a range of legal tasks, including legal information extraction, judgment prediction, document summarization, and legal question answering, ensuring coverage of diverse scenarios.
-<img src="" alt="" width=""/>
-
-<table>
-  <tr>
-    <th>Dataset</th>
-    <th>Task/Source</th>
-    <th>Size</th>
-    <th>Scenario</th>
-  </tr>
-  <tr>
-    <td rowspan="10">DISC-LawLLM-SFT-Pair</td>
-    <td>Legal information extraction</td>
-    <td>32K</td>
-    <td rowspan="7">Legal professional assistant</td>
-  </tr>
-  <tr>
-    <td>Legal event detection</td>
-    <td>27K</td>
-  </tr>
-  <tr>
-    <td>Legal case classification</td>
-    <td>20K</td>
-  </tr>
-  <tr>
-    <td>Legal judgement prediction</td>
-    <td>11K</td>
-  </tr>
-  <tr>
-    <td>Legal case matching</td>
-    <td>8K</td>
-  </tr>
-  <tr>
-    <td>Legal text summarization</td>
-    <td>9K</td>
-  </tr>
-  <tr>
-    <td>Judicial public opinion summarization</td>
-    <td>6K</td>
-  </tr>
-  <tr>
-    <td>Legal question answering</td>
-    <td>93K</td>
-    <td>Legal consultation services</td>
-  </tr>
-  <tr>
-    <td>Legal reading comprehension</td>
-    <td>38K</td>
-    <td rowspan="2">Judicial examination assistant</td>
-  </tr>
-  <tr>
-    <td>Judicial examination</td>
-    <td>12K</td>
-  </tr>
-  <tr>
-    <td rowspan="2">DISC-LawLLM-SFT-Triple</td>
-    <td>Legal judgement prediction</td>
-    <td>16K</td>
-    <td>Legal professional assistant</td>
-  </tr>
-  <tr>
-    <td>Legal question answering</td>
-    <td>23K</td>
-    <td>Legal consultation services</td>
-  </tr>
-  <tr>
-    <td rowspan="2">General</td>
-    <td>Alpaca-GPT4</td>
-    <td>48K</td>
-    <td rowspan="2">General scenarios</td>
-  </tr>
-  <tr>
-    <td>Firefly</td>
-    <td>60K</td>
-  </tr>
-  <tr>
-    <td>Total</td>
-    <td colspan="3">403K</td>
-  </tr>
-</table>
+Check our [HOME](https://github.com/FudanDISC/DISC-FinLLM) for more information. 
+
+# DISC-Fin-SFT Dataset
+
+DISC-FinLLM is a large financial model based on the high-quality financial data set DISC-Fin-SFT. We construct and fine-tuned the LoRA instruction on the general-domain Chinese large model Baichuan-13B-Chat. DISC-Fin-SFT contains a total of about 250,000 pieces of data, divided into four sub-data sets, which are financial consulting instructions, financial task instructions, financial computing instructions, and retrieval-enhanced instructions.
+
+| Dataset | Samples | Input Length | Output Length  |
+|----------------:|----------------:|------------------------------------------------------------:|-----------------------------------------------------------:|
+|    Financial Consulting Instructions |             63k |                                                          26 |                                                        369 |
+|    Financial Task Instructions |            110k |                                                         676 |                                                         35 |
+|    Financial Computing Instructions |             57k |                                                          73 |                                                        190 |
+|    Retrieval-enhanced Instructions |             20k |                                                        1031 |                                                        521 |
+|    DISC-Fin-SFT |            246k |                                                         351 |                                                        198 |
 
 # Using through hugging face transformers
 
@@ -117,27 +43,27 @@ we construct a high-quality supervised fine-tuning dataset, DISC-Law-SFT with tw
 >>>import torch
 >>>>>>from transformers import AutoModelForCausalLM, AutoTokenizer
 >>>from transformers.generation.utils import GenerationConfig
->>>tokenizer = AutoTokenizer.from_pretrained("ShengbinYue/DISC-LawLLM", use_fast=False, trust_remote_code=True)
->>>model = AutoModelForCausalLM.from_pretrained("ShengbinYue/DISC-LawLLM", device_map="auto", torch_dtype=torch.float16, trust_remote_code=True)
->>>model.generation_config = GenerationConfig.from_pretrained("ShengbinYue/DISC-LawLLM")
+>>>tokenizer = AutoTokenizer.from_pretrained("Go4miii/DISC-FinLLM", use_fast=False, trust_remote_code=True)
+>>>model = AutoModelForCausalLM.from_pretrained("Go4miii/DISC-FinLLM", device_map="auto", torch_dtype=torch.float16, trust_remote_code=True)
+>>>model.generation_config = GenerationConfig.from_pretrained("Go4miii/DISC-FinLLM")
 >>>messages = []
->>>messages.append({"role": "user", "content": "生产销售假冒伪劣商品罪如何判刑？"})
+>>>messages.append({"role": "user", "content": "请解释一下什么是银行不良资产？"})
 >>>response = model.chat(tokenizer, messages)
 >>>print(response)
 ```
 
-# Disclaimer
+## Disclaimer
 
-DISC-LawLLM comes with issues and limitations that current LLMs have yet to overcome. While it can provide Chinese legal services in many a wide variety of tasks and scenarios, the model should be used for reference purposes only and cannot replace professional lawyers and legal experts. We encourage users of DISC-LawLLM to evaluate the model critically. We do not take responsibility for any issues, risks, or adverse consequences that may arise from the use of DISC-LawLLM.
+DISC-FinLLM has problems and shortcomings that cannot be overcome by current large language models. Although it can provide services in the financial field on many tasks and scenarios, the model should be used for user reference only and cannot replace professional financial analysts and financial experts. , we hope that users of DISC-FinLLM will evaluate the model with a critical eye. We are not responsible for any problems, risks or adverse consequences arising from the use of DISC-FinLLM.
 
-# Citation
+## Citation
 
-If our work is helpful for your, please kindly cite our work as follows:
+If our project has been helpful for your research and work, please kindly cite our work as follows:
 
 ```
 @misc{yue2023disclawllm,
     title={DISC-LawLLM: Fine-tuning Large Language Models for Intelligent Legal Services}, 
-    author={Shengbin Yue and Wei Chen and Siyuan Wang and Bingxuan Li and Chenchen Shen and Shujun Liu and Yuxuan Zhou and Yao Xiao and Song Yun and Wei Lin and Xuanjing Huang and Zhongyu Wei},
+    author={Shengbin Yue and Wei Chen and Siyuan Wang and Bingxuan Li and Chenchen Shen and Shujun Liu and Yuxuan Zhou and Yao Xiao and Song Yun and Xuanjing Huang and Zhongyu Wei},
     year={2023},
     eprint={2309.11325},
     archivePrefix={arXiv},
@@ -145,6 +71,6 @@ If our work is helpful for your, please kindly cite our work as follows:
 }
 ```
 
-# License
+## License
 
 The use of the source code in this repository complies with the Apache 2.0 License.