Update README.md

README.md

@@ -1,135 +1,132 @@
 ---
 library_name: transformers
 license: other
+license_link: LICENSE
 base_model: sbintuitions/sarashina2.1-1b
 tags:
 - generated_from_trainer
 metrics:
 - pearsonr
 - spearmanr
-model-index:
-- name: test-clf-sarashina
-  results: []
+language:
+- ja
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
+# Japanese-Novel-Reward-sarashina2.1-1b
 
-# test-clf-sarashina
+このモデルは[sbintuitions/sarashina2.1-1b](https://huggingface.co/sbintuitions/sarashina2.1-1b)をファインチューニングして作成された日本語小説の品質評価のためのRewardモデルです。
 
-This model is a fine-tuned version of [sbintuitions/sarashina2.1-1b](https://huggingface.co/sbintuitions/sarashina2.1-1b) on an unknown dataset.
-It achieves the following results on the evaluation set:
-- Loss: 1.0627
-- Mae: 0.7734
-- R2: 0.4137
-- Pearsonr: 0.6549
-- Spearmanr: 0.6483
+主に小説生成モデルの強化学習等の用途を想定しています。
 
-## Model description
+入力の小説テキストに対するユーザーの評価を回帰で予測することにより、間接的にそのテキストの品質を評価出来ることを想定しています。ただし、テキストのクオリティ以外の様々なバイアス（ジャンル、文体など）の影響を受けている可能性があることに注意してご利用ください。
 
-More information needed
+**Sarashina is licensed under the Sarashina Model NonCommercial License Agreement, Copyright ©SB Intuitions Corp. All Rights Reserved.**
 
-## Intended uses & limitations
+## 使い方
 
-More information needed
+事前にtransformersやflash attention 2等をインストールしてください。
 
-## Training and evaluation data
+```python
+from transformers import pipeline
+import torch
 
-More information needed
+model_name = "Aratako/Japanese-Novel-Reward-sarashina2.1-1b"
 
-## Training procedure
+classifier = pipeline("text-classification", model=model_name, tokenizer=model_name, max_length=8192, truncation=True, device_map="auto", torch_dtype=torch.bfloat16)
 
-### Training hyperparameters
 
-The following hyperparameters were used during training:
+# 以下の例文はo1-proの生成文章です。
+text1 = """　地球から四光年先にある惑星シルヴァは、常に緑色のオーロラが大気を覆い尽くしている。大気組成はわずかに人類が呼吸できる水準に達しており、国際恒星探査チームは着陸後すぐに小規模な調査基地を設営した。まだ未知の生物や環境リスクが多く、常時防護服を着用することが義務付けられていたが、そこには他の惑星にはない神秘的な輝きがあった。
+
+　しかし、シルヴァに到着して三週間が経過したある日、チームは周波数帯の異なる奇妙なシグナルを受信した。それは惑星の奥地から発せられているらしく、断続的に解析不可能な符号を繰り返している。始めは放電現象や地磁気の乱れと考えられたが、解析を続けるうちにそのパターンには高度な規則性があると判明した。シルヴァに原生生物がいるかは不明だったが、仮に知的生命体が存在するとすれば、このシグナルこそが最初の接触の証拠かもしれない。
+
+　未知のシグナルを探索するため、調査チームの半数は基地に残り、他の半数が地上車両で発信源を目指すことになった。たどり着くのは容易ではない。惑星の自転と軌道は不安定で、オーロラの発生源である極地帯を通らなければならないからだ。そこは強烈な電子嵐が吹き荒れ、通信が途切れるリスクも大きい。
+
+　出発してから三日目の夜、車両の通信装置に再びあの符号が流れ込んできた。しかも、これまでよりも鮮明で、かつ信号の強度が一定している。人類側の移動に合わせてシグナルが強まっているようにすら感じられた。まるで“何者か”がこちらを探り、導こうとしているかのようだった。
+
+　五日目の夕刻、車両は目的地と思われる地点に到着した。そこには巨大な結晶柱が何本も地面から突き出し、緑色のオーロラを反射してきらめいている。やがて強烈な放電光が走り、車両のモニターに無数の文字列が流れ出した。その一つひとつが、これまで受信してきた符号の断片と一致することが判明する。
+「解読できないか？」
+　チームのエンジニアがすぐに端末に入力を開始する。すると、高度な数理アルゴリズムを経て、短い文章が浮かび上がった。
+——ようこそ。我々はあなたたちを待っていた。——
+
+　一同は息をのんだ。この惑星に知的生命体が存在する可能性が高いと確信した瞬間だった。恐る恐る結晶柱へ近づくと、表面に薄く光る膜のようなものが走っているのが見えた。誰もが初めて見る未知のテクノロジーに戸惑いと興奮を隠せない。
+「これは、メッセージの投影装置かもしれない。地球でいうホログラムのような……」
+　先ほどの一文に続き、さらに複雑な符号が走る。解読ソフトが再び動き、次々と浮かび上がる言葉に、人類は初めて“彼ら”の声を聞いた。
+——この星はあらゆる音を、光として記録する。私たちはあなた方を歓迎する準備ができている。——
+
+　その瞬間、結晶柱の周囲にあった無数のオーロラが渦を巻き始め、調査チームは鮮やかな光の嵐に包まれた。リーダーの胸には、畏怖と同時に奇妙な安心感が広がっていた。やがて通信が基地へ復旧されると、結晶柱の内部に広がる未知の世界をすべて記録すべく、全人類が新たな一歩を踏み出す準備を始めるのだった。"""
+
+text2 = """　ぼくは宇宙船に乗っていた。理由はよくわからない。とにかく、ここは狭い部屋がひとつあるだけで、窓は黒くて何も見えない。宇宙を旅しているはずだけれど、景色は真っ暗だ。食料もカプセルみたいな固いものばかりだ。あんまりおいしくない。
+
+　日常のほとんどは退屈だから、寝てばかりいる。ときどき目を覚ましてコントロールパネルを見るけど、赤や青のランプが意味もなく点滅しているだけで、何がどうなっているのかよくわからない。
+
+　船内のコンピュータと会話しようとしても、返事は「異常ナシ。航行中デス」としか言わない。何か異常があったらどうなるか、想像するのも面倒だから、そのまままた寝る。たまに重力の調整がうまくいかず、少しふわっとするけど、すぐに元に戻る。それだけだ。
+
+　ぼくは宇宙船で何をしているのか、本当によくわからない。たぶん地球に帰ることを目指しているんだろうけど、帰っても特別やることはないし、急ぐ理由も思いつかない。そういえば、いつ出発したのかも覚えていない。
+
+　ときどき通信が入ることがあるけれど、大抵は雑音だけだ。何を言っているかもわからないし、聞き返す気力もない。音声ログを再生しても「ザザ…」というノイズが続くだけで、最後に小さな声が聞こえるような気がするけど、結局意味が分からないから気にしない。
+
+　そんなわけで、今日はまた固いカプセル食をかじったあと、ぼくはベッドに倒れ込むようにして眠りについた。明日もまた同じ一日が続くと思うけれど、特に問題はない。どうせ闇しか見えない宇宙の中で、ぼくはただ一人だからだ。
+
+　宇宙って、こんなにつまらないものだったんだなと思いながら、ぼくは船内のランプが点滅するのをぼんやり眺める。それでも船はどこかへ向かって動いているらしい。目標があるのかどうかはよくわからない。"""
+
+print(classifier([text1, text2]))
+```
+
+出力
+
+```
+[{'label': 'LABEL_0', 'score': 8.375}, {'label': 'LABEL_0', 'score': 6.78125}]
+```
+
+## 学習のハイパーパラメータ
+
+学習の主なハイパーパラメータは以下の通りです。
+
 - learning_rate: 1e-05
 - train_batch_size: 4
 - eval_batch_size: 8
 - seed: 42
 - gradient_accumulation_steps: 4
 - total_train_batch_size: 16
-- optimizer: Use OptimizerNames.PAGED_ADAMW_8BIT with betas=(0.9,0.999) and epsilon=1e-08 and optimizer_args=No additional optimizer arguments
+- optimizer: paged_adamw_8bit
 - lr_scheduler_type: cosine_with_min_lr
 - lr_scheduler_warmup_ratio: 0.1
 - num_epochs: 3
+- max_length: 8192
+
+## 学習結果
+
+train/valid/testにデータを分割し、valid lossが最小となるstepのモデルを採用しています。
+
+1. validデータに対する評価指標
+  - Loss: 1.1625
+  - Mae: 0.7953
+  - R2: 0.4308
+  - Pearsonr: 0.6615
+  - Spearmanr: 0.6458
+
+2. testデータに対する評価指標
+  - Loss: 1.0627
+  - Mae: 0.7734
+  - R2: 0.4137
+  - Pearsonr: 0.6549
+  - Spearmanr: 0.6483
+
+3. testデータに対する推論結果の分布
+
+  - 散布図
+    ![散布図](scatter_plot_test_data.png)
+  - 誤差の分布
+    ![誤差分布](errors_hist_test_data.png)
 
-### Training results
-
-| Training Loss | Epoch  | Step | Validation Loss | Mae    | R2       | Pearsonr | Spearmanr |
-|:-------------:|:------:|:----:|:---------------:|:------:|:--------:|:--------:|:---------:|
-| 33.4003       | 0.0440 | 30   | 41.9736         | 5.0785 | -19.5514 | 0.0060   | 0.0030    |
-| 68.9791       | 0.0880 | 60   | 26.7601         | 3.9223 | -12.1025 | 0.0141   | 0.0121    |
-| 7.0015        | 0.1320 | 90   | 18.4436         | 3.2333 | -8.0305  | 0.0940   | 0.1009    |
-| 9.5128        | 0.1760 | 120  | 12.7227         | 2.6544 | -5.2294  | 0.1979   | 0.2112    |
-| 8.1175        | 0.2200 | 150  | 8.9334          | 2.3069 | -3.3740  | 0.2409   | 0.2638    |
-| 5.7487        | 0.2640 | 180  | 5.1040          | 1.6855 | -1.4991  | 0.3342   | 0.3609    |
-| 4.2498        | 0.3080 | 210  | 6.3587          | 2.0904 | -2.1134  | 0.3393   | 0.3770    |
-| 3.211         | 0.3520 | 240  | 2.5982          | 1.2158 | -0.2722  | 0.4370   | 0.4679    |
-| 12.1813       | 0.3960 | 270  | 2.2745          | 1.0969 | -0.1137  | 0.4647   | 0.4956    |
-| 2.4104        | 0.4400 | 300  | 2.1392          | 1.1266 | -0.0474  | 0.4725   | 0.5040    |
-| 2.3           | 0.4840 | 330  | 2.0064          | 1.1148 | 0.0176   | 0.5250   | 0.5458    |
-| 4.1499        | 0.5281 | 360  | 2.4043          | 1.1457 | -0.1772  | 0.5252   | 0.5581    |
-| 1.6108        | 0.5721 | 390  | 1.6467          | 0.9633 | 0.1937   | 0.5714   | 0.5802    |
-| 1.81          | 0.6161 | 420  | 1.5801          | 0.9609 | 0.2263   | 0.5978   | 0.6000    |
-| 2.1724        | 0.6601 | 450  | 1.6209          | 0.9791 | 0.2063   | 0.5482   | 0.4986    |
-| 2.0144        | 0.7041 | 480  | 1.7803          | 0.9999 | 0.1283   | 0.6017   | 0.5923    |
-| 4.5503        | 0.7481 | 510  | 1.3499          | 0.8849 | 0.3391   | 0.5942   | 0.5621    |
-| 4.3733        | 0.7921 | 540  | 3.5365          | 1.6830 | -0.7316  | 0.6105   | 0.5996    |
-| 1.4027        | 0.8361 | 570  | 1.3477          | 0.9035 | 0.3401   | 0.6328   | 0.6183    |
-| 2.429         | 0.8801 | 600  | 1.2318          | 0.8174 | 0.3969   | 0.6315   | 0.6103    |
-| 0.9818        | 0.9241 | 630  | 1.8458          | 1.0223 | 0.0962   | 0.6372   | 0.6054    |
-| 1.5284        | 0.9681 | 660  | 1.2547          | 0.8434 | 0.3856   | 0.6402   | 0.6157    |
-| 1.5741        | 1.0117 | 690  | 1.3692          | 0.8539 | 0.3296   | 0.6279   | 0.6049    |
-| 2.251         | 1.0557 | 720  | 1.7575          | 1.1040 | 0.1395   | 0.6439   | 0.6396    |
-| 0.5807        | 1.0997 | 750  | 1.2974          | 0.8208 | 0.3648   | 0.6481   | 0.6275    |
-| 1.8142        | 1.1437 | 780  | 1.5116          | 0.9475 | 0.2599   | 0.6530   | 0.6302    |
-| 0.8249        | 1.1878 | 810  | 1.3097          | 0.8618 | 0.3588   | 0.6447   | 0.6145    |
-| 1.4956        | 1.2318 | 840  | 2.2229          | 1.2553 | -0.0884  | 0.6392   | 0.6362    |
-| 2.0046        | 1.2758 | 870  | 2.1057          | 1.2350 | -0.0310  | 0.6468   | 0.6260    |
-| 1.3633        | 1.3198 | 900  | 1.2954          | 0.8883 | 0.3657   | 0.6533   | 0.6312    |
-| 3.1957        | 1.3638 | 930  | 1.8696          | 1.1447 | 0.0846   | 0.6451   | 0.6154    |
-| 0.793         | 1.4078 | 960  | 1.2303          | 0.8429 | 0.3976   | 0.6413   | 0.6052    |
-| 2.2954        | 1.4518 | 990  | 1.3201          | 0.8624 | 0.3537   | 0.6571   | 0.6240    |
-| 1.7479        | 1.4958 | 1020 | 1.2562          | 0.8144 | 0.3849   | 0.6399   | 0.6125    |
-| 1.6785        | 1.5398 | 1050 | 1.7362          | 1.0790 | 0.1499   | 0.6492   | 0.6269    |
-| 1.4885        | 1.5838 | 1080 | 2.3715          | 1.3151 | -0.1612  | 0.6480   | 0.6215    |
-| 3.2869        | 1.6278 | 1110 | 1.5134          | 0.9746 | 0.2590   | 0.6498   | 0.6329    |
-| 2.7832        | 1.6718 | 1140 | 1.2013          | 0.8259 | 0.4118   | 0.6593   | 0.6298    |
-| 1.4801        | 1.7158 | 1170 | 1.5599          | 1.0123 | 0.2362   | 0.6573   | 0.6294    |
-| 1.3236        | 1.7598 | 1200 | 1.9116          | 1.1420 | 0.0640   | 0.6457   | 0.6253    |
-| 0.627         | 1.8038 | 1230 | 1.3976          | 0.9289 | 0.3157   | 0.6609   | 0.6430    |
-| 1.0075        | 1.8478 | 1260 | 1.2831          | 0.8849 | 0.3718   | 0.6589   | 0.6491    |
-| 1.2107        | 1.8918 | 1290 | 1.1647          | 0.7974 | 0.4298   | 0.6625   | 0.6453    |
-| 0.8244        | 1.9358 | 1320 | 1.5123          | 0.9705 | 0.2595   | 0.6544   | 0.6296    |
-| 1.1668        | 1.9798 | 1350 | 1.2957          | 0.8695 | 0.3656   | 0.6584   | 0.6356    |
-| 1.0709        | 2.0235 | 1380 | 1.1780          | 0.8212 | 0.4232   | 0.6648   | 0.6458    |
-| 0.8817        | 2.0675 | 1410 | 1.2616          | 0.8664 | 0.3823   | 0.6662   | 0.6506    |
-| 1.3163        | 2.1115 | 1440 | 1.1625          | 0.7953 | 0.4308   | 0.6615   | 0.6458    |
-| 1.3449        | 2.1555 | 1470 | 1.4815          | 0.9598 | 0.2746   | 0.6547   | 0.6425    |
-| 1.1915        | 2.1995 | 1500 | 1.2140          | 0.8206 | 0.4056   | 0.6677   | 0.6518    |
-| 0.7156        | 2.2435 | 1530 | 1.2342          | 0.8335 | 0.3957   | 0.6633   | 0.6468    |
-| 0.8369        | 2.2875 | 1560 | 1.2145          | 0.8241 | 0.4053   | 0.6672   | 0.6503    |
-| 1.2756        | 2.3315 | 1590 | 1.4552          | 0.9521 | 0.2875   | 0.6693   | 0.6523    |
-| 1.2847        | 2.3755 | 1620 | 1.3366          | 0.8992 | 0.3456   | 0.6706   | 0.6490    |
-| 0.9743        | 2.4195 | 1650 | 1.3276          | 0.8922 | 0.3500   | 0.6680   | 0.6471    |
-| 1.2146        | 2.4635 | 1680 | 1.2658          | 0.8572 | 0.3802   | 0.6711   | 0.6509    |
-| 1.0538        | 2.5075 | 1710 | 1.2478          | 0.8455 | 0.3890   | 0.6710   | 0.6516    |
-| 0.7843        | 2.5515 | 1740 | 1.3749          | 0.9140 | 0.3268   | 0.6665   | 0.6479    |
-| 1.9038        | 2.5955 | 1770 | 1.2816          | 0.8703 | 0.3725   | 0.6678   | 0.6488    |
-| 2.0116        | 2.6395 | 1800 | 1.2002          | 0.8211 | 0.4124   | 0.6693   | 0.6500    |
-| 1.5984        | 2.6835 | 1830 | 1.3324          | 0.8956 | 0.3476   | 0.6699   | 0.6503    |
-| 0.7943        | 2.7275 | 1860 | 1.2132          | 0.8308 | 0.4060   | 0.6691   | 0.6477    |
-| 0.544         | 2.7715 | 1890 | 1.3286          | 0.8932 | 0.3495   | 0.6699   | 0.6497    |
-| 1.9314        | 2.8155 | 1920 | 1.3196          | 0.8859 | 0.3539   | 0.6688   | 0.6490    |
-| 0.5876        | 2.8596 | 1950 | 1.2934          | 0.8711 | 0.3667   | 0.6688   | 0.6488    |
-| 0.5792        | 2.9036 | 1980 | 1.2532          | 0.8488 | 0.3864   | 0.6697   | 0.6494    |
-| 0.8113        | 2.9476 | 2010 | 1.2244          | 0.8336 | 0.4005   | 0.6705   | 0.6496    |
-| 0.8149        | 2.9916 | 2040 | 1.2827          | 0.8662 | 0.3720   | 0.6698   | 0.6502    |
+## ライセンス
 
+元モデルから[Sarashina Model NonCommercial License Agreement](https://huggingface.co/sbintuitions/sarashina2.1-1B/blob/main/LICENSE)を継承します。利用にあたっては様々な制約があるので十分にご注意ください。
 
 ### Framework versions
 
 - Transformers 4.49.0
 - Pytorch 2.6.0+cu124
 - Datasets 3.3.2
-- Tokenizers 0.21.0
+- Tokenizers 0.21.0