Update README.md

README.md

@@ -6,197 +6,108 @@ language:
 
 # webbigdata/FanFic-Illustrator
 
-FanFic-Illustratorは二次創作したショートストーリー(日本語、英語、他)に挿絵用の画像生成AI用プロンプトを作成するモデルです  
-FanFic-Illustrator is a model for creating prompts for image generation AI to create illustrations for fan-created short stories (Japanese, English, etc.)    
+FanFic-Illustratorは二次創作したショートストーリー(日本語、英語、他)に挿絵用の画像生成AI用プロンプトを作成する3Bモデルです  
+FanFic-Illustrator is a 3B model for creating prompts for image generation AI to create illustrations for fan-created short stories (Japanese, English, etc.)    
 
 ## Model Details
 
 ### Model Description
 
-[Google Colabのサンプル](https://github.com/webbigdata-jp/python_sample/blob/main/FanFic_Illustrator_demo.ipynb)
-[Sample Colab Script](https://github.com/webbigdata-jp/python_sample/blob/main/FanFic_Illustrator_demo.ipynb)
-
-
-
-
-詳細は後日記入予定  
-More details to be added later.  
-
-- **Developed by:** webbigdata
-- **Model type:** text generation
-- **Language(s) (NLP):** Japanese, English
-- **Finetuned from model [optional]:** Qwen 2.5 3B Instruct
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** https://huggingface.co/webbigdata/FanFic-Illustrator/
-- **Demo** [Sample Colab Script](https://github.com/webbigdata-jp/python_sample/blob/main/FanFic_Illustrator_demo.ipynb)
-
-
-
-## 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]
+入力として、コンテンツカテゴリ、シリーズ名、キャラクター名、テキスト(オリジナル／ファン小説)、利用可能なタグを与えると、思考の過程と画像生成AI用のプロンプト(Danbooruタグ)を出力する推論モデルです。  
+指定されたタグを使って適切な推測を行おうとします。そのため、出力カテゴリ/傾向を大まかに制御できます。  
 
-## Training Details
+This is an reasoning model that takes content category, series name, character name, text (original/fanfiction), and available tags as input and outputs thought process and prompts (Danbooru tags) for image generation AI.  
+It tries to make a good guess using the tags you provide, so you can roughly control the output category/tendency.  
 
-### Training Data
+画像生成モデルは[cagliostrolab/animagine-xl-4.0 opt](https://huggingface.co/cagliostrolab/animagine-xl-4.0)に最適化してあります  
+The image generation model is optimized for [cagliostrolab/animagine-xl-4.0 opt](https://huggingface.co/cagliostrolab/animagine-xl-4.0).  
 
-<!-- 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. -->
+### Supported languages
 
-[More Information Needed]
+日本語、英語、中国語(繁体字)を入力としてトレーニングをしています
+おそらくqwen 2.5が対応している言語であれば他の言語でも動作するのではないかと思います。  
 
-### Training Procedure
+Training is done using Japanese, English, and Chinese (traditional characters) as input.
+The output language of the thought process is Japanese only.
+I think it will probably work with other languages that are supported by qwen 2.5.
 
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
 
-#### Preprocessing [optional]
+### prompt template
 
-[More Information Needed]
+#### Input prompt template/入力テンプレート
 
+以下のように日本語で与える必要があります。  
+It must be given in Japanese as follows:
 
-#### Training Hyperparameters
+```
+### 小説のコン��キストを補足する情報
+content category: {category}
+series name: {series_name}
+series description: {series_name} series
+character name: {character_name}
+character description: {character_name} from {series_name}
 
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
+### 小説データ
+{novel_text}
 
-#### Speeds, Sizes, Times [optional]
+まず以下のように思考を整理します。
 
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
+concept: イラストのコンセプトを考えます。小説の内容から主題、設定、雰囲気を理解し、どのようなイラストが最も適切か、全体の構成を考えます
+- 人数: 挿絵の中に登場させる人数を考えます。作品に登場する人物の数や重要性を考慮し、メインで描くべき人物やサブキャラクターについても検討してください
+- キャラクター名/シリーズ名: 既存作品のキャラクター/シリーズか、オリジナル作品かを考えます。既存作品の場合は、原作の設定や特徴を尊重した表現方法も考慮してください
+- ポーズ/構図: ポーズ/構図指定に使うタグを考えます。物語の場面において、キャラクターがどのような体勢/状況にあるのか、どのアングルから描くと効果
+的かを検討してください
+- 背景/環境: 背景/環境指定に使うタグを考えます。物語の舞台設定や時間帯、天候など、雰囲気を表現するために必要な背景要素を詳しく考えてください
+- 描画スタイル/テクニック: 描画スタイル/テクニックに使うタグを考えます。物語のジャンルや雰囲気に合わせて、どのような画風や技法が適しているかを検討してください
+- 身体的特徴/画面上の物体: 身体的特徴/画面上の物体に関連するタグを考えます。キャラクターの外見的特徴や、シーンに必要な小道具、アイテムなどを詳細に考えてください
 
-[More Information Needed]
+改行の場所も含めて、この順序と書式を厳密に守ってください。
+各項目は上記の順序と書式で記述してください。具体的かつ詳細に説明し、十分な長さで考察してください（タグ全体で600-800文字程度が望ましいです）
 
-## Evaluation
+その後、思考結果に基づき内に英単語を18単語ほどカンマで区切って出力してください。キャラクター名/シリーズ名は指定されていたら必ず含めます。
+日本語は使用しないでください。 最も重要で適切なタグを選び、有効なプロンプトとなるよう考慮してください
 
-<!-- This section describes the evaluation protocols and provides the results. -->
+### 使用可能な英単語
+出力時には以下のタグを優先して使用し、足りない場合は一般的な英単語で補足します
+masterpiece, best quality, highresなどの品質に関連するタグは後工程で付与するのでつけてはいけません
 
-### Testing Data, Factors & Metrics
+**人数/性別**:
+- your tag list
 
-#### Testing Data
+**ポーズ/構図**:
+- your tag list
 
-<!-- This should link to a Dataset Card if possible. -->
+**背景/環境**:
+- your tag list
 
-[More Information Needed]
+**描画スタイル/テクニック**:
+- your tag list
 
-#### Factors
+**身体的特徴/画面上の物体**:
+- your tag list
+```
 
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
+#### 出力テンプレート
 
-[More Information Needed]
+以下のように日本語で与える必要があります。  
 
-#### Metrics
+```
+<think> some Japanese text </think> <prompt> Danbooru tag(comma separated English word) </prompt>
+```
 
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
+詳細はSample Scriptを確認してください  
+Please check Sample Script for details.  
 
-[More Information Needed]
 
-### Results
+### Sample Script
 
-[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]
+[Google Colabのサンプル](https://github.com/webbigdata-jp/python_sample/blob/main/FanFic_Illustrator_demo.ipynb)
+[Sample Colab Script](https://github.com/webbigdata-jp/python_sample/blob/main/FanFic_Illustrator_demo.ipynb)
 
-## Model Card Authors [optional]
 
-[More Information Needed]
 
-## Model Card Contact
+- **Developed by:** webbigdata
+- **Model type:** text generation
+- **Language(s) (NLP):** Japanese, English
+- **Finetuned from model [optional]:** Qwen 2.5 3B Instruct
 
-[More Information Needed]