update README

README.md

@@ -12,19 +12,21 @@ tags:
 
 # PLaMo-Embedding-1B
 
-## モデルの概要
-PLaMo-Embedding-1Bは、Preferred Networks, Inc. によって開発された日本語テキスト埋め込みモデルです。
+[日本語版のREADME/Japanese README](README_ja.md)
 
-日本語の文章を入力することで数値ベクトルに変換することができ、情報検索、テキスト分類、クラスタリングなどをはじめとした幅広い用途でお使い頂けます。
+## Model Overview
 
-日本語テキスト埋め込みのためのベンチマークである[JMTEB](https://github.com/sbintuitions/JMTEB)において、2025年4月初頭時点で最高水準のスコアを達成しました。
-特に検索タスクにおいて一際優れた性能を示しています。
+PLaMo-Embedding-1B is a Japanese text embedding model developed by Preferred Networks, Inc.
 
-PLaMo-Embedding-1Bは [Apache v2.0](https://www.apache.org/licenses/LICENSE-2.0) ライセンスで公開されており、商用利用を含めて自由にお使い頂けます。
+It can convert Japanese text input into numerical vectors and can be used for a wide range of applications, including information retrieval, text classification, and clustering.
 
-技術的詳細については次のTech Blogをご参照ください: [link]
+As of early April 2025, it achieved top-class scores on [JMTEB](https://github.com/sbintuitions/JMTEB), a benchmark for Japanese text embedding. It demonstrated particularly outstanding performance, especially in retrieval tasks.
 
-## 使用方法
+PLaMo-Embedding-1B is released under the [Apache v2.0](https://www.apache.org/licenses/LICENSE-2.0) license, and you can use it freely, including for commercial purposes.
+
+For technical details, please refer to the following Tech Blog post (Ja): https://tech.preferred.jp/ja/blog/plamo-embedding-1b/
+
+## Usage
 
 ### Requirements
 ```
@@ -33,13 +35,13 @@ torch
 transformers
 ```
 
-### サンプルコード
+### Sample Code
 ```python
 import torch
 import torch.nn.functional as F
 from transformers import AutoModel, AutoTokenizer
 
-# 🤗 Huggingface Hubから以下のようにしてモデルをダウンロードできます
+# You can download models from the Hugging Face Hub 🤗 as follows:
 tokenizer = AutoTokenizer.from_pretrained("pfnet/plamo-embedding-1b", trust_remote_code=True)
 model = AutoModel.from_pretrained("pfnet/plamo-embedding-1b", trust_remote_code=True)
 
@@ -53,24 +55,25 @@ documents = [
 ]
 
 with torch.inference_mode():
-    # 情報検索におけるクエリ文章の埋め込みに関しては、`encode_query` メソッドを用いてください
-    # tokenizerも渡す必要があります
+    # For embedding query texts in information retrieval, please use the `encode_query` method.
+    # You also need to pass the `tokenizer`.
     query_embedding = model.encode_query(query, tokenizer)
-    # それ以外の文章に関しては、 `encode_document` メソッドを用いてください
-    # 情報検索以外の用途についても、 `encode_document` メソッドを用いてください
+    # For other texts/sentences, please use the `encode_document` method.
+    # Also, for applications other than information retrieval, please use the `encode_document` method.
     document_embeddings = model.encode_document(documents, tokenizer)
 
-# モデルに文章を入力して得られたベクトル間の類似度は、近い文章は高く、遠い文章は低くなります
-# この性質を用いて情報検索などに活用することができます
+# The similarity between vectors obtained by inputting sentences into the model is high for similar sentences and low for dissimilar sentences.
+# This feature can be utilized for applications such as information retrieval.
 similarities = F.cosine_similarity(query_embedding, document_embeddings)
 print(similarities)
 # tensor([0.8812, 0.5533])
 ```
 
-※ `encode_document`, `encode_query` では、モデルの最大コンテキスト長である4096を超えた文章は切り捨てられるのでご注意ください。特に `encode_query` では、内部でprefixが付与されており、この分僅かに最大コンテキスト長が短くなっています。
+Note: For `encode_document` and `encode_query`, texts exceeding the model's maximum context length of 4096 will be truncated. Be especially aware that for `encode_query`, a prefix is added internally, making the effective maximum context length slightly shorter.
 
-## ベンチマーク結果
-日本語テキスト埋め込みのためのベンチマークである[JMTEB](https://github.com/sbintuitions/JMTEB)を用いて性能評価を行いました。
+
+## Benchmarks
+We conducted a performance evaluation using [JMTEB](https://github.com/sbintuitions/JMTEB), a benchmark for Japanese text embedding.
 
  Model                                         |Avg.      | Retrieval   | STS       | Classification   | Reranking   | Clustering   | PairClassification   |
 |:----------------------------------------------|:----------|:------------|:----------|:-----------------|:------------|:-------------|:---------------------|
@@ -82,22 +85,21 @@ print(similarities)
 |||
 |[**PLaMo-Embedding-1B**](https://huggingface.co/pfnet/plamo-embedding-1b) (This model) (*)|**76.10**|**79.94**|**83.14**|77.20|93.57|53.47|62.37|
 
-(*): コンテキスト長1024で計測。モデルとしてはコンテキスト長4096まで対応していますが、学習時に入れているコンテキスト長が1024までのため、1024で計測しています。ただし、4096で評価してもそこまでスコア平均に影響がないことがわかっています(Tech Blog参照)
-
-## モデル詳細
+(*): Measured with a context length of 1024. Although the model supports a context length of up to 4096, we measured at 1024 because the context length included during training was up to 1024. However, it is known that evaluating at 4096 does not significantly affect the average score. (Ref: [Tech Blog (Ja)](https://tech.preferred.jp/ja/blog/plamo-embedding-1b/))。
 
-- モデルサイズ: 1B
-- コンテキスト長: 4096
-- 埋め込み次元: 2048
-- 類似度計測に用いる関数: cosine類似度
-- 開発元: Preferred Networks, Inc
-- 対応言語: 日本語
-- ライセンス: [Apache v2.0](https://www.apache.org/licenses/LICENSE-2.0)
+## Model Details
 
-## ライセンス
+- Model Size: 1B
+- Maximum Context Length: 4096 tokens
+- Embedding Dimensionality: 2048
+- Similarity Function: cosine similarity
+- Developer: Preferred Networks, Inc
+- Language: Japanese
+- License: [Apache v2.0](https://www.apache.org/licenses/LICENSE-2.0)
 
-このモデルは [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0) のもとで公開されており、商用利用を含めて自由にお使い頂けます。
+## License
 
+PLaMo-Embedding-1B is released under the [Apache v2.0](https://www.apache.org/licenses/LICENSE-2.0) license, and you can use it freely, including for commercial purposes.
 
 ## How to cite
 
@@ -107,6 +109,6 @@ print(similarities)
     title     = {PLaMo-Embedding-1B},
     year      = {2025},
     url       = {https://huggingface.co/pfnet/plamo-embedding-1b},
-    urldate   = {2025-04-**}
+    urldate   = {2025-04-17}
 }
 ```

README_ja.md

@@ -0,0 +1,113 @@
+---
+language:
+  - ja
+library_name: transformers
+license: apache-2.0
+pipeline_tag: sentence-similarity
+tags:
+  - feature-extraction
+  - sentence-similarity
+  - transformers
+---
+
+# PLaMo-Embedding-1B
+
+## モデルの概要
+
+PLaMo-Embedding-1Bは、Preferred Networks, Inc. によって開発された日本語テキスト埋め込みモデルです。
+
+日本語の文章を入力することで数値ベクトルに変換することができ、情報検索、テキスト分類、クラスタリングなどをはじめとした幅広い用途でお使い頂けます。
+
+日本語テキスト埋め込みのためのベンチマークである[JMTEB](https://github.com/sbintuitions/JMTEB)において、2025年4月初頭時点でトップクラスのスコアを達成しました。
+特に検索タスクにおいて一際優れた性能を示しています。
+
+PLaMo-Embedding-1Bは [Apache v2.0](https://www.apache.org/licenses/LICENSE-2.0) ライセンスで公開されており、商用利用を含めて自由にお使い頂けます。
+
+技術的詳細については次のTech Blog (Ja) をご参照ください: https://tech.preferred.jp/ja/blog/plamo-embedding-1b/
+
+## 使用方法
+
+### Requirements
+```
+sentencepiece
+torch
+transformers
+```
+
+### サンプルコード
+```python
+import torch
+import torch.nn.functional as F
+from transformers import AutoModel, AutoTokenizer
+
+# 🤗 Huggingface Hubから以下のようにしてモデルをダウンロードできます
+tokenizer = AutoTokenizer.from_pretrained("pfnet/plamo-embedding-1b", trust_remote_code=True)
+model = AutoModel.from_pretrained("pfnet/plamo-embedding-1b", trust_remote_code=True)
+
+device = "cuda" if torch.cuda.is_available() else "cpu"
+model = model.to(device)
+
+query = "PLaMo-Embedding-1Bとは何ですか？"
+documents = [
+    "PLaMo-Embedding-1Bは、Preferred Networks, Inc. によって開発された日本語テキスト埋め込みモデルです。",
+    "最近は随分と暖かくなりましたね。"
+]
+
+with torch.inference_mode():
+    # 情報検索におけるクエリ文章の埋め込みに関しては、`encode_query` メソッドを用いてください
+    # tokenizerも渡す必要があります
+    query_embedding = model.encode_query(query, tokenizer)
+    # それ以外の文章に関しては、 `encode_document` メソッドを用いてください
+    # 情報検索以外の用途についても、 `encode_document` メソッドを用いてください
+    document_embeddings = model.encode_document(documents, tokenizer)
+
+# モデルに文章を入力して得られたベクトル間の類似度は、近い文章は高く、遠い文章は低くなります
+# この性質を用いて情報検索などに活用することができます
+similarities = F.cosine_similarity(query_embedding, document_embeddings)
+print(similarities)
+# tensor([0.8812, 0.5533])
+```
+
+※ `encode_document`, `encode_query` では、モデルの最大コンテキスト長である4096を超えた文章は切り捨てられるのでご注意ください。特に `encode_query` では、内部でprefixが付与されており、この分僅かに最大コンテキスト長が短くなっています。
+
+## ベンチマーク結果
+日本語テキスト埋め込みのためのベンチマークである[JMTEB](https://github.com/sbintuitions/JMTEB)を用いて性能評価を行いました。
+
+ Model                                         |Avg.      | Retrieval   | STS       | Classification   | Reranking   | Clustering   | PairClassification   |
+|:----------------------------------------------|:----------|:------------|:----------|:-----------------|:------------|:-------------|:---------------------|
+| [intfloat/multilingual-e5-large](https://huggingface.co/intfloat/multilingual-e5-large)       |70.90     | 70.98       | 79.70     | 72.89            | 92.96       | 51.24        | 62.15                |
+| [pkshatech/GLuCoSE-base-ja-v2](https://huggingface.co/pkshatech/GLuCoSE-base-ja-v2)   |72.23     | 73.36       | 82.96     | 74.21            | 93.01       | 48.65        | 62.37                |
+| [OpenAI/text-embedding-3-large](https://openai.com/index/new-embedding-models-and-api-updates/)      |74.05 | 74.48   | 82.52     | 77.58        | 93.58   | 53.32        | 62.35                |
+| [cl-nagoya/ruri-large-v2](https://huggingface.co/cl-nagoya/ruri-large-v2)     |74.55     | 76.34       | 83.17     | 77.18            | 93.21       | 52.14        | 62.27                |
+|[Sarashina-Embedding-v1-1B](https://huggingface.co/sbintuitions/sarashina-embedding-v1-1b)|75.50|77.61|82.71|**78.37**|**93.74**|**53.86**|62.00|
+|||
+|[**PLaMo-Embedding-1B**](https://huggingface.co/pfnet/plamo-embedding-1b) (This model) (*)|**76.10**|**79.94**|**83.14**|77.20|93.57|53.47|62.37|
+
+(*): コンテキスト長1024で計測。モデルとしてはコンテキスト長4096まで対応していますが、学習時に入れているコンテキスト長が1024までのため、1024で計測しています。ただし、4096で評価してもそこまでスコア平均に影響がないことがわかっています ([Tech Blog](https://tech.preferred.jp/ja/blog/plamo-embedding-1b/)参照 (Ja))。
+
+## モデル詳細
+
+- モデルサイズ: 1B
+- 最大コンテキスト長: 4096トークン
+- 埋め込み次元: 2048
+- 類似度計測に用いる関数: cosine類似度
+- 開発元: Preferred Networks, Inc
+- 対応言語: 日本語
+- ライセンス: [Apache v2.0](https://www.apache.org/licenses/LICENSE-2.0)
+
+## ライセンス
+
+PLaMo-Embedding-1Bは [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0) のもとで公開されており、商用利用を含めて自由にお使い頂けます。
+
+
+## How to cite
+
+```
+@online{PLaMoEmbedding1B,
+    author    = {Preferred Networks, Inc},
+    title     = {PLaMo-Embedding-1B},
+    year      = {2025},
+    url       = {https://huggingface.co/pfnet/plamo-embedding-1b},
+    urldate   = {2025-04-17}
+}
+```