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許可證。