Add new SentenceTransformer model.

README.md

@@ -1,201 +1,387 @@
 ---
 base_model: colorfulscoop/sbert-base-ja
-language: ja
-license: cc-by-sa-4.0
-model_name: LeoChiuu/sbert-base-ja-arc
+library_name: sentence-transformers
+metrics:
+- accuracy
+pipeline_tag: sentence-similarity
+tags:
+- sentence-transformers
+- sentence-similarity
+- feature-extraction
+- generated_from_trainer
+- dataset_size:5330
+- loss:SoftmaxLoss
+widget:
+- source_sentence: 顔 に マスク を かぶった 男性 は 、 測定 中 に 残した すべて の 作業 を 一 時 停止 して い ます 。
+  sentences:
+  - 誰 か が マスク を して いる 。
+  - 緑 の 服 を 着た 女性 が 、 別の 男性 の 顔 に 何 か を 書き ます 。
+  - 男性 が 女性 に キス して い ます 。
+- source_sentence: 女の子 は 、 バレーボール を スパイク に ジャンプ し ます 。
+  sentences:
+  - ベンチ で 昼寝 を して いる 男
+  - プロパガンダ は 反戦 です 。
+  - 女の子 が ジャンプ し ます 。
+- source_sentence: ステージ で ドラム を 演奏 する 男 。
+  sentences:
+  - 男 が ステージ で リズム を 作り ます 。
+  - 女性 は 頭 を 覆って いる
+  - ２ 人 の 女性 が リビング ルーム に 座って レシピ を 議論 して い ます 。
+- source_sentence: 青い シャツ を 着て フィールド を 耕す 東洋 の 帽子 を 持つ 男 。
+  sentences:
+  - 男 が 水 を サーフィン して いる
+  - 子犬 と ビーチ を 訪れた 人々
+  - バイク に 乗る 男
+- source_sentence: 水着 姿 の 少女 に バケツ の 水 を 注ぐ ウォーター パーク の 少年 。
+  sentences:
+  - 騎士 たち は 、 溶けた 鉛 の バケツ を 城壁 の 下 の 不幸な 農奴 に 注ぎ ます 。
+  - 誰 も 歩いて い ない
+  - 僧 ｋｓ は にぎやかな 通り を 渡り ます 。
+model-index:
+- name: SentenceTransformer based on colorfulscoop/sbert-base-ja
+  results:
+  - task:
+      type: label-accuracy
+      name: Label Accuracy
+    dataset:
+      name: val
+      type: val
+    metrics:
+    - type: accuracy
+      value: 0.7782363977485929
+      name: Accuracy
 ---
 
-# Model Card for LeoChiuu/sbert-base-ja-arc
-
-<!-- Provide a quick summary of what the model is/does. -->
-
+# SentenceTransformer based on colorfulscoop/sbert-base-ja
 
+This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [colorfulscoop/sbert-base-ja](https://huggingface.co/colorfulscoop/sbert-base-ja) on the csv dataset. It maps sentences & paragraphs to a 768-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, text classification, clustering, and more.
 
 ## Model Details
 
 ### Model Description
+- **Model Type:** Sentence Transformer
+- **Base model:** [colorfulscoop/sbert-base-ja](https://huggingface.co/colorfulscoop/sbert-base-ja) <!-- at revision ecb8a98cd5176719ff7ab0d770a27420118732cf -->
+- **Maximum Sequence Length:** 512 tokens
+- **Output Dimensionality:** 768 tokens
+- **Similarity Function:** Cosine Similarity
+- **Training Dataset:**
+    - csv
+<!-- - **Language:** Unknown -->
+<!-- - **License:** Unknown -->
 
-<!-- Provide a longer summary of what this model is. -->
-
-Generates similarity embeddings
-
-- **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):** ja
-- **License:** cc-by-sa-4.0
-- **Finetuned from model [optional]:** colorfulscoop/sbert-base-ja
-
-### Model Sources [optional]
+### Model Sources
 
-<!-- Provide the basic links for the model. -->
+- **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
+- **Repository:** [Sentence Transformers on GitHub](https://github.com/UKPLab/sentence-transformers)
+- **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers)
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+### Full Model Architecture
 
-## Uses
+```
+SentenceTransformer(
+  (0): Transformer({'max_seq_length': 512, 'do_lower_case': False}) with Transformer model: BertModel 
+  (1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, 'include_prompt': True})
+)
+```
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+## Usage
 
-### Direct Use
+### Direct Usage (Sentence Transformers)
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+First install the Sentence Transformers library:
 
-[More Information Needed]
+```bash
+pip install -U sentence-transformers
+```
 
-### 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
+Then you can load this model and run inference.
+```python
+from sentence_transformers import SentenceTransformer
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+# Download from the 🤗 Hub
+model = SentenceTransformer("sentence_transformers_model_id")
+# Run inference
+sentences = [
+    '水着 姿 の 少女 に バケツ の 水 を 注ぐ ウォーター パーク の 少年 。',
+    '騎士 たち は 、 溶けた 鉛 の バケツ を 城壁 の 下 の 不幸な 農奴 に 注ぎ ます 。',
+    '僧 ｋｓ は にぎやかな 通り を 渡り ます 。',
+]
+embeddings = model.encode(sentences)
+print(embeddings.shape)
+# [3, 768]
 
-[More Information Needed]
+# Get the similarity scores for the embeddings
+similarities = model.similarity(embeddings, embeddings)
+print(similarities.shape)
+# [3, 3]
+```
 
-## Bias, Risks, and Limitations
+<!--
+### Direct Usage (Transformers)
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+<details><summary>Click to see the direct usage in Transformers</summary>
 
-[More Information Needed]
+</details>
+-->
 
-### 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]
-
-## Training Details
+<!--
+### Downstream Usage (Sentence Transformers)
 
-### Training Data
+You can finetune this model on your own dataset.
 
-<!-- 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. -->
+<details><summary>Click to expand</summary>
 
-[More Information Needed]
+</details>
+-->
 
-### 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. -->
+<!--
+### Out-of-Scope Use
 
-[More Information Needed]
+*List how the model may foreseeably be misused and address what users ought not to do with the model.*
+-->
 
 ## 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
 
-#### Metrics
+#### Label Accuracy
+* Dataset: `val`
+* Evaluated with [<code>LabelAccuracyEvaluator</code>](https://sbert.net/docs/package_reference/sentence_transformer/evaluation.html#sentence_transformers.evaluation.LabelAccuracyEvaluator)
 
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
+| Metric       | Value      |
+|:-------------|:-----------|
+| **accuracy** | **0.7782** |
 
-[More Information Needed]
+<!--
+## Bias, Risks and Limitations
 
-### Results
+*What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
+-->
 
-[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]
+<!--
+### Recommendations
 
-## Model Card Authors [optional]
+*What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
+-->
 
-[More Information Needed]
+## Training Details
 
+### Training Dataset
+
+#### csv
+
+* Dataset: csv
+* Size: 5,330 training samples
+* Columns: <code>sentence_0</code>, <code>sentence_1</code>, and <code>label</code>
+* Approximate statistics based on the first 1000 samples:
+  |         | sentence_0                                                                         | sentence_1                                                                        | label                                           |
+  |:--------|:-----------------------------------------------------------------------------------|:----------------------------------------------------------------------------------|:------------------------------------------------|
+  | type    | string                                                                             | string                                                                            | int                                             |
+  | details | <ul><li>min: 7 tokens</li><li>mean: 35.79 tokens</li><li>max: 177 tokens</li></ul> | <ul><li>min: 4 tokens</li><li>mean: 22.66 tokens</li><li>max: 77 tokens</li></ul> | <ul><li>0: ~32.80%</li><li>1: ~67.20%</li></ul> |
+* Samples:
+  | sentence_0                                                            | sentence_1                                | label          |
+  |:----------------------------------------------------------------------|:------------------------------------------|:---------------|
+  | <code>薬剤 師 が 処方 を 準備 して い ます 。</code>                                 | <code>薬剤 師 が 自宅 の ソファ に 座って い ます 。</code> | <code>1</code> |
+  | <code>３ 人 の 男性 が 小屋 を 背景 に 象 に 乗って おり 、 ２ 人 が 帽子 を かぶって い ます 。</code> | <code>一 人 の 男 は 帽子 を かぶって い ませ ん 。</code> | <code>0</code> |
+  | <code>茶色 の 犬 と の クロスカントリー スキー の 女性 。</code>                           | <code>草 は 緑 でした</code>                    | <code>1</code> |
+* Loss: [<code>SoftmaxLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#softmaxloss)
+
+### Evaluation Dataset
+
+#### csv
+
+* Dataset: csv
+* Size: 5,330 evaluation samples
+* Columns: <code>text1</code>, <code>text2</code>, and <code>label</code>
+* Approximate statistics based on the first 1000 samples:
+  |         | text1                                                                               | text2                                                                             | label                                           |
+  |:--------|:------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------|:------------------------------------------------|
+  | type    | string                                                                              | string                                                                            | int                                             |
+  | details | <ul><li>min: 12 tokens</li><li>mean: 36.61 tokens</li><li>max: 108 tokens</li></ul> | <ul><li>min: 6 tokens</li><li>mean: 22.81 tokens</li><li>max: 68 tokens</li></ul> | <ul><li>0: ~32.90%</li><li>1: ~67.10%</li></ul> |
+* Samples:
+  | text1                                                                       | text2                                                    | label          |
+  |:----------------------------------------------------------------------------|:---------------------------------------------------------|:---------------|
+  | <code>青い ジャージ の 裏 に １０ 番 の ソフトボール プレーヤー が ホーム プレート に 向かって 走って い ます 。</code> | <code>ソフトボール 選手 は １０ 番 です</code>                         | <code>0</code> |
+  | <code>山 の 湖 の そば の 岩 だらけ の 道 で 自転車 に 乗る 男 。</code>                          | <code>自転車 の 男</code>                                     | <code>0</code> |
+  | <code>テント の 前 の 芝生 の 椅子 に 座って いる 赤い ひげ を 生やした ひげ を 生やした 男性 。</code>         | <code>顔 の 毛 の ない 男性 と 青い シャツ を 着た 女性 が 座って い ます 。</code> | <code>1</code> |
+* Loss: [<code>SoftmaxLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#softmaxloss)
+
+### Training Hyperparameters
+#### Non-Default Hyperparameters
+
+- `eval_strategy`: steps
+- `num_train_epochs`: 1
+- `multi_dataset_batch_sampler`: round_robin
+
+#### All Hyperparameters
+<details><summary>Click to expand</summary>
+
+- `overwrite_output_dir`: False
+- `do_predict`: False
+- `eval_strategy`: steps
+- `prediction_loss_only`: True
+- `per_device_train_batch_size`: 8
+- `per_device_eval_batch_size`: 8
+- `per_gpu_train_batch_size`: None
+- `per_gpu_eval_batch_size`: None
+- `gradient_accumulation_steps`: 1
+- `eval_accumulation_steps`: None
+- `torch_empty_cache_steps`: None
+- `learning_rate`: 5e-05
+- `weight_decay`: 0.0
+- `adam_beta1`: 0.9
+- `adam_beta2`: 0.999
+- `adam_epsilon`: 1e-08
+- `max_grad_norm`: 1
+- `num_train_epochs`: 1
+- `max_steps`: -1
+- `lr_scheduler_type`: linear
+- `lr_scheduler_kwargs`: {}
+- `warmup_ratio`: 0.0
+- `warmup_steps`: 0
+- `log_level`: passive
+- `log_level_replica`: warning
+- `log_on_each_node`: True
+- `logging_nan_inf_filter`: True
+- `save_safetensors`: True
+- `save_on_each_node`: False
+- `save_only_model`: False
+- `restore_callback_states_from_checkpoint`: False
+- `no_cuda`: False
+- `use_cpu`: False
+- `use_mps_device`: False
+- `seed`: 42
+- `data_seed`: None
+- `jit_mode_eval`: False
+- `use_ipex`: False
+- `bf16`: False
+- `fp16`: False
+- `fp16_opt_level`: O1
+- `half_precision_backend`: auto
+- `bf16_full_eval`: False
+- `fp16_full_eval`: False
+- `tf32`: None
+- `local_rank`: 0
+- `ddp_backend`: None
+- `tpu_num_cores`: None
+- `tpu_metrics_debug`: False
+- `debug`: []
+- `dataloader_drop_last`: False
+- `dataloader_num_workers`: 0
+- `dataloader_prefetch_factor`: None
+- `past_index`: -1
+- `disable_tqdm`: False
+- `remove_unused_columns`: True
+- `label_names`: None
+- `load_best_model_at_end`: False
+- `ignore_data_skip`: False
+- `fsdp`: []
+- `fsdp_min_num_params`: 0
+- `fsdp_config`: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}
+- `fsdp_transformer_layer_cls_to_wrap`: None
+- `accelerator_config`: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}
+- `deepspeed`: None
+- `label_smoothing_factor`: 0.0
+- `optim`: adamw_torch
+- `optim_args`: None
+- `adafactor`: False
+- `group_by_length`: False
+- `length_column_name`: length
+- `ddp_find_unused_parameters`: None
+- `ddp_bucket_cap_mb`: None
+- `ddp_broadcast_buffers`: False
+- `dataloader_pin_memory`: True
+- `dataloader_persistent_workers`: False
+- `skip_memory_metrics`: True
+- `use_legacy_prediction_loop`: False
+- `push_to_hub`: False
+- `resume_from_checkpoint`: None
+- `hub_model_id`: None
+- `hub_strategy`: every_save
+- `hub_private_repo`: False
+- `hub_always_push`: False
+- `gradient_checkpointing`: False
+- `gradient_checkpointing_kwargs`: None
+- `include_inputs_for_metrics`: False
+- `eval_do_concat_batches`: True
+- `fp16_backend`: auto
+- `push_to_hub_model_id`: None
+- `push_to_hub_organization`: None
+- `mp_parameters`: 
+- `auto_find_batch_size`: False
+- `full_determinism`: False
+- `torchdynamo`: None
+- `ray_scope`: last
+- `ddp_timeout`: 1800
+- `torch_compile`: False
+- `torch_compile_backend`: None
+- `torch_compile_mode`: None
+- `dispatch_batches`: None
+- `split_batches`: None
+- `include_tokens_per_second`: False
+- `include_num_input_tokens_seen`: False
+- `neftune_noise_alpha`: None
+- `optim_target_modules`: None
+- `batch_eval_metrics`: False
+- `eval_on_start`: False
+- `eval_use_gather_object`: False
+- `batch_sampler`: batch_sampler
+- `multi_dataset_batch_sampler`: round_robin
+
+</details>
+
+### Training Logs
+| Epoch  | Step | val_accuracy |
+|:------:|:----:|:------------:|
+| 0.1497 | 50   | 0.7265       |
+| 0.2994 | 100  | 0.7696       |
+| 0.4491 | 150  | 0.7715       |
+| 0.5988 | 200  | 0.7659       |
+| 0.7485 | 250  | 0.7790       |
+| 0.8982 | 300  | 0.7771       |
+| 1.0    | 334  | 0.7782       |
+
+
+### Framework Versions
+- Python: 3.10.14
+- Sentence Transformers: 3.1.0
+- Transformers: 4.44.2
+- PyTorch: 2.4.1+cu121
+- Accelerate: 0.34.2
+- Datasets: 2.20.0
+- Tokenizers: 0.19.1
+
+## Citation
+
+### BibTeX
+
+#### Sentence Transformers and SoftmaxLoss
+```bibtex
+@inproceedings{reimers-2019-sentence-bert,
+    title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks",
+    author = "Reimers, Nils and Gurevych, Iryna",
+    booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing",
+    month = "11",
+    year = "2019",
+    publisher = "Association for Computational Linguistics",
+    url = "https://arxiv.org/abs/1908.10084",
+}
+```
+
+<!--
+## Glossary
+
+*Clearly define terms in order to be accessible across audiences.*
+-->
+
+<!--
+## Model Card Authors
+
+*Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
+-->
+
+<!--
 ## Model Card Contact
 
-[More Information Needed]
+*Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
+-->

model.safetensors

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:767031afc79755e5cf8eeeab86900a2e8924bd3eefac36867eefdd14168dd4bd
+oid sha256:b7d48d5817dcd227deb4ec7ee5a28d9c10ba06a33946d13683f3a9d83b286744
 size 442491744

runs/Sep16_22-40-15_default/events.out.tfevents.1726526417.default.5280.0

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1460a3634c1d755164e174435ce188f5d7ab91e529b16e7a514279f9e17071cc
+size 4489