Upload README.md with huggingface_hub

README.md

@@ -1,567 +1,201 @@
 ---
 base_model: colorfulscoop/sbert-base-ja
-library_name: sentence-transformers
-metrics:
-- cosine_accuracy
-- cosine_accuracy_threshold
-- cosine_f1
-- cosine_f1_threshold
-- cosine_precision
-- cosine_recall
-- cosine_ap
-- dot_accuracy
-- dot_accuracy_threshold
-- dot_f1
-- dot_f1_threshold
-- dot_precision
-- dot_recall
-- dot_ap
-- manhattan_accuracy
-- manhattan_accuracy_threshold
-- manhattan_f1
-- manhattan_f1_threshold
-- manhattan_precision
-- manhattan_recall
-- manhattan_ap
-- euclidean_accuracy
-- euclidean_accuracy_threshold
-- euclidean_f1
-- euclidean_f1_threshold
-- euclidean_precision
-- euclidean_recall
-- euclidean_ap
-- max_accuracy
-- max_accuracy_threshold
-- max_f1
-- max_f1_threshold
-- max_precision
-- max_recall
-- max_ap
-pipeline_tag: sentence-similarity
-tags:
-- sentence-transformers
-- sentence-similarity
-- feature-extraction
-- generated_from_trainer
-- dataset_size:53
-- loss:OnlineContrastiveLoss
-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: binary-classification
-      name: Binary Classification
-    dataset:
-      name: custom arc semantics data jp
-      type: custom-arc-semantics-data-jp
-    metrics:
-    - type: cosine_accuracy
-      value: 0.6875
-      name: Cosine Accuracy
-    - type: cosine_accuracy_threshold
-      value: 0.768845796585083
-      name: Cosine Accuracy Threshold
-    - type: cosine_f1
-      value: 0.8
-      name: Cosine F1
-    - type: cosine_f1_threshold
-      value: 0.768845796585083
-      name: Cosine F1 Threshold
-    - type: cosine_precision
-      value: 0.7142857142857143
-      name: Cosine Precision
-    - type: cosine_recall
-      value: 0.9090909090909091
-      name: Cosine Recall
-    - type: cosine_ap
-      value: 0.5892046085227903
-      name: Cosine Ap
-    - type: dot_accuracy
-      value: 0.6875
-      name: Dot Accuracy
-    - type: dot_accuracy_threshold
-      value: 444.5765380859375
-      name: Dot Accuracy Threshold
-    - type: dot_f1
-      value: 0.8
-      name: Dot F1
-    - type: dot_f1_threshold
-      value: 444.5765380859375
-      name: Dot F1 Threshold
-    - type: dot_precision
-      value: 0.7142857142857143
-      name: Dot Precision
-    - type: dot_recall
-      value: 0.9090909090909091
-      name: Dot Recall
-    - type: dot_ap
-      value: 0.6085047528229346
-      name: Dot Ap
-    - type: manhattan_accuracy
-      value: 0.6875
-      name: Manhattan Accuracy
-    - type: manhattan_accuracy_threshold
-      value: 361.7544860839844
-      name: Manhattan Accuracy Threshold
-    - type: manhattan_f1
-      value: 0.8
-      name: Manhattan F1
-    - type: manhattan_f1_threshold
-      value: 361.7544860839844
-      name: Manhattan F1 Threshold
-    - type: manhattan_precision
-      value: 0.7142857142857143
-      name: Manhattan Precision
-    - type: manhattan_recall
-      value: 0.9090909090909091
-      name: Manhattan Recall
-    - type: manhattan_ap
-      value: 0.5892046085227903
-      name: Manhattan Ap
-    - type: euclidean_accuracy
-      value: 0.6875
-      name: Euclidean Accuracy
-    - type: euclidean_accuracy_threshold
-      value: 16.331390380859375
-      name: Euclidean Accuracy Threshold
-    - type: euclidean_f1
-      value: 0.8
-      name: Euclidean F1
-    - type: euclidean_f1_threshold
-      value: 16.331390380859375
-      name: Euclidean F1 Threshold
-    - type: euclidean_precision
-      value: 0.7142857142857143
-      name: Euclidean Precision
-    - type: euclidean_recall
-      value: 0.9090909090909091
-      name: Euclidean Recall
-    - type: euclidean_ap
-      value: 0.5892046085227903
-      name: Euclidean Ap
-    - type: max_accuracy
-      value: 0.6875
-      name: Max Accuracy
-    - type: max_accuracy_threshold
-      value: 444.5765380859375
-      name: Max Accuracy Threshold
-    - type: max_f1
-      value: 0.8
-      name: Max F1
-    - type: max_f1_threshold
-      value: 444.5765380859375
-      name: Max F1 Threshold
-    - type: max_precision
-      value: 0.7142857142857143
-      name: Max Precision
-    - type: max_recall
-      value: 0.9090909090909091
-      name: Max Recall
-    - type: max_ap
-      value: 0.6085047528229346
-      name: Max Ap
+language: ja
+license: cc-by-sa-4.0
+model_name: LeoChiuu/sbert-base-ja-arc
 ---
 
-# SentenceTransformer based on colorfulscoop/sbert-base-ja
+# Model Card for LeoChiuu/sbert-base-ja-arc
+
+<!-- Provide a quick summary of what the model is/does. -->
+
 
-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 -->
 
-### Model Sources
+<!-- Provide a longer summary of what this model is. -->
 
-- **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)
+Generates similarity embeddings
 
-### Full Model Architecture
+- **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
 
-```
-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})
-)
-```
+### Model Sources [optional]
 
-## Usage
+<!-- Provide the basic links for the model. -->
 
-### Direct Usage (Sentence Transformers)
+- **Repository:** [More Information Needed]
+- **Paper [optional]:** [More Information Needed]
+- **Demo [optional]:** [More Information Needed]
 
-First install the Sentence Transformers library:
+## Uses
 
-```bash
-pip install -U sentence-transformers
-```
+<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
-Then you can load this model and run inference.
-```python
-from sentence_transformers import SentenceTransformer
+### Direct Use
 
-# Download from the 🤗 Hub
-model = SentenceTransformer("sentence_transformers_model_id")
-# Run inference
-sentences = [
-    '黒い 長い 髪 を した 女性 が 、 黒い ベルト の 付いた 赤い ドレス を 着て 歩いて い ます 。',
-    '女性 は 髪 を 切った 。',
-    '女の子 は 、 かつて 木 が 立って いた 裏庭 を 見 ながら 中 に い ました 。',
-]
-embeddings = model.encode(sentences)
-print(embeddings.shape)
-# [3, 768]
+<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
-# Get the similarity scores for the embeddings
-similarities = model.similarity(embeddings, embeddings)
-print(similarities.shape)
-# [3, 3]
-```
+[More Information Needed]
 
-<!--
-### Direct Usage (Transformers)
+### Downstream Use [optional]
 
-<details><summary>Click to see the direct usage in Transformers</summary>
+<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
 
-</details>
--->
+[More Information Needed]
 
-<!--
-### Downstream Usage (Sentence Transformers)
+### Out-of-Scope Use
 
-You can finetune this model on your own dataset.
+<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
-<details><summary>Click to expand</summary>
+[More Information Needed]
 
-</details>
--->
+## Bias, Risks, and Limitations
 
-<!--
-### Out-of-Scope Use
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-*List how the model may foreseeably be misused and address what users ought not to do with the model.*
--->
+[More Information Needed]
 
-## Evaluation
-
-### Metrics
-
-#### Binary Classification
-* Dataset: `custom-arc-semantics-data-jp`
-* Evaluated with [<code>BinaryClassificationEvaluator</code>](https://sbert.net/docs/package_reference/sentence_transformer/evaluation.html#sentence_transformers.evaluation.BinaryClassificationEvaluator)
-
-| Metric                       | Value      |
-|:-----------------------------|:-----------|
-| cosine_accuracy              | 0.6875     |
-| cosine_accuracy_threshold    | 0.7688     |
-| cosine_f1                    | 0.8        |
-| cosine_f1_threshold          | 0.7688     |
-| cosine_precision             | 0.7143     |
-| cosine_recall                | 0.9091     |
-| cosine_ap                    | 0.5892     |
-| dot_accuracy                 | 0.6875     |
-| dot_accuracy_threshold       | 444.5765   |
-| dot_f1                       | 0.8        |
-| dot_f1_threshold             | 444.5765   |
-| dot_precision                | 0.7143     |
-| dot_recall                   | 0.9091     |
-| dot_ap                       | 0.6085     |
-| manhattan_accuracy           | 0.6875     |
-| manhattan_accuracy_threshold | 361.7545   |
-| manhattan_f1                 | 0.8        |
-| manhattan_f1_threshold       | 361.7545   |
-| manhattan_precision          | 0.7143     |
-| manhattan_recall             | 0.9091     |
-| manhattan_ap                 | 0.5892     |
-| euclidean_accuracy           | 0.6875     |
-| euclidean_accuracy_threshold | 16.3314    |
-| euclidean_f1                 | 0.8        |
-| euclidean_f1_threshold       | 16.3314    |
-| euclidean_precision          | 0.7143     |
-| euclidean_recall             | 0.9091     |
-| euclidean_ap                 | 0.5892     |
-| max_accuracy                 | 0.6875     |
-| max_accuracy_threshold       | 444.5765   |
-| max_f1                       | 0.8        |
-| max_f1_threshold             | 444.5765   |
-| max_precision                | 0.7143     |
-| max_recall                   | 0.9091     |
-| **max_ap**                   | **0.6085** |
-
-<!--
-## Bias, Risks and Limitations
-
-*What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
--->
-
-<!--
 ### Recommendations
 
-*What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
--->
+<!-- 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
 
-### Training Dataset
-
-#### csv
-
-* Dataset: csv
-* Size: 53 training samples
-* Columns: <code>text1</code>, <code>text2</code>, and <code>label</code>
-* Approximate statistics based on the first 53 samples:
-  |         | text1                                                                              | text2                                                                              | label                                           |
-  |:--------|:-----------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------|:------------------------------------------------|
-  | type    | string                                                                             | string                                                                             | int                                             |
-  | details | <ul><li>min: 14 tokens</li><li>mean: 35.14 tokens</li><li>max: 79 tokens</li></ul> | <ul><li>min: 11 tokens</li><li>mean: 20.81 tokens</li><li>max: 38 tokens</li></ul> | <ul><li>0: ~37.84%</li><li>1: ~62.16%</li></ul> |
-* Samples:
-  | text1                                                    | text2                                            | label          |
-  |:---------------------------------------------------------|:-------------------------------------------------|:---------------|
-  | <code>眼鏡 を かけて いる ３ 人 が 写真 の ポーズ を とり ます 。</code>        | <code>人々 は 眼鏡 を かけて い ます</code>                  | <code>0</code> |
-  | <code>帽子 を かぶった 一 人 の 男 が 別の 男 を 芝生 に ひっくり返��� ます 。</code> | <code>二 人 の 男 が 芝生 で パルクール を 練習 して い ます 。</code> | <code>1</code> |
-  | <code>４ 人 が 見て いる 間 に 、 アジア の カップル が 結婚 して い ます 。</code> | <code>人々 は 結婚 して い ます 。</code>                   | <code>0</code> |
-* Loss: [<code>OnlineContrastiveLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#onlinecontrastiveloss)
-
-### Evaluation Dataset
-
-#### csv
-
-* Dataset: csv
-* Size: 53 evaluation samples
-* Columns: <code>text1</code>, <code>text2</code>, and <code>label</code>
-* Approximate statistics based on the first 53 samples:
-  |         | text1                                                                              | text2                                                                              | label                                           |
-  |:--------|:-----------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------|:------------------------------------------------|
-  | type    | string                                                                             | string                                                                             | int                                             |
-  | details | <ul><li>min: 19 tokens</li><li>mean: 38.81 tokens</li><li>max: 84 tokens</li></ul> | <ul><li>min: 14 tokens</li><li>mean: 25.25 tokens</li><li>max: 38 tokens</li></ul> | <ul><li>0: ~31.25%</li><li>1: ~68.75%</li></ul> |
-* Samples:
-  | text1                                                                                                     | text2                                           | label          |
-  |:----------------------------------------------------------------------------------------------------------|:------------------------------------------------|:---------------|
-  | <code>岩 の 多い 景色 を 見て 二 人</code>                                                                           | <code>何 か を 見て いる 二 人 が い ます 。</code>           | <code>0</code> |
-  | <code>白い ヘルメット と オレンジ色 の シャツ 、 ジーンズ 、 白い トラック と オレンジ色 の パイロン の 前 に 反射 ジャケット を 着た 金髪 の ストリート ワーカー 。</code> | <code>ストリート ワーカー は 保護 具 を 着用 して い ませ ん 。</code> | <code>1</code> |
-  | <code>白い 帽子 を かぶった 女性 が 、 鮮やかな 色 の 岩 の 風景 を 描いて い ます 。 岩 層 自体 が 背景 に 見え ます 。</code>                       | <code>誰 か が 肖像 画 を 描いて い ます 。</code>            | <code>1</code> |
-* Loss: [<code>OnlineContrastiveLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#onlinecontrastiveloss)
-
-### Training Hyperparameters
-#### Non-Default Hyperparameters
-
-- `eval_strategy`: epoch
-- `learning_rate`: 1e-05
-- `num_train_epochs`: 14
-- `warmup_ratio`: 0.4
-- `fp16`: True
-- `batch_sampler`: no_duplicates
-
-#### All Hyperparameters
-<details><summary>Click to expand</summary>
-
-- `overwrite_output_dir`: False
-- `do_predict`: False
-- `eval_strategy`: epoch
-- `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`: 1e-05
-- `weight_decay`: 0.0
-- `adam_beta1`: 0.9
-- `adam_beta2`: 0.999
-- `adam_epsilon`: 1e-08
-- `max_grad_norm`: 1.0
-- `num_train_epochs`: 14
-- `max_steps`: -1
-- `lr_scheduler_type`: linear
-- `lr_scheduler_kwargs`: {}
-- `warmup_ratio`: 0.4
-- `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`: True
-- `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`: no_duplicates
-- `multi_dataset_batch_sampler`: proportional
-
-</details>
-
-### Training Logs
-| Epoch | Step | Training Loss | loss   | custom-arc-semantics-data-jp_max_ap |
-|:-----:|:----:|:-------------:|:------:|:-----------------------------------:|
-| 1.0   | 5    | 0.6806        | 1.1394 | 0.5849                              |
-| 2.0   | 10   | 0.7554        | 1.1194 | 0.5849                              |
-| 3.0   | 15   | 0.6567        | 1.0649 | 0.6000                              |
-| 4.0   | 20   | 0.5506        | 1.0103 | 0.6000                              |
-| 5.0   | 25   | 0.4127        | 0.9281 | 0.6000                              |
-| 6.0   | 30   | 0.3796        | 0.8287 | 0.5892                              |
-| 7.0   | 35   | 0.2532        | 0.7318 | 0.5892                              |
-| 8.0   | 40   | 0.2304        | 0.6558 | 0.6022                              |
-| 9.0   | 45   | 0.1291        | 0.5996 | 0.6085                              |
-| 10.0  | 50   | 0.0749        | 0.5608 | 0.6085                              |
-| 11.0  | 55   | 0.096         | 0.5398 | 0.6085                              |
-| 12.0  | 60   | 0.0631        | 0.5270 | 0.6085                              |
-| 13.0  | 65   | 0.0626        | 0.5198 | 0.6085                              |
-| 14.0  | 70   | 0.0609        | 0.5172 | 0.6085                              |
-
-
-### 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
-```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.*
--->
-
-<!--
+### Training Data
+
+<!-- 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. -->
+
+[More Information Needed]
+
+### 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. -->
+
+[More Information Needed]
+
+## 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
+
+<!-- These are the evaluation metrics being used, ideally with a description of why. -->
+
+[More Information Needed]
+
+### Results
+
+[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]
+
+## Model Card Authors [optional]
+
+[More Information Needed]
+
 ## Model Card Contact
 
-*Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
--->
+[More Information Needed]