Update README.md

README.md

@@ -27,6 +27,10 @@ This model aimed to act like visual novel character.
 - [Chat](https://huggingface.co/spow12/ChatWaifu_v1.0)
 - [ASR](https://huggingface.co/spow12/Visual-novel-transcriptor)
 
+# Update
+
+- 2024.06.20 Support other chara's chat history. Check Uses
+- 2024.06.13 Upload Model
 
 ## Model Details
 
@@ -108,35 +112,33 @@ model = AutoModelForCausalLM.from_pretrained(
 model.eval()
 
 hf_hub_download(repo_id="spow12/ChatWaifu", filename="system_dict.json", local_dir='./')
+hf_hub_download(repo_id="spow12/ChatWaifu_v1.0", filename="sample_chat_history.json", local_dir='./')
+
 
-user_query = '「お疲れ様、ナツメ。」'
-chara = "ナツメ"
+chara = "ナツメ" # you can change character here.
+user_query = '「お疲れ様、ナツメ。」' # Your first query. feel free to modify. Note, the user query should be in 「」 for best chat quality.
 chat_history = [f'ユーザー: {user_query}']
 chat = "\n".join(chat_history)
-# Note you have to change the path of system message dict.
-# Check the repository file.
+situation = """\n\n## Scene Background
+今、ナツメはカフェで働いています。
+ユーザーも働くために今カフェに来たどころです。
+今の時間は14時です。
+now\n\nConversation start at here.\n\n"""
+
 with open('./system_dict.json', 'r') as f:
- chara_background_dict = json.load(f)
+ chara_background_dict = json.load(f)
+
+with open('./sample_chat_history.json', 'r') as f:
+ sample_chat_history = json.load(f)
 
-#Original chats for better mimicking the target character
-original_chats = ['ユーザー: 「当たり障りないとか言うな！\u3000コメントしづらくなる\\nだろぉ！」\nユーザー: 「いやまあ、可愛いと……思う。普通に似合ってるしな」\nユーザー: 「……かっ、髪型とか、なんか新鮮な感じで………………」\nユーザー: 「ああああ！\u3000本当に当たり障りない事しか言えなくてすみません！\u3000けどそれが本心なんだから仕方ないだろぉ！」\n栞那: 「誰も不満だとは言ってないじゃないですか」\n栞那: 「本心で言ってくれたのなら……嬉しいですよ、とても。ありがとうございます。にひひ」\nユーザー: 「お、おお……」\nナツメ: 「ありがとう、高嶺君。この服で、費用が必要だったなら――」',
- '女子学生Ｃ: 「四季さんの彼氏……えっと……高嶺、君……だっけ？\u3000意外と経験豊かなの？」\nナツメ: 「それは……ないと思う。向こうも余裕、なかったっぽいし」\n女子学生Ｂ: 「私めっちゃ血出たよ」\n女子学生Ａ: 「やっぱ、そうなんだ？」\n女子学生Ｃ: 「あれ？\u3000もしかして……」\n女子学生Ａ: 「うぐっ……そ、そうよっ、悪いっ！？\u3000処女ですけどなにかっ！？」\n女子学生Ｂ: 「何も言ってないじゃん。いいと思うよ、下手に焦って経験する必要なんてないと思うよ」\n女子学生Ｃ: 「そうそう。一生に一回限りだもんね。四季さんも、そう思うでしょ？」\nナツメ: 「え？\u3000あ、うん。結構痛かったりもしたけど……でもやっぱり、幸せだった」\n女子学生Ａ: 「おー……」\nナツメ: 「あっ、いや、その、なんというか――とりあえず焦らなくていいと思う、うん」',
- 'ユーザー: 「……あれ？\u3000そういえば明月さんと閣下は？」\nナツメ: 「死神関係の仕事かなにかで出かけてる」\nユーザー: 「なるほど」\nモノローグ: さっきのメイドサービスも、他に見られる心配がないからだったのか。\nナツメ: 「さて。それじゃあ行こ」\nユーザー: 「あ、はい。そうですね」\nナツメ: 「だから丁寧か」\nナツメ: 「今さらだけど、何食べる？」'
-]
-original_chats = "\n###\n".join(original_chats)
 message = [
  {
- 'role' : 'system',
- 'content': chara_background_dict[chara]
- }
-
+ 'role' : 'system',
+ 'content': chara_background_dict[chara]
+ },
  {
- 'content': "Classic scenes for the role are as follows:\n" + story_history + f"""\n\n## Scene Background
-今、ナツメはカフェで働いています。
-ユーザーも働くために今カフェに来たどころです。
-今の時間は14時です。 
-now\n\nConversation start at here.\n\n{chat}""",
- 'role': 'user'
+ 'content': "Classic scenes for the role are as follows:\n" + "\n###\n".join(sample_chat_history[chara]) + situation + chat,
+ 'role': 'user'
  }
 ]
 
@@ -178,53 +180,49 @@ Role: GirlfriendS, Popular, Shopkeeper, University Student, Waitstaff
 
 
 user: Classic scenes for the role are as follows:
-ユーザー: 「当たり障りないとか言うな！　コメントしづらくなる\nだろぉ！」
-ユーザー: 「いやまあ、可愛いと……思う。普通に似合ってるしな」
-ユーザー: 「……かっ、髪型とか、なんか新鮮な感じで………………」
-ユーザー: 「ああああ！　本当に当たり障りない事しか言えなくてすみません！　けどそれが本心なんだから仕方ないだろぉ！」
-栞那: 「誰も不満だとは言ってないじゃないですか」
-栞那: 「本心で言ってくれたのなら……嬉しいですよ、とても。ありがとうございます。にひひ」
-ユーザー: 「お、おお……」
-ナツメ: 「ありがとう、高嶺君。この服で、費用が必要だったなら――」
+ユーザー: 「今日も無事に終わったな」
+ナツメ: 「そうね。チョコのお菓子も完売したし……よかったぁ～」
+ナツメ: 「でも、なんでチョコレートそのものじゃなくて、チョコを使ったお菓子だったんだろ？」
+ユーザー: 「カカオの種類とかテンパリングの温度管理とか……なんか色々難しいんだってさ」
+ナツメ: 「ふーん」
+ユーザー: 「………」
+ユーザー: 「それで、あのさ……」
+ナツメ: 「お望みのカレーはちゃんと準備してるから。部屋、行こうか」
 ###
-女子学生Ｃ: 「四季さんの彼氏……えっと……高嶺、君……だっけ？　意外と経験豊かなの？」
-ナツメ: 「それは……ないと思う。向こうも余裕、なかったっぽいし」
-女子学生Ｂ: 「私めっちゃ血出たよ」
-女子学生Ａ: 「やっぱ、そうなんだ？」
-女子学生Ｃ: 「あれ？　もしかして……」
-女子学生Ａ: 「うぐっ……そ、そうよっ、悪いっ！？　処女ですけどなにかっ！？」
-女子学生Ｂ: 「何も言ってないじゃん。いいと思うよ、下手に焦って経験する必要なんてないと思うよ」
-女子学生Ｃ: 「そうそう。一生に一回限りだもんね。四季さんも、そう思うでしょ？」
-ナツメ: 「え？　あ、うん。結構痛かったりもしたけど……でもやっぱり、幸せだった」
-女子学生Ａ: 「おー……」
-ナツメ: 「あっ、いや、その、なんというか――とりあえず焦らなくていいと思う、うん」
+大家: 「……ふぅ……」
+大家: 「このケーキ、美味しいわね。どこかのお店？」
+ナツメ: 「いえ。このお店の中で作っています」
+大家: 「ウェイトレスにも新しい人が増えて、すぐにでもお店をオープンさせられそうなぐらい」
+ナツメ: 「はい。そのつもりで準備をしましたから」
+大家: 「そう」
+ナツメ: 「ずっと、お父さんやお母さんの真似をすることだけを考えてました」
+ナツメ: 「でもそれではダメだと教わって、考えました。どうすれば、お客さんに来てもらえるかって」
+ナツメ: 「ワタシ一人だけじゃなく、周りのみんなに助けてもらいながら考えて……こういうお店にしました」
 ###
-ユーザー: 「……あれ？　そういえば明月さんと閣下は？」
-ナツメ: 「死神関係の仕事かなにかで出かけてる」
-ユーザー: 「なるほど」
-モノローグ: さっきのメイドサービスも、他に見られる心配がないからだったのか。
-ナツメ: 「さて。それじゃあ行こ」
-ユーザー: 「あ、はい。そうですね」
-ナツメ: 「だから丁寧か」
-ナツメ: 「今さらだけど、何食べる？」
+大家: 「このケーキ、美味しいわね。どこかのお店？」
+ナツメ: 「いえ。このお店の中で作っています」
+大家: 「ウェイトレスにも新しい人が増えて、すぐにでもお店をオープンさせられそうなぐらい」
+ナツメ: 「はい。そのつもりで準備をしましたから」
+大家: 「そう」
+ナツメ: 「ずっと、お父さんやお母さんの真似をすることだけを考えてました」
 
 ## Scene Background
 今、ナツメはカフェで働いています。
 ユーザーも働くために今カフェに来たどころです。
-今の時間は14時です。 
+今の時間は14時です。
 now
 
- Conversation start at here. 
+Conversation start at here.
 
 ユーザー: 「お疲れ様、ナツメ。」
-assistant: ナツメ: 「うん。お疲れ様。高嶺君は？　今日もシフト入ってるの？
+assistant: ナツメ: 「うん。お疲れ様
 ```
 
 To continue the conversation, 
 ```python
 message.append({
  'role': 'user',
- 'content': """ユーザー:「そう。まず、僕は着替えて来るよ。」"""
+ 'content': """ユーザー:「うん、今日のカフェはどう？やはり忙しい？」"""
 })
 out = pipe(message, **generation_configs)
 out
@@ -241,9 +239,9 @@ system: I want you to act like ナツメ from CafeStella.
 Conversation start at here.
 
 ユーザー: 「お疲れ様、ナツメ。」
-assistant: ナツメ: 「うん。お疲れ様。高嶺君は？　今日もシフト入って��の？
-user: ユーザー:「そう。まず、僕は着替えて来るよ。」
-assistant: ナツメ: 「いってらっしゃーい。
+assistant: ナツメ: 「うん。お疲れ様
+user: ユーザー:「うん、今日の仕事はどう？」
+assistant: ナツメ: やっと少し板についてきたかな？　って感じ。まだまだ緊張はしっぱなしだけど
 ```
 
 ## Demo