Update README.md

README.md

@@ -1,3 +1,98 @@
 ---
 license: mit
 ---
+
+# ERNIE-Code
+
+[ERNIE-Code: Beyond English-Centric Cross-lingual Pretraining for Programming Languages](https://aclanthology.org/2023.findings-acl.676.pdf)
+
+![ernie-code-comp](https://github.com/KB-Ding/PaddleNLP/assets/13767887/2a550b46-a7d5-416d-b300-83cce7044be4)
+
+
+
+ERNIE-Code is a unified large language model (LLM) that connects 116 natural languages with 6 programming languages. We employ two pre-training methods for universal cross-lingual pre-training: span-corruption language modeling that learns patterns from monolingual NL or PL; and pivot-based translation language modeling that relies on parallel data of many NLs and PLs. Extensive results show that ERNIE-Code outperforms previous multilingual LLMs for PL or NL across a wide range of end tasks of code intelligence, including multilingual code-to-text, text-to-code, code-to-code, and text-to-text generation. We further show its advantage of zero-shot prompting on multilingual code summarization and text-to-text translation.
+
+[ACL 2023 (Findings)](https://aclanthology.org/2023.findings-acl.676/) | [arXiv](https://arxiv.org/pdf/2212.06742) 
+
+
+### Multilingual Text-to-Code / Code-to-Text
+
+First preprocess the input prompt:
+```python
+  def clean_up_code_spaces(s: str):
+      # post process
+      # ===========================
+      new_tokens = ["<pad>", "</s>", "<unk>", "\n", "\t", "<|space|>"*4, "<|space|>"*2, "<|space|>"]
+      for tok in new_tokens:
+          s = s.replace(f"{tok} ", tok)
+
+      cleaned_tokens = ["<pad>", "</s>", "<unk>"]
+      for tok in cleaned_tokens:
+          s = s.replace(tok, "")
+      s = s.replace("<|space|>", " ")
+      # ===========================
+      return s
+```
+
+Then use `transformers` to load the model:
+```python
+import torch
+from transformers import (
+    AutoModelForSeq2SeqLM,
+    AutoModelForCausalLM,
+    AutoTokenizer
+)
+
+model_name = "baidu/ernie-code-560m"
+
+model = AutoModelForSeq2SeqLM.from_pretrained(model_name)
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+# note that you can use aforementioned `clean_up_code_spaces` to proprocess the code
+
+input_code="快速排序"
+prompt="translate Chinese to English: \n%s" % (input_code)  # your prompt here
+
+model_inputs = tokenizer(prompt, max_length=512, padding=False, truncation=True, return_tensors="pt")
+input_ids = model_inputs.input_ids.cuda() # by default
+attention_mask = model_inputs.attention_mask.cuda() # by default
+
+output = model.generate(input_ids=input_ids, attention_mask=attention_mask, 
+        num_beams=5, max_length=512) # change to your own decoding methods
+
+# Ensure to customize the post-processing of clean_up_code_spaces output according to specific requirements.
+output = tokenizer.decode(output.flatten(), skip_special_tokens=True)
+```
+
+
+### Zero-shot Examples
+- Multilingual code-to-text generation (zero-shot)
+
+![code-to-text-examples](https://github.com/KB-Ding/PaddleNLP/assets/13767887/7dbf225e-e6be-401d-9f6c-f733e2f68f76)
+
+![zh_code-to-text_examples-1](https://github.com/KB-Ding/PaddleNLP/assets/13767887/2d1ba091-f43c-4f3e-95c6-0038ede9e63e)
+
+- Multilingual text-to-text translation (zero-shot)
+
+![zero-shot-mt-examples](https://github.com/KB-Ding/PaddleNLP/assets/13767887/8be1a977-fa21-4a46-86ba-136fa8276a1a)
+
+
+## BibTeX
+```
+@inproceedings{chai-etal-2023-ernie,
+    title = "{ERNIE}-Code: Beyond {E}nglish-Centric Cross-lingual Pretraining for Programming Languages",
+    author = "Chai, Yekun  and
+      Wang, Shuohuan  and
+      Pang, Chao  and
+      Sun, Yu  and
+      Tian, Hao  and
+      Wu, Hua",
+    booktitle = "Findings of the Association for Computational Linguistics: ACL 2023",
+    month = jul,
+    year = "2023",
+    address = "Toronto, Canada",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2023.findings-acl.676",
+    pages = "10628--10650",
+    abstract = "Software engineers working with the same programming language (PL) may speak different natural languages (NLs) and vice versa, erecting huge barriers to communication and working efficiency. Recent studies have demonstrated the effectiveness of generative pre-training in computer programs, yet they are always English-centric. In this work, we step towards bridging the gap between multilingual NLs and multilingual PLs for large language models (LLMs). We release ERNIE-Code, a unified pre-trained language model for 116 NLs and 6 PLs. We employ two methods for universal cross-lingual pre-training: span-corruption language modeling that learns patterns from monolingual NL or PL; and pivot-based translation language modeling that relies on parallel data of many NLs and PLs. Extensive results show that ERNIE-Code outperforms previous multilingual LLMs for PL or NL across a wide range of end tasks of code intelligence, including multilingual code-to-text, text-to-code, code-to-code, and text-to-text generation. We further show its advantage of zero-shot prompting on multilingual code summarization and text-to-text translation. We release our code and pre-trained checkpoints.",
+}
+```