spow12
/

ChatWaifu_v1.4

@@ -1,199 +1,161 @@
 ---
 library_name: transformers
-tags: []
 ---
 # Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
 ## 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
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
 ## 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. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
+base_model:
+- mistralai/Mistral-Nemo-Instruct-2407
+- NeverSleep/Lumimaid-v0.2-12B
+- Epiculous/Violet_Twilight-v0.1
+- Sao10K/MN-12B-Lyra-v4
+- anthracite-org/magnum-v2-12b
+language:
+- en
+- fr
+- de
+- es
+- it
+- pt
+- ru
+- zh
+- ja
+license: cc-by-nc-4.0
+pipeline_tag: text-generation
+tags:
+- nsfw
+- Visual novel
+- roleplay
+- mergekit
+- merge
 library_name: transformers
 ---
 # Model Card for Model ID
+![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.
+## Merge Format
+```yaml
+models:
+    - model: spow12/ChatWaifu_modify_data
+    - model: anthracite-org/magnum-v2-12b
+    - model: Sao10K/MN-12B-Lyra-v4
+    - model: Gryphe/Pantheon-RP-1.6-12b-Nemo
+    - model: mistralai/Mistral-Nemo-Instruct-2407
+    - model: NeverSleep/Lumimaid-v0.2-12B
+    - model: Epiculous/Violet_Twilight-v0.1
+merge_method: model_stock
+base_model: spow12/ChatWaifu_modify_data
+dtype: bfloat16
+```
+you have to resize chatwaifu and lucimaid's embedding size(131073 to 131072).
+# WaifuModel Collections
+- [TTS](https://huggingface.co/spow12/visual_novel_tts)
+- [Chat](https://huggingface.co/spow12/ChatWaifu_v1.3.1)
+- [ASR](https://huggingface.co/spow12/Visual-novel-transcriptor)
+# Unified demo
+[WaifuAssistant](https://github.com/yw0nam/WaifuAssistant)
+# Update
+- 2024.09.10 Update Ver 1.4
+  - Modify data format and applying flitering.
+  - Merge with model stock
+- 2024.08.29 Update Ver 1.3.1
+  - Merge Ver1.2, [mistralai/Mistral-Nemo-Instruct-2407](https://huggingface.co/mistralai/Mistral-Nemo-Instruct-2407) and [NeverSleep/Lumimaid-v0.2-12B](https://huggingface.co/NeverSleep/Lumimaid-v0.2-12B), [Epiculous/Violet_Twilight-v0.1](https://huggingface.co/Epiculous/Violet_Twilight-v0.1)
+  - Adjust merge weight.
+- 2024.08.16 Update Ver 1.3
+  - Merge Ver1.2, [mistralai/Mistral-Nemo-Instruct-2407](https://huggingface.co/mistralai/Mistral-Nemo-Instruct-2407) and [NeverSleep/Lumimaid-v0.2-12B](https://huggingface.co/NeverSleep/Lumimaid-v0.2-12B),
+- 2024.08.08 Update Ver 1.2.1
+  - Merge Ver1.2 and [mistralai/Mistral-Nemo-Instruct-2407](https://huggingface.co/mistralai/Mistral-Nemo-Instruct-2407)
+- 2024.08.07 Update Ver 1.2
+  - Add Preference Learning in training pipeline
+- 2024.07.29 Update Ver 1.1
+  - Add dataset format -> generate novel, fill masked sentences
+  - Remove system role and integrate at user message.
+  - Remove 『』 in conversation.
+- 2024.06.20 Upload other chara's sample chat history.
+- 2024.06.13 Upload Model
 ## Model Details
 ### Model Description
+- **Developed by:** spow12(yw_nam)
+- **Shared by :** spow12(yw_nam)
+- **Model type:** CausalLM
+- **Language(s) (NLP):** japanese
+- **Finetuned from model :** [NeverSleep/Lumimaid-v0.2-12B](https://huggingface.co/NeverSleep/Lumimaid-v0.2-12B)
+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 |
+### Feature
+- Fluent Chat performance
+- Reduce repetition problem when generate with many turn(over 20~30)
+- Zero Shot character persona using description of character.
+- 128k context window
+- Memory ability that does not forget even after long-context generation
+## Demo
+You can use Demo in google colab.
+Check [Here](https://colab.research.google.com/drive/194_FN28reEPTwS51dwpLLBBwEfeoBjP9?usp=sharing)
+## Future Work.
+Now, i'm quite satisfying the model chat performance.
+So, i'm going to focus for integrating the vision modality to model so that our waifu can do more general tasks.
 ## Bias, Risks, and Limitations
+This model trained by japanese dataset included visual novel which contain nsfw content.
+So, The model may generate NSFW content.
+## Use & Credit
+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.
+By sharing this model, I hope to contribute to the research efforts of our community (the open-source community and anime persons).
+This repository can use Visual novel-based RAG, but i will not distribute it yet because i'm not sure if it is permissible to release the data publicly.
+## Citation
+```bibtex
+@misc {ChatWaifu_v1.4,
+    author       = { YoungWoo Nam },
+    title        = { ChatWaifu_v1.4 },
+    year         = 2024,
+    url          = { https://huggingface.co/spow12/ChatWaifu_v1.4 },
+    publisher    = { Hugging Face }
+}
+```