Update README.md

README.md

@@ -1,6 +1,75 @@
 ---
 library_name: peft
+datasets:
+- waddledee/three_line_summarization_for_japanese_news_articles
+language:
+- ja
 ---
+
+## Usage
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer, BitsAndBytesConfig
+from peft import PeftModel, PeftConfig
+import torch
+
+peft_model_id = "waddledee/three-line-summarization-ja"
+config = PeftConfig.from_pretrained(peft_model_id)
+model_name = config.base_model_name_or_path  # this is the base model name
+
+tokenizer = AutoTokenizer.from_pretrained(peft_model_id)
+
+bnb_config = BitsAndBytesConfig(
+    load_in_4bit=True,
+    bnb_4bit_quant_type="nf4",
+    bnb_4bit_compute_dtype=torch.float16,
+)
+# Load the base model in 4bit
+model_4bit = AutoModelForCausalLM.from_pretrained(
+    model_name, 
+    quantization_config=bnb_config, 
+    trust_remote_code=True
+)
+model_4bit.config.use_cache = False 
+
+# this will make new learnable parameters for specialized tokens
+model_4bit.resize_token_embeddings(len(tokenizer))
+
+model_from_hub = PeftModel.from_pretrained(
+    model_4bit,
+    peft_model_id, 
+    torch_dtype=torch.float16,   
+    device_map={'':0}
+)
+
+def gen(text, model):
+    prompt = f"""<s>[INST] <<SYS>>
+あなたは誠実で優秀な日本人のアシスタントです。
+<</SYS>>
+
+以下の入力文を3行で要約しなさい。
+入力文:
+{text} [/INST] [R_START] 
+"""
+    token_ids = tokenizer.encode(prompt, add_special_tokens=False, return_tensors="pt")
+    token_ids.to("cuda")
+
+    with torch.no_grad():
+        output_ids =model.generate(
+            inputs = token_ids,
+            do_sample=False,
+            pad_token_id=tokenizer.eos_token_id,
+            eos_token_id=tokenizer.eos_token_id,
+            max_new_tokens=256
+        )
+    output = tokenizer.decode(output_ids.tolist()[0][token_ids.size(1) :], skip_special_tokens=True)
+    return(output)
+
+text = "２０１３年に「一帯一路」は、中国が世界経済の中心的地位を占めていた次代の古代シルクロードの再現を意識したものとされ、陸上と海上の双方において中国と中央アジア、欧州までを結ぶ構想だ。中国メディアの中国網はこのほど、一帯一路構想の実現に向け、中国は日本とどのように対峙すべきかを論じる記事を掲載。中国社科院世界経済政治研究所の研究員の分析として、日本は一帯一路構想の実現における競合として中国の前に立ちはだかると主張した。日本が中国の競合となると主張した１つ目の理由は、「シルクロード文化に最も興味を示しているのは日本である」ことだという。日本にはシルクロードを題材にした小説やドキュメンタリーが多く、シルクロードに対する熱意は中国をも凌ぐゆえだ。確かに日本ではシルクロードを題材とした小説などは多いが、これは納得できない理由だ。記事が挙げた２つ目の理由は「冷戦後、もっとも早くシルクロードに商機を見出したのが日本」であることだという。日本は１９９７年に当時の橋本総理が「対シルクロード地域外交」を打ち出したが、これはどの国よりも早くシルクロードの重要性に注目した結果であると指摘した。３つ目の点は「中国に対して、もっとも競争力を有しているのが日本である」ことで、日本が中国主導のアジアインフラ投資銀行（ＡＩＩＢ）に対抗して、１１００億ドルのインフラ投資をアジアで行う方針を打ち出したことを指摘。また、日本は一帯一路構想に対する「破壊力」も有しているうえ、日本は経済面、政治外交面、軍事面で「もっとも中国に対して懐疑的」であることから、中国の一帯一路構想について、日本が何らかの形で対抗策を打ち出してくるのではないかと警戒感を示した。"
+gen(text,model_from_hub)
+
+>> '3行要約:\n中国メディアが日本が一帯一路構想に対抗するのかを論じた\n日本がシルクロード文化に最も興味を示していると指摘\n日本は経済面、政治外交面、軍事面で中国に対して懐疑的   '
+```
+
 ## Training procedure
 
 
@@ -17,4 +86,4 @@ The following `bitsandbytes` quantization config was used during training:
 ### Framework versions
 
 
-- PEFT 0.5.0.dev0
+- PEFT 0.5.0.dev0