Marwolaeth
/

rubert-tiny-nli-terra-v0

@@ -1,199 +1,85 @@
 ---
 library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **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):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### 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
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- 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]
-### 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
-[More Information Needed]

 ---
 library_name: transformers
+tags:
+- nli
+- bert
+language:
+- ru
+metrics:
+- name: accuracy
+  type: accuracy
+  value: 66.78
+- name: f1
+  type: f1
+  value: 66.67
+- name: precision
+  type: precision
+  value: 66.67
+- name: recall
+  type: recall
+  value: 66.67
+base_model:
+- cointegrated/rubert-tiny2
+pipeline_tag: text-classification
 ---
+**⚠️ Disclaimer: This model is in the early stages of development and may produce low-quality predictions. For better results, consider using the recommended Russian natural language inference models available [here](https://huggingface.co/cointegrated).**
+# RuBERT-tiny-nli v0
+This model is an initial attempt to fine-tune the [RuBERT-tiny2](https://huggingface.co/cointegrated/rubert-tiny2) model for a two-way natural language inference task, utilizing the Russian [Textual Entailment Recognition](https://russiansuperglue.com/tasks/task_info/TERRa) dataset. While it aims to enhance understanding of Russian text, its performance is currently limited.
+## Usage
+How to run the model for NLI:
+```python
+# !pip install transformers sentencepiece --quiet
+import torch
+from transformers import AutoTokenizer, AutoModelForSequenceClassification
+model_id = 'Marwolaeth/rubert-tiny-nli-terra-v0'
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+model = AutoModelForSequenceClassification.from_pretrained(model_id)
+if torch.cuda.is_available():
+    model.cuda()
+# An example from the base model card
+premise1 = 'Сократ - человек, а все люди смертны.'
+hypothesis1 = 'Сократ никогда не умрёт.'
+with torch.inference_mode():
+    prediction = model(
+      **tokenizer(premise1, hypothesis1, return_tensors='pt').to(model.device)
+    )
+    p = torch.softmax(prediction.logits, -1).cpu().numpy()[0]
+print({v: p[k] for k, v in model.config.id2label.items()})
+# {'not_entailment': 0.7698182, 'entailment': 0.23018183}
+# An example concerning sentiments
+premise2 = 'Я ненавижу желтые занавески'
+hypothesis2 = 'Мне нравятся желтые занавески'
+with torch.inference_mode():
+    prediction = model(
+      **tokenizer(premise2, hypothesis2, return_tensors='pt').to(model.device)
+    )
+    p = torch.softmax(prediction.logits, -1).cpu().numpy()[0]
+print({v: p[k] for k, v in model.config.id2label.items()})
+# {'not_entailment': 0.60584205, 'entailment': 0.3941579}
+```
+## Model Performance Metrics
+The following metrics summarize the performance of the model on the test dataset:
+| Metric                     | Value                     |
+|----------------------------|---------------------------|
+| **Test Loss**              | 0.6261                    |
+| **Test Accuracy**          | 66.78%                    |
+| **Test F1 Score**          | 66.67%                    |
+| **Test Precision**         | 66.67%                    |
+| **Test Recall**            | 66.67%                    |
+| **Test Runtime***          | 0.7043 seconds            |
+| **Samples per Second***    | 435.88                    |
+| **Steps per Second***      | 14.20                     |
+*Using T4 GPU with Google Colab