1 Star 0 Fork 0

chinaperrin / science-llm

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Mozi: A Scientific Large-scale Language Model

Code License Python 3.8+

墨子

Team of Beijing Institute of Technology: Tian Lan*, Tianyi Che*, Zewen Chi, Xuhao Hu and Xian-ling Mao


Catalogue:


1. Introduction: [Back to Top]

Mozi is the first large-scale language model for the scientific paper domain, such as question answering and emotional support. With the help of the large-scale language and evidence retrieval models, SciDPR, Mozi generates concise and accurate responses to users' questions about specific papers and provides emotional support for academic researchers.

We will explore more real-world application scenarios for Mozi in the future, making it a foundation model for solving various scientific tasks.


2. Running Mozi Models: [Back to Top]

2.1. Environment Installation:

To install the required environment, please run

pip install -r requirements.txt

Then install the Pytorch package with the correct cuda version, for example

pip install torch==1.13.1+cu117 -f https://download.pytorch.org/whl/torch/

2.2. Prepare Mozi Checkpoint:

The Mozi model weights (pre-trained on scientific corpus) consists of the pre-trained large-scale language and the LoRA weights.

  1. First of all, please download LLaMA-7B checkpoint and Baichuan-7B checkpoint.

  2. Then, please download the LoRA weights for these two models from:

    LoRA checkpoints Huggingface Delta Weights Address
    Baichuan-7B delta weight mozi_baichuan_7b
    LLaMA-7B delta weight mozi_llama_7b
  3. We also release the delta LoRA model weights for scientific emotional dialogue, which can be found in here. The emotional dialogue delta weights are built on Baichuan-7B model. In the future, we will directly optimize this scientific emotional dialogue instruction tuning dataset with other instruction dataset, such as paper-ground question answering and scientific information retrieval.

Now, the model parameters are all prepared.

2.3. Deploying Demo:

Upon completion of previous steps, you can run the demo locally as

./scripts/deploy.sh

# #!/bin/bash
# CUDA_VISIBLE_DEVICES=0 python deploy.py \
#     --model scillm-sft\
#     --model_path baichuan-inc/baichuan-7B\
#     --delta_model_path ../ckpt/scillm-emotional-sft/18\
#     --port 23333

This script runs the Mozi model emotional model on 23333 port and the input POST request should be like:

{
    "decoding_method": "greedy",
    "top_p": 0.7,
    "top_k": 10,
    "penalty_alpha": 0.5,
    "max_new_tokens": 128,
    "history": [
        "Human: 最近科研压力真的好大啊"
    ]
}

If you want to test the paper-ground dialog model, please replace the --delta_model_path with the corresponding model checkpoints weights that you download. For the paper-ground dialog, the input POST request should be like:

{
    "decoding_method": "greedy",
    "top_p": 0.7,
    "top_k": 10,
    "penalty_alpha": 0.5,
    "max_new_tokens": 128,
    "evidences": [
        "During the first two decades of the 21st century, the sharing and processing of vast amounts of data has become pervasive ...",
        "One way of circumventing this problem is to anonymise the data by removing, ...",
        "Given that this paper is concerned with text documents (e.g. medical records), the involved techniques are related to Natural Language Processing (NLP) ..."
    ],
    "question": "Which dataset do the author use in this paper?"
}

3. Train SciDPR model for Mozi Model: [Back to Top]

SciDPR servers the evidence retrieval component for Mozi paper-ground question answering models, which retrieves related evidences of user's queries. For model details about SciDPR model, please refer to this README.md file.


4. Train Your Own Mozi Model: [Back to Top]

Prerequisites: Before training the model, making sure the environment is properly installed and the checkpoints of LLaMA-7B and Baichuan-7B are downloaded.

4.1. Data Preparation: [Back to Top]

Declaimer: To ensure the reproducibility of our results, we have released our training dataset. The dataset must be used for research purpose only. The use of the dataset must comply with the licenses from original sources, i.e. QASPER and SciMRC. These datasets may be taken down when requested by the original authors.

Training Task Dataset Address
Scientific Pre-training Redpajama Dataset
Paper-ground Dataset QASPER QASPER-v0.3 dataset
Paper-ground Dataset SciMRC SciMRC dataset
Emotional Dataset scientific-emotional-dialog

Due to the limited computation resources, we only collect 4B tokens from Redpajama arXiv corpus for the first version of scientific pre-training, and the downloading scripts could be found in this scripts.

After downloading, put the downloaded file and unzip them under the ./data/ directory, and the directory should look like:

.
├── pretrain
│   ├── download_from_hf.py
│   ├── test
│   │   └── collect.py
│   └── train
│       ├── combine_chinese_corpus.sh
│       └── split.sh
└── sft
    ├── alpaca
    │   └── alpaca_data.json
    ├── combine.py
    ├── dolly
    │   ├── download_from_hf.py
    │   └── train.json
    ├── emotional
    │   └── train.json
    ├── processed_qasper_test_set.json
    ├── processed_scimrc_test_set.json
    ├── qasper
    │   ├── README-test.md
    │   ├── README.md
    │   ├── collect.py
    │   ├── qasper-dev-v0.3.json
    │   ├── qasper-test-and-evaluator-v0.3.tgz
    │   ├── qasper-test-v0.3.json
    │   ├── qasper-train-dev-v0.3.tgz
    │   ├── qasper-train-v0.3.json
    │   ├── qasper_dev_sft.json
    │   ├── qasper_evaluator.py
    │   ├── qasper_sft.json
    │   ├── qasper_test_sft.json
    │   ├── qasper_train_sft.json
    │   ├── qasper_yes_no_test_sft.json
    │   ├── qasper_yes_no_train_sft.json
    │   └── scillm_test.json
    ├── scimrc
    │   ├── collect.py
    │   ├── scimrc_dev_sft.json
    │   ├── scimrc_test_sft.json
    │   ├── scimrc_train_sft.json
    │   ├── scimrc_yes_no_test_sft.json
    │   ├── scimrc_yes_no_train_sft.json
    │   ├── smrc_dev.jsonl
    │   ├── smrc_test.jsonl
    │   └── smrc_train.jsonl
    └── train.json

After downloading these datasets and saving them at the proper path, please refer to Dataset Prepareing Tutorial for preprocessing these for corpus for following training.

4.2 Training Configurations: [Back to Top]

To train the model properly, we use the QLoRA and deepspeed toolkit. Before running, please make sure these essential toolkit are downloaded.

The configurations about training are shown as follows:

Models Model Name Training Configurations
Scientific Pretraining scillm scillm-train; scillm-deepspeed
Paper-ground SFT scillm-sft scillm-sft-train; scillm-deepspeed
Paper-ground SFT scillm-sft scillm-sft-train; scillm-deepspeed

Please refer to these configuration file for more training details. Note that these models are pre-trained on 8 x 3090 (24G) GPUs for over 9 days (over 4B tokens). As for paper-ground question answering SFT, the training process cost less than 3 hours (with 2000 steps).

4.3. Training Mozi Models: [Back to Top]

4.3.1. Scientific Pre-training Mozi Models: [Back to Top]

To pre-train Mozi on scientific pre-training corpus with 4B tokens, please run the following commands:

./scripts/train_pretrain.sh

The key arguments of the training script are as follows:

  • --model: The model name listed in config/base.json.
  • --model_path: The checkpoint for large-scale langauge models, baichuan-inc/baichuan-7B for baichuan-7B model and decapoda-research/llama-7b-hf for LLaMA-7B.
  • --train_data_path: The path saves the pretraining corpus.
  • --log_path: The directory that saves the pre-trained log in tensorboard format. This directory will be automatically created.
  • --save_path: The directory which saves the trained QLoRA delta weights. This directory will be automatically created.

Note that the total training steps can be set in the total_step argument at ./config/base.yaml file. Set this argument carefully to make sure all the tokens will be used during training.

4.3.2. Supversied Fine-tuning Mozi Models: [Back to Top]

Furthermore, to supervised fine-tune Mozi models on paper-ground question answering corpus, first make sure the dataset is set as QASPERDataset, and then please run the following commands:

./scripts/train_sft.sh

The key arguments of the training script are as follows:

  • --model: The model name listed in config/base.json.
  • --model_path: The checkpoint for large-scale langauge models, baichuan-inc/baichuan-7B for baichuan-7B model and decapoda-research/llama-7b-hf for LLaMA-7B.
  • --delta_model_path: The LoRA checkpoint weighted pre-traing in Section 3.3.1. The SFT process will continue optimize these LoRA weights for paper-ground question answering task.
  • --train_data_path: The path saves the pretraining corpus.
  • --log_path: The directory that saves the pre-trained log in tensorboard format. This directory will be automatically created.
  • --save_path: The directory which saves the trained QLoRA delta weights. This directory will be automatically created.

Note that the total training steps can be set in the total_step argument at ./config/base.yaml file. Set this argument carefully to make sure all the tokens will be used during training (2000 steps is enough in our hardware settings).

If you want to train the emotional dialog task, just simply replace the dataset with the path of emotional dataset path,and make sure the dataset_name in config/bash.yaml should also be set as EmotionalDataset.


Citation:

If you found Mozi models useful in your research or applications, please kindly cite using the following BibTeX:

...

Technical Report:

You can refer to our technical report for more details, which is saved in this path.


Acknowledgments:

This repo benefits from OpenAlpaca, PandaGPT. Thanks for their wonderful works!

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

暂无描述 展开 收起
Python 等 5 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/chinaperrin/science-llm.git
git@gitee.com:chinaperrin/science-llm.git
chinaperrin
science-llm
science-llm
main

搜索帮助