Update README.md

README.md

@@ -1,3 +1,49 @@
----
-license: gemma
----
+---
+license: gemma
+---
+# What is this?
+Googleの言語モデル[gemma-2-9b-it](https://huggingface.co/google/gemma-2-9b-it)のSPPO改良版[Gemma-2-9B-It-SPPO-Iter3](https://huggingface.co/UCLA-AGI/Gemma-2-9B-It-SPPO-Iter3)をGGUFフォーマットに変換したものです。<br>
+また、一連の作業前にllama.cppのトークナイザテスト機能([#8248](https://github.com/ggerganov/llama.cpp/pull/8248))にて動作の正確性の確認を行いました。
+
+テスト内容
+```
+python convert_hf_to_gguf_update.py <hf_token>
+python convert_hf_to_gguf.py models/tokenizers/gemma-2/ --outfile models/ggml-vocab-gemma-2.gguf --vocab-only
+test-tokenizer-0 models/ggml-vocab-gemma-2.gguf
+```
+
+# imatrix dataset
+日本語能力を重視し、日本語が多量に含まれる[TFMC/imatrix-dataset-for-japanese-llm](https://huggingface.co/datasets/TFMC/imatrix-dataset-for-japanese-llm)データセットを使用しました。<br>
+なお、imatrixの算出においてはf32精度のモデルを使用しました。これは、本来の数値精度であるbf16でのimatrix計算に現行のCUDA版llama.cppが対応していないためです。
+
+# Chat template
+```
+<start_of_turn>user
+ここにpromptを書きます<end_of_turn>
+<start_of_turn>model
+
+```
+
+# Quants
+各クオンツと必要と想定されるVRAM容量をまとめておきます。
+|クオンツ|VRAM|
+|---|---|
+|IQ4_XS|10GB|
+|Q4_K_M|11GB|
+|Q5_K_M|11GB|
+|Q6_K|12GB|
+|Q8_0|14GB|
+|bf16|22GB|
+
+# Note
+**llama.cpp-b3389以降と合わせてご利用ください。**<br>
+なお、このモデル特有の処理であるAttention logit soft-cappingが存在するため、現状では``-fa`` オプションによるFlash Attentionの使用はできません。
+
+# Environment
+Windows版llama.cpp-b3389および同時リリースのconvert_hf_to_gguf.pyを使用して量子化作業を実施しました。
+
+# License
+gemma license
+
+# Developer
+Google & UCLA-AGI