Update README.md

README.md

@@ -1,199 +1,120 @@
 ---
+license: apache-2.0
+datasets:
+- Aratako/Syosetu711K-Cleaned-158K-instruct
+language:
+- ja
 library_name: transformers
-tags: []
+tags:
+- not-for-all-audiences
+- nsfw
+base_model:
+- Elizezen/Antler-7B
 ---
+# Antler-7B-Novel-Writing
+[GGUF版はこちら/Click here for the GGUF version](https://huggingface.co/Aratako/Antler-7B-Novel-Writing-GGUF)
 
-# Model Card for Model ID
+## 概要
 
-<!-- Provide a quick summary of what the model is/does. -->
+[Elizezen/Antler-7B](https://huggingface.co/Elizezen/Antler-7B)をベースに、小説生成用のinstruction tuningを施したモデルです。
 
+ジャンルやクオリティ、キーワードや年齢区分を指定すると、それに従った小説を生成するようにinstruction tuningしています。
 
+## プロンプトフォーマット
+Mistralのchat templateを利用してください。また、学習に利用したデータのフォーマットの関係上、以下のような形式が望ましいと思われます。
 
-## Model Details
+```
+[INST] {小説生成の指示}
 
-### Model Description
+ジャンル：{ジャンル（小説家になろう形式）}
+クオリティ：{クオリティを示す数値（0から3）}
+キーワード：{小説の概要を示すタグ・キーワードを読点区切りで羅列（小説家になろう形式）}
+年齢区分：{年齢区分を示す数値（0：全年齢、1：R15、2：R18）} [/INST]
+```
 
-<!-- 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.
+```
+[INST] あなたのタスクは小説を書くことです。ユーザーが以下で示す設定から適切な小説を書いてください。
 
-- **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]
+ジャンル：ハイファンタジー〔ファンタジー〕
+クオリティ：2
+キーワード：R15、残酷な描写あり、ギャグ、女主人公、魔王、魔法、主人公最強、転生
+年齢区分：1 [/INST] 
+```
 
-### 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 -->
+上記の例では以下のような出力設定を行っています。
+- Temperature:0.7
+- Top-p:0.9
+- Repetition Penalty:1.1
+- Amount to Gen.: 1024
 
-[More Information Needed]
+## プロンプト内のパラメータについて
+本モデルは学習時の指示にジャンルやキーワード、クオリティ、年齢区分などを追加して学習しているため、それらを指定することである程度出力の制御が可能です。
 
-### Out-of-Scope Use
+### ジャンル
+[なろう小説API](https://dev.syosetu.com/man/api/)および[なろうR18小説API](https://dev.syosetu.com/xman/api/)における`genre`と`nocgenre`のジャンルで学習しています。具体的には以下のものを学習時に使っています。この形式で指定するのが望ましいかと思われます。
+- 全年齢・R15：未選択〔未選択〕、異世界〔恋愛〕、現実世界〔恋愛〕ハイファンタジー〔ファンタジー〕、ローファンタジー〔ファンタジー〕、純文学〔文芸〕、ヒューマンドラマ〔文芸〕、歴史〔文芸〕、推理〔文芸〕、ホラー〔文芸〕、アクション〔文芸〕、コメディー〔文芸〕、VRゲーム〔SF〕、宇宙〔SF〕、空想科学〔SF〕、パニック〔SF〕、童話〔その他〕、詩〔その他〕、エッセイ〔その他〕、リプレイ〔その他〕、その他〔その他〕、ノンジャンル〔ノンジャンル〕
+- R18：男性向け、女性向け、BL、大人向け ※こちらはAPIページ上での表記からやや変更して学習しています。
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+### クオリティ
+本モデルの学習に使用した[データセット](https://huggingface.co/datasets/Aratako/Syosetu711K-Cleaned-158K-instruct)の大本である[RyokoAI/Syosetu711K](https://huggingface.co/datasets/RyokoAI/Syosetu711K)のq-scoreを利用して学習時のレコードにクオリティタグをつけています。
 
-[More Information Needed]
+[使用したデータセット](https://huggingface.co/datasets/Aratako/Syosetu711K-Cleaned-158K-instruct)は既にq-scoreが0.8以上の高品質のものをフィルターしてありますが、さらにそれを25%ずつに分け、下から0、1、2、3とラベリングしています。3を指定するとより高品質な出力になる事が期待されます。
 
-## Bias, Risks, and Limitations
+### 年齢区分
+全年齢の作品には0を、R15作品には1を、R18作品には2をラベルとしてつけ学習しています。これを生成時に指定することである程度表現の制御が可能となっていると思います。
+なお、年齢区分に2を指定する場合、ジャンルもそれ専用のものを指定する必要があるのでご注意ください。
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+## 学習関連の情報
 
-[More Information Needed]
+### 使用データセット
+- [Aratako/Syosetu711K-Cleaned-158K-instruct](https://huggingface.co/Aratako/Syosetu711K-Cleaned-158K-instruct)
 
-### Recommendations
+## 学習の設定
+RunpodでGPUサーバを借り、A6000x7で学習を行いました。主な学習パラメータは以下の通りです。
+- lora_r: 128
+- lisa_alpha: 256
+- lora_dropout: 0.05
+- lora_target_modules: ["q_proj", "k_proj", "v_proj", "o_proj", "gate_proj", "up_proj", "down_proj", "lm_head"]
+- learning_rate: 2e-5
+- num_train_epochs: 2 epochs
+- batch_size: 64
+- max_seq_length: 4096
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+## ライセンス
+apache-2.0ライセンスの元公開いたします。
 
-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]
+ただし、元モデルである[Elizezen/Antler-7B](https://huggingface.co/Elizezen/Antler-7B)のライセンスが不明であるため、作者様から何らかの連絡等を受けた場合変更の可能性があります。