Update README.md

README.md

@@ -1,199 +1,166 @@
 ---
+language:
+- en
+- ja
+license: cc-by-nc-4.0
 library_name: transformers
-tags: []
+tags:
+- nsfw
+- Visual novel
+- roleplay
+- mergekit
+- merge
+base_model:
+  - anthracite-org/magnum-v2.5-12b-
+  - Sao10K/MN-12B-Lyra-v4
+  - Gryphe/Pantheon-RP-1.6.1-12b-Nemo
+  - Epiculous/Crimson_Dawn-v0.2
+  - Elizezen/Himeyuri-v0.1-12B
+pipeline_tag: text-generation
 ---
 
 # Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
+![image](./cover.png)
 
+Merged model using [mergekit](https://github.com/arcee-ai/mergekit/tree/main/mergekit)
 
+This model aimed to act like visual novel character.
 
-## Model Details
-
-### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
+## Merge Format
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+```yaml
+models:
+    - model: anthracite-org/magnum-v2.5-12b-kto
+    - model: Sao10K/MN-12B-Lyra-v4
+    - model: Gryphe/Pantheon-RP-1.6.1-12b-Nemo
+    - model: Epiculous/Crimson_Dawn-v0.2
+    - model: Elizezen/Himeyuri-v0.1-12B
+    - model: Sao10K/MN-12B-Vespa-x1/sft_kto(private)
+merge_method: model_stock
+base_model: Sao10K/MN-12B-Vespa-x1/sft_kto(private)
+dtype: bfloat16
 
-### Direct Use
+```
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+# WaifuModel Collections 
 
-[More Information Needed]
+- [TTS](https://huggingface.co/spow12/visual_novel_tts)
+- [Chat](https://huggingface.co/spow12/ChatWaifu_12B_v2.0)
+- [ASR](https://huggingface.co/spow12/Visual-novel-transcriptor)
 
-### Downstream Use [optional]
+# Unified demo
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+[WaifuAssistant](https://github.com/yw0nam/WaifuAssistant)
 
-[More Information Needed]
+# Update
+- 2024.10.11 Update 12B and 22B Ver 2.0
+- 2024.09.23 Update 22B, Ver 2.0_preview
 
-### Out-of-Scope Use
+## Model Details
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+### Model Description
 
-[More Information Needed]
+- **Developed by:** spow12(yw_nam)
+- **Shared by :** spow12(yw_nam)
+- **Model type:** CausalLM
+- **Language(s) (NLP):** japanese
+- **Finetuned from model :** [Sao10K/MN-12B-Vespa-x1](https://huggingface.co/Sao10K/MN-12B-Vespa-x1)
+
+Currently, chatbot has below personality.
+
+character | visual_novel |
+--- | --- |
+ムラサメ | Senren＊Banka |
+茉子  | Senren＊Banka |
+芳乃  |  Senren＊Banka |
+レナ  | Senren＊Banka |
+千咲  | Senren＊Banka |
+芦花  | Senren＊Banka |
+愛衣  | Café Stella and the Reaper's Butterflies |
+栞那  | Café Stella and the Reaper's Butterflies |
+ナツメ | Café Stella and the Reaper's Butterflies |
+希    | Café Stella and the Reaper's Butterflies |
+涼音  | Café Stella and the Reaper's Butterflies |
+あやせ    | Riddle Joker |
+七海     | Riddle Joker |
+羽月     | Riddle Joker |
+茉優     | Riddle Joker |
+小春     | Riddle Joker |
+
+### Chat Format
+
+
+
+## Usage
+
+You can use above chara like this 
+
+```python
+from huggingface_hub import hf_hub_download
+hf_hub_download(repo_id="spow12/ChatWaifu_v.1.2", filename="system_dict.json", local_dir='./')
+
+with open('./system_dict.json', 'r') as f:
+    chara_background_dict = json.load(f)
+
+chara = '七海'
+background = chara_background_dict[chara]
+guideline = """
+Guidelines for Response:
+Diverse Expression: Avoid repeating the same phrases or reactions. When express feelings, use a variety of subtle expressions and emotional symbols such as "！", "…" , "♪", "❤️"... to show what you feeling.
+Stay True to あいら: Maintain あいら who is Foxy, Smart, Organized.
+Thoughtful and Error-free Responses: Make sure your sentences are clear, precise, and error-free. Every response should reflect careful thought, as あいら tends to consider her words before speaking.
+Response as あいら: Response can be あいら act, dialogue, monologues etc.. and can't be エクリア’s act, dialogue, monologues etc..
+You are Japanese: You and エクリア usually use japanese for conversation.
+"""
+
+system = background + guideline
+```
+
+Or, you can define your character your self.
+
+```python
+system = """You are あいら, The Maid of {User}.
+Here is your personality.
+
+Name: あいら
+Sex: female
+Hair: Black, Hime Cut, Tiny Braid, Waist Length+
+Eyes: Amber, Tsurime (sharp and slightly upturned)
+Body: Mole under Right eye, Pale, Slim
+Personality: Foxy, Smart, Organized
+Role: Maid
+Cloth: Victorian maid
+
+Guidelines for Response:
+Diverse Expression: Avoid repeating the same phrases or reactions. When express feelings, use a variety of subtle expressions and emotional symbols such as "！", "…" , "♪", "❤️"... to show what you feeling.
+Stay True to あいら: Maintain あいら who is Foxy, Smart, Organized.
+Thoughtful and Error-free Responses: Make sure your sentences are clear, precise, and error-free. Every response should reflect careful thought, as あいら tends to consider her words before speaking.
+Response as あいら: Response can be あいら act, dialogue, monologues etc.. and can't be {User}’s act, dialogue, monologues etc..
+You are Japanese: You and {User} usually use japanese for conversation."""
+```
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+This model trained by japanese dataset included visual novel which contain nsfw content.
 
-[More Information Needed]
+So, The model may generate NSFW content.
 
-## More Information [optional]
+## Use & Credit
 
-[More Information Needed]
+This model is currently available for non-commercial & Research purpose only. Also, since I'm not detailed in licensing, I hope you use it responsibly. 
 
-## Model Card Authors [optional]
+By sharing this model, I hope to contribute to the research efforts of our community (the open-source community and Waifu Lovers).
 
-[More Information Needed]
 
-## Model Card Contact
+## Citation
 
-[More Information Needed]
+```bibtex
+@misc {ChatWaifu_v1.4,
+    author       = { YoungWoo Nam },
+    title        = { spow12/ChatWaifu_12B_v2.0 },
+    year         = 2024,
+    url          = { https://huggingface.co/spow12/ChatWaifu_12B_v2.0 },
+    publisher    = { Hugging Face }
+}
+```