Upload README.md with huggingface_hub

README.md

@@ -1,362 +1,201 @@
 ---
-base_model: colorfulscoop/sbert-base-ja
-datasets: []
-language: []
-library_name: sentence-transformers
-metrics:
-- accuracy
-pipeline_tag: sentence-similarity
-tags:
-- sentence-transformers
-- sentence-similarity
-- feature-extraction
-- generated_from_trainer
-- dataset_size:124
-- 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.8387096774193549
-      name: Accuracy
+datasets: custom-data
+language: en
+license: apache-2.0
+model_name: LeoChiuu/sbert-base-ja
 ---
 
-# SentenceTransformer based on colorfulscoop/sbert-base-ja
+# Model Card for LeoChiuu/sbert-base-ja
+
+<!-- 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). 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:** Unknown -->
-<!-- - **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)
+Binary classification of sentences
 
-### 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):** en
+- **License:** apache-2.0
+- **Finetuned from model [optional]:** [More Information Needed]
 
-```
-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:** https://github.com/huggingface/huggingface_hub
+- **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("LeoChiuu/sbert-base-ja")
-# 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. -->
+
+[More Information Needed]
+
+### 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
+
+### 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]
 
-*List how the model may foreseeably be misused and address what users ought not to do with the model.*
--->
+### 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
 
-### Metrics
+<!-- This section describes the evaluation protocols and provides the results. -->
 
-#### Label Accuracy
-* Dataset: `val`
-* Evaluated with [<code>LabelAccuracyEvaluator</code>](https://sbert.net/docs/package_reference/sentence_transformer/evaluation.html#sentence_transformers.evaluation.LabelAccuracyEvaluator)
+### Testing Data, Factors & Metrics
 
-| Metric       | Value      |
-|:-------------|:-----------|
-| **accuracy** | **0.8387** |
+#### Testing Data
 
-<!--
-## Bias, Risks and Limitations
+<!-- This should link to a Dataset Card if possible. -->
 
-*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]
 
-<!--
-### Recommendations
+#### Factors
 
-*What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
--->
+<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
 
-## Training Details
+[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]
 
-### Training Dataset
-
-#### Unnamed Dataset
-
-
-* Size: 124 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: 4 tokens</li><li>mean: 8.59 tokens</li><li>max: 14 tokens</li></ul> | <ul><li>min: 5 tokens</li><li>mean: 8.58 tokens</li><li>max: 14 tokens</li></ul> | <ul><li>1: 100.00%</li></ul> |
-* Samples:
-  | sentence_0               | sentence_1                | label          |
-  |:-------------------------|:--------------------------|:---------------|
-  | <code>ビーフシチュー食べた？</code> | <code>ビーフシチュー作った？</code>  | <code>1</code> |
-  | <code>夜ごはんの時</code>      | <code>晩ご飯のとき</code>       | <code>1</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 |
-|:-----:|:----:|:------------:|
-| 1.0   | 16   | 0.8387       |
-
-
-### Framework Versions
-- Python: 3.10.14
-- Sentence Transformers: 3.0.1
-- Transformers: 4.44.2
-- PyTorch: 2.4.0+cu121
-- Accelerate: 0.34.0
-- 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
 
-*Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
--->
+[More Information Needed]