Indicbartss

🚀 IndicBARTSS模型

IndicBARTSS是一个多语言的序列到序列预训练模型，专注于印度语言和英语。它基于mBART架构，目前支持11种印度语言。你可以使用IndicBARTSS模型，通过有监督的训练数据对模型进行微调，来构建印度语言的自然语言生成应用，适用于机器翻译、文本摘要、问题生成等任务。

🚀 快速开始

你可以在这篇论文中了解更多关于IndicBARTSS的信息。 详细文档请查看：https://github.com/AI4Bharat/indic-bart/ 和 https://indicnlp.ai4bharat.org/indic-bart/

✨ 主要特性

• 支持的语言广泛：支持阿萨姆语、孟加拉语、古吉拉特语、印地语、马拉地语、奥里亚语、旁遮普语、卡纳达语、马拉雅拉姆语、泰米尔语、泰卢固语和英语。并非所有这些语言都被mBART50和mT5支持。
• 模型规模小：该模型比mBART和mT5（-base）模型小得多，因此在微调和解码时计算成本更低。
• 训练数据丰富：在大型印度语言语料库（4.52亿个句子和90亿个标记）上进行训练，其中还包括印度英语内容。
• 无需脚本映射：与ai4bharat/IndicBART不同，每种语言都使用其自己的文字书写，因此你无需执行任何与天城文之间的脚本映射。

📦 安装指南

文档中未提及具体安装命令，此章节跳过。

💻 使用示例

基础用法

from transformers import MBartForConditionalGeneration, AutoModelForSeq2SeqLM
from transformers import AlbertTokenizer, AutoTokenizer

tokenizer = AutoTokenizer.from_pretrained("ai4bharat/IndicBARTSS", do_lower_case=False, use_fast=False, keep_accents=True)

# Or use tokenizer = AlbertTokenizer.from_pretrained("ai4bharat/IndicBARTSS", do_lower_case=False, use_fast=False, keep_accents=True)

model = AutoModelForSeq2SeqLM.from_pretrained("ai4bharat/IndicBARTSS")

# Or use model = MBartForConditionalGeneration.from_pretrained("ai4bharat/IndicBARTSS")

# Some initial mapping
bos_id = tokenizer._convert_token_to_id_with_added_voc("<s>")
eos_id = tokenizer._convert_token_to_id_with_added_voc("</s>")
pad_id = tokenizer._convert_token_to_id_with_added_voc("<pad>")
# To get lang_id use any of ['<2as>', '<2bn>', '<2en>', '<2gu>', '<2hi>', '<2kn>', '<2ml>', '<2mr>', '<2or>', '<2pa>', '<2ta>', '<2te>']

# First tokenize the input and outputs. The format below is how IndicBARTSS was trained so the input should be "Sentence </s> <2xx>" where xx is the language code. Similarly, the output should be "<2yy> Sentence </s>". 
inp = tokenizer("I am a boy </s> <2en>", add_special_tokens=False, return_tensors="pt", padding=True).input_ids # tensor([[  466,  1981,    80, 25573, 64001, 64004]])

out = tokenizer("<2hi> मैं  एक लड़का हूँ </s>", add_special_tokens=False, return_tensors="pt", padding=True).input_ids # tensor([[64006,   942,    43, 32720,  8384, 64001]])

model_outputs=model(input_ids=inp, decoder_input_ids=out[:,0:-1], labels=out[:,1:])

# For loss
model_outputs.loss ## This is not label smoothed.

# For logits
model_outputs.logits

# For generation. Pardon the messiness. Note the decoder_start_token_id.

model.eval() # Set dropouts to zero

model_output=model.generate(inp, use_cache=True, num_beams=4, max_length=20, min_length=1, early_stopping=True, pad_token_id=pad_id, bos_token_id=bos_id, eos_token_id=eos_id, decoder_start_token_id=tokenizer._convert_token_to_id_with_added_voc("<2en>"))


# Decode to get output strings

decoded_output=tokenizer.decode(model_output[0], skip_special_tokens=True, clean_up_tokenization_spaces=False)

print(decoded_output) # I am a boy

高级用法

# What if we mask?

inp = tokenizer("I am [MASK] </s> <2en>", add_special_tokens=False, return_tensors="pt", padding=True).input_ids

model_output=model.generate(inp, use_cache=True, num_beams=4, max_length=20, min_length=1, early_stopping=True, pad_token_id=pad_id, bos_token_id=bos_id, eos_token_id=eos_id, decoder_start_token_id=tokenizer._convert_token_to_id_with_added_voc("<2en>"))

decoded_output=tokenizer.decode(model_output[0], skip_special_tokens=True, clean_up_tokenization_spaces=False)

print(decoded_output) # I am happy

inp = tokenizer("मैं [MASK] हूँ </s> <2hi>", add_special_tokens=False, return_tensors="pt", padding=True).input_ids

model_output=model.generate(inp, use_cache=True, num_beams=4, max_length=20, min_length=1, early_stopping=True, pad_token_id=pad_id, bos_token_id=bos_id, eos_token_id=eos_id, decoder_start_token_id=tokenizer._convert_token_to_id_with_added_voc("<2en>"))

decoded_output=tokenizer.decode(model_output[0], skip_special_tokens=True, clean_up_tokenization_spaces=False)

print(decoded_output) # मैं जानता हूँ

inp = tokenizer("मला [MASK] पाहिजे </s> <2mr>", add_special_tokens=False, return_tensors="pt", padding=True).input_ids

model_output=model.generate(inp, use_cache=True, num_beams=4, max_length=20, min_length=1, early_stopping=True, pad_token_id=pad_id, bos_token_id=bos_id, eos_token_id=eos_id, decoder_start_token_id=tokenizer._convert_token_to_id_with_added_voc("<2en>"))

decoded_output=tokenizer.decode(model_output[0], skip_special_tokens=True, clean_up_tokenization_spaces=False)

print(decoded_output) # मला ओळखलं पाहिजे

📚 详细文档

注意事项

1. 该模型与最新版本的transformers兼容，但开发时使用的是4.3.2版本，因此如果可能的话，建议使用4.3.2版本。
2. 虽然文档中仅展示了如何获取logits和损失以及如何生成输出，但你可以执行MBartForConditionalGeneration类所能执行的几乎所有操作，详情请参考https://huggingface.co/docs/transformers/model_doc/mbart#transformers.MBartForConditionalGeneration 。
3. 注意，这里使用的分词器基于SentencePiece，而不是BPE。因此，使用的是AlbertTokenizer类，而不是MBartTokenizer类。

下游任务微调

1. 如果你希望微调此模型，可以使用YANMTT工具包，按照此处的说明进行操作。
2. （未测试）或者，你可以使用Hugging Face官方的翻译和摘要脚本。

贡献者

• Raj Dabre
• Himani Shrotriya
• Anoop Kunchukuttan
• Ratish Puduppully
• Mitesh M. Khapra
• Pratyush Kumar

论文引用

如果你使用了IndicBARTSS，请引用以下论文：

@misc{dabre2021indicbart,
      title={IndicBART: A Pre-trained Model for Natural Language Generation of Indic Languages}, 
      author={Raj Dabre and Himani Shrotriya and Anoop Kunchukuttan and Ratish Puduppully and Mitesh M. Khapra and Pratyush Kumar},
      year={2021},
      eprint={2109.02903},
      archivePrefix={arXiv},
      primaryClass={cs.CL}
    }    

🔧 技术细节

预训练语料库

使用了涵盖12种语言的IndicCorp数据，包含4.52亿个句子（90亿个标记）。该模型使用了mBART中采用的文本填充目标进行训练。

📄 许可证

该模型遵循MIT许可证。