Remove old README for metadata update
Browse files
README.md
DELETED
|
@@ -1,77 +0,0 @@
|
|
| 1 |
-
---
|
| 2 |
-
language: en
|
| 3 |
-
tags:
|
| 4 |
-
- text-classification
|
| 5 |
-
- requirements-engineering
|
| 6 |
-
- bert
|
| 7 |
-
datasets:
|
| 8 |
-
- promise-nfr
|
| 9 |
-
metrics:
|
| 10 |
-
- accuracy
|
| 11 |
-
- f1
|
| 12 |
-
model-index:
|
| 13 |
-
- name: RequirementClassifier
|
| 14 |
-
results:
|
| 15 |
-
- task:
|
| 16 |
-
type: text-classification
|
| 17 |
-
name: Requirement Classification
|
| 18 |
-
dataset:
|
| 19 |
-
name: PROMISE NFR
|
| 20 |
-
type: promise-nfr
|
| 21 |
-
metrics:
|
| 22 |
-
- type: accuracy
|
| 23 |
-
name: Accuracy
|
| 24 |
-
value: 0.0
|
| 25 |
-
---
|
| 26 |
-
|
| 27 |
-
# RequirementClassifier
|
| 28 |
-
|
| 29 |
-
Version: 26
|
| 30 |
-
|
| 31 |
-
## Model Description
|
| 32 |
-
|
| 33 |
-
This model is a fine-tuned BERT model for binary classification of software requirements.
|
| 34 |
-
It classifies text as either "requirement" or "non-requirement".
|
| 35 |
-
|
| 36 |
-
## Intended Uses
|
| 37 |
-
|
| 38 |
-
- Classify software requirement documents
|
| 39 |
-
- Identify requirement vs non-requirement statements
|
| 40 |
-
- Automated requirement extraction from documents
|
| 41 |
-
|
| 42 |
-
## Training Data
|
| 43 |
-
|
| 44 |
-
The model was trained on the PROMISE NFR dataset with additional non-requirement examples.
|
| 45 |
-
|
| 46 |
-
## Usage
|
| 47 |
-
|
| 48 |
-
```python
|
| 49 |
-
from transformers import AutoTokenizer, AutoModelForSequenceClassification
|
| 50 |
-
import torch
|
| 51 |
-
|
| 52 |
-
# Load model and tokenizer
|
| 53 |
-
tokenizer = AutoTokenizer.from_pretrained("rajinikarcg/RequirementClassifier")
|
| 54 |
-
model = AutoModelForSequenceClassification.from_pretrained("rajinikarcg/RequirementClassifier")
|
| 55 |
-
|
| 56 |
-
# Prepare input
|
| 57 |
-
text = "The system shall respond within 2 seconds"
|
| 58 |
-
inputs = tokenizer(text, return_tensors="pt", truncation=True, max_length=128)
|
| 59 |
-
|
| 60 |
-
# Get prediction
|
| 61 |
-
with torch.no_grad():
|
| 62 |
-
outputs = model(**inputs)
|
| 63 |
-
logits = outputs.logits
|
| 64 |
-
prediction = torch.argmax(logits, dim=-1).item()
|
| 65 |
-
|
| 66 |
-
# Map to label
|
| 67 |
-
labels = ["non-requirement", "requirement"]
|
| 68 |
-
print(f"Prediction: {labels[prediction]}")
|
| 69 |
-
```
|
| 70 |
-
|
| 71 |
-
## Version History
|
| 72 |
-
|
| 73 |
-
- 26: Latest version
|
| 74 |
-
|
| 75 |
-
## Citation
|
| 76 |
-
|
| 77 |
-
If you use this model, please cite the PROMISE NFR dataset.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|