Update README.md
Browse files
README.md
CHANGED
|
@@ -1,199 +1,114 @@
|
|
| 1 |
---
|
| 2 |
library_name: transformers
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 4 |
---
|
| 5 |
|
| 6 |
-
#
|
| 7 |
|
| 8 |
-
|
| 9 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 10 |
|
|
|
|
| 11 |
|
| 12 |
-
|
| 13 |
|
| 14 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 15 |
|
| 16 |
-
|
| 17 |
|
| 18 |
-
|
|
|
|
| 19 |
|
| 20 |
-
-
|
| 21 |
-
- **Funded by [optional]:** [More Information Needed]
|
| 22 |
-
- **Shared by [optional]:** [More Information Needed]
|
| 23 |
-
- **Model type:** [More Information Needed]
|
| 24 |
-
- **Language(s) (NLP):** [More Information Needed]
|
| 25 |
-
- **License:** [More Information Needed]
|
| 26 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
| 27 |
|
| 28 |
-
##
|
| 29 |
|
| 30 |
-
|
| 31 |
|
| 32 |
-
|
| 33 |
-
- **Paper [optional]:** [More Information Needed]
|
| 34 |
-
- **Demo [optional]:** [More Information Needed]
|
| 35 |
|
| 36 |
-
|
|
|
|
|
|
|
|
|
|
| 37 |
|
| 38 |
-
|
| 39 |
|
| 40 |
-
##
|
| 41 |
|
| 42 |
-
|
| 43 |
|
| 44 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 45 |
|
| 46 |
-
###
|
| 47 |
|
| 48 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 49 |
|
| 50 |
-
|
| 51 |
|
| 52 |
-
###
|
| 53 |
|
| 54 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 55 |
|
| 56 |
-
|
| 57 |
|
| 58 |
-
|
| 59 |
-
|
| 60 |
-
|
| 61 |
-
|
| 62 |
-
[More Information Needed]
|
| 63 |
-
|
| 64 |
-
### Recommendations
|
| 65 |
-
|
| 66 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
| 67 |
-
|
| 68 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
| 69 |
-
|
| 70 |
-
## How to Get Started with the Model
|
| 71 |
-
|
| 72 |
-
Use the code below to get started with the model.
|
| 73 |
-
|
| 74 |
-
[More Information Needed]
|
| 75 |
-
|
| 76 |
-
## Training Details
|
| 77 |
-
|
| 78 |
-
### Training Data
|
| 79 |
-
|
| 80 |
-
<!-- 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. -->
|
| 81 |
-
|
| 82 |
-
[More Information Needed]
|
| 83 |
-
|
| 84 |
-
### Training Procedure
|
| 85 |
-
|
| 86 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
| 87 |
-
|
| 88 |
-
#### Preprocessing [optional]
|
| 89 |
-
|
| 90 |
-
[More Information Needed]
|
| 91 |
-
|
| 92 |
-
|
| 93 |
-
#### Training Hyperparameters
|
| 94 |
-
|
| 95 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 96 |
-
|
| 97 |
-
#### Speeds, Sizes, Times [optional]
|
| 98 |
-
|
| 99 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
| 100 |
-
|
| 101 |
-
[More Information Needed]
|
| 102 |
-
|
| 103 |
-
## Evaluation
|
| 104 |
-
|
| 105 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
| 106 |
-
|
| 107 |
-
### Testing Data, Factors & Metrics
|
| 108 |
-
|
| 109 |
-
#### Testing Data
|
| 110 |
-
|
| 111 |
-
<!-- This should link to a Dataset Card if possible. -->
|
| 112 |
-
|
| 113 |
-
[More Information Needed]
|
| 114 |
-
|
| 115 |
-
#### Factors
|
| 116 |
-
|
| 117 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
| 118 |
-
|
| 119 |
-
[More Information Needed]
|
| 120 |
-
|
| 121 |
-
#### Metrics
|
| 122 |
-
|
| 123 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
| 124 |
-
|
| 125 |
-
[More Information Needed]
|
| 126 |
-
|
| 127 |
-
### Results
|
| 128 |
-
|
| 129 |
-
[More Information Needed]
|
| 130 |
-
|
| 131 |
-
#### Summary
|
| 132 |
-
|
| 133 |
-
|
| 134 |
-
|
| 135 |
-
## Model Examination [optional]
|
| 136 |
-
|
| 137 |
-
<!-- Relevant interpretability work for the model goes here -->
|
| 138 |
-
|
| 139 |
-
[More Information Needed]
|
| 140 |
-
|
| 141 |
-
## Environmental Impact
|
| 142 |
-
|
| 143 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
| 144 |
-
|
| 145 |
-
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).
|
| 146 |
-
|
| 147 |
-
- **Hardware Type:** [More Information Needed]
|
| 148 |
-
- **Hours used:** [More Information Needed]
|
| 149 |
-
- **Cloud Provider:** [More Information Needed]
|
| 150 |
-
- **Compute Region:** [More Information Needed]
|
| 151 |
-
- **Carbon Emitted:** [More Information Needed]
|
| 152 |
-
|
| 153 |
-
## Technical Specifications [optional]
|
| 154 |
-
|
| 155 |
-
### Model Architecture and Objective
|
| 156 |
-
|
| 157 |
-
[More Information Needed]
|
| 158 |
-
|
| 159 |
-
### Compute Infrastructure
|
| 160 |
-
|
| 161 |
-
[More Information Needed]
|
| 162 |
-
|
| 163 |
-
#### Hardware
|
| 164 |
-
|
| 165 |
-
[More Information Needed]
|
| 166 |
-
|
| 167 |
-
#### Software
|
| 168 |
-
|
| 169 |
-
[More Information Needed]
|
| 170 |
-
|
| 171 |
-
## Citation [optional]
|
| 172 |
-
|
| 173 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
| 174 |
-
|
| 175 |
-
**BibTeX:**
|
| 176 |
-
|
| 177 |
-
[More Information Needed]
|
| 178 |
-
|
| 179 |
-
**APA:**
|
| 180 |
-
|
| 181 |
-
[More Information Needed]
|
| 182 |
-
|
| 183 |
-
## Glossary [optional]
|
| 184 |
-
|
| 185 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
| 186 |
-
|
| 187 |
-
[More Information Needed]
|
| 188 |
-
|
| 189 |
-
## More Information [optional]
|
| 190 |
-
|
| 191 |
-
[More Information Needed]
|
| 192 |
-
|
| 193 |
-
## Model Card Authors [optional]
|
| 194 |
-
|
| 195 |
-
[More Information Needed]
|
| 196 |
-
|
| 197 |
-
## Model Card Contact
|
| 198 |
-
|
| 199 |
-
[More Information Needed]
|
|
|
|
| 1 |
---
|
| 2 |
library_name: transformers
|
| 3 |
+
base_model: DeepPavlov/rubert-base-cased
|
| 4 |
+
language:
|
| 5 |
+
- ru
|
| 6 |
+
tags:
|
| 7 |
+
- text-classification
|
| 8 |
+
- bert
|
| 9 |
+
- safetensors
|
| 10 |
+
- multilabel-classification
|
| 11 |
+
- requirements-engineering
|
| 12 |
+
- generated_from_trainer
|
| 13 |
+
model-index:
|
| 14 |
+
- name: rubert_level1_v2
|
| 15 |
+
results:
|
| 16 |
+
- task:
|
| 17 |
+
type: text-classification
|
| 18 |
+
metrics:
|
| 19 |
+
- type: loss
|
| 20 |
+
value: 0.0727
|
| 21 |
+
name: Validation Loss
|
| 22 |
+
- type: f1
|
| 23 |
+
value: 0.9749
|
| 24 |
+
name: F1 Micro
|
| 25 |
+
- type: f1
|
| 26 |
+
value: 0.9750
|
| 27 |
+
name: F1 Macro
|
| 28 |
+
- type: f1
|
| 29 |
+
value: 0.9750
|
| 30 |
+
name: F1 Weighted
|
| 31 |
---
|
| 32 |
|
| 33 |
+
# rubert_level1_v2
|
| 34 |
|
| 35 |
+
This model is a fine-tuned version of [DeepPavlov/rubert-base-cased](https://huggingface.co/DeepPavlov/rubert-base-cased) for multilabel classification of software requirements in Russian (Level 1).
|
| 36 |
|
| 37 |
+
It achieves the following results on the evaluation set:
|
| 38 |
+
* Loss: 0.0727
|
| 39 |
+
* F1 Micro: 0.9749
|
| 40 |
+
* F1 Macro: 0.9750
|
| 41 |
+
* F1 Weighted: 0.9750
|
| 42 |
|
| 43 |
+
## Model description
|
| 44 |
|
| 45 |
+
Level 1 classifier in a cascaded requirements classification pipeline. Classifies Russian-language text fragments from meeting recordings into three categories:
|
| 46 |
|
| 47 |
+
| Label | Description |
|
| 48 |
+
|---|---|
|
| 49 |
+
| `IsFunctional` | Functional requirements — what the system must do |
|
| 50 |
+
| `IsBusiness` | Business requirements — budgets, KPIs, deadlines, regulations |
|
| 51 |
+
| `Other (OT)` | Non-requirements — organizational remarks, transition phrases, context |
|
| 52 |
|
| 53 |
+
`IsNonFunctional` is derived automatically as OR over Level 2 predictions and is not predicted by this model directly.
|
| 54 |
|
| 55 |
+
The model is part of a cascaded pipeline:
|
| 56 |
+
`Audio → GigaAM-v3 (ASR) → rubert_level1_v2 (L1) → rubert_level2_v2 (L2) → Report`
|
| 57 |
|
| 58 |
+
Per-class classification thresholds are stored in `thresholds.json` in this repository.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 59 |
|
| 60 |
+
## Intended uses & limitations
|
| 61 |
|
| 62 |
+
Intended for classification of Russian-language software requirements extracted from meeting audio recordings. Not suitable for general-purpose text classification or non-Russian languages.
|
| 63 |
|
| 64 |
+
## Training and evaluation data
|
|
|
|
|
|
|
| 65 |
|
| 66 |
+
Custom Russian-language requirements dataset compiled from:
|
| 67 |
+
- PROMISE dataset (translated to Russian)
|
| 68 |
+
- PURE dataset (parsed from XML, translated to Russian)
|
| 69 |
+
- Synthetically generated examples (Grok, Claude Sonnet) across 14 domain areas
|
| 70 |
|
| 71 |
+
Total: ~9800 labeled examples. Train/test split: 80/20, stratified, seed=42.
|
| 72 |
|
| 73 |
+
## Training procedure
|
| 74 |
|
| 75 |
+
### Training hyperparameters
|
| 76 |
|
| 77 |
+
* learning_rate: 2e-05
|
| 78 |
+
* train_batch_size: 16
|
| 79 |
+
* eval_batch_size: 16
|
| 80 |
+
* seed: 42
|
| 81 |
+
* optimizer: AdamW with betas=(0.9, 0.999), epsilon=1e-08
|
| 82 |
+
* lr_scheduler_type: linear
|
| 83 |
+
* lr_scheduler_warmup_ratio: 0.06
|
| 84 |
+
* num_epochs: 15 (early stopping patience=3)
|
| 85 |
+
* max_length: 96
|
| 86 |
|
| 87 |
+
### Training results
|
| 88 |
|
| 89 |
+
| Training Loss | Epoch | Validation Loss | F1 Micro | F1 Macro | F1 Weighted |
|
| 90 |
+
|---|---|---|---|---|---|
|
| 91 |
+
| 0.1007 | 1 | 0.1046 | 0.9030 | 0.8907 | 0.8906 |
|
| 92 |
+
| 0.0462 | 2 | 0.0471 | 0.9669 | 0.9671 | 0.9671 |
|
| 93 |
+
| 0.0215 | 3 | 0.0467 | 0.9698 | 0.9697 | 0.9697 |
|
| 94 |
+
| 0.0170 | 4 | 0.0556 | 0.9689 | 0.9689 | 0.9689 |
|
| 95 |
+
| 0.0072 | 5 | 0.0784 | 0.9607 | 0.9604 | 0.9605 |
|
| 96 |
+
| 0.0055 | 6 | 0.0608 | 0.9724 | 0.9727 | 0.9724 |
|
| 97 |
|
| 98 |
+
Early stopping triggered after epoch 6.
|
| 99 |
|
| 100 |
+
### Per-class results (test set)
|
| 101 |
|
| 102 |
+
| Class | Precision | Recall | F1 | Support |
|
| 103 |
+
|---|---|---|---|---|
|
| 104 |
+
| IsFunctional | 0.934 | 0.948 | 0.941 | 420 |
|
| 105 |
+
| IsBusiness | 0.993 | 0.978 | 0.985 | 416 |
|
| 106 |
+
| Other (OT) | 1.000 | 1.000 | 1.000 | 421 |
|
| 107 |
+
| **micro avg** | **0.975** | **0.975** | **0.975** | 1257 |
|
| 108 |
|
| 109 |
+
### Framework versions
|
| 110 |
|
| 111 |
+
* Transformers 4.57.1
|
| 112 |
+
* PyTorch 2.8.0+cu128
|
| 113 |
+
* Datasets 4.0.0
|
| 114 |
+
* Tokenizers 0.22.2
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|