KM35NCDF

🚀 kasrahabib/KM35NCDF

本模型是 sentence-transformers/all-MiniLM-L6-v2 在软件需求数据集（SWARD）上的微调版本，用于对 19 种非功能需求进行分类。需要注意的是，根据文献，19 个类别中有两个类别（数据和行为）属于功能性软件需求类型。该模型在评估集上取得了以下结果：

• 训练损失：0.1691
• 验证损失：0.7548
• 训练轮数：14
• 最终宏 F1 分数：0.79

标签： 0 或 A -> 可用性； 1 或 AC -> 访问控制； 2 或 AU -> 审计； 3 或 B -> 行为； 4 或 D -> 数据； 5 或 FT -> 容错性； 6 或 I -> 接口/互操作性； 7 或 LE -> 法律； 8 或 LF -> 外观和感觉； 9 或 MN -> 可维护性； 10 或 O -> 操作性； 11 或 PE -> 性能； 12 或 PO -> 可移植性； 13 或 RL -> 可靠性； 14 或 SA -> 安全性； 15 或 SC -> 可扩展性； 16 或 SE -> 安全性； 17 或 ST -> 稳定性； 18 或 US -> 可用性；

🚀 快速开始

本部分将介绍模型的基本使用方法和相关信息。

✨ 主要特性

• 基于微调的预训练模型，能够对 19 种非功能需求进行分类。
• 在评估集上取得了较好的性能指标。

📦 安装指南

如果你想在本地使用该模型，可以按照以下步骤进行操作：

1. 克隆仓库：

git lfs install
git clone url_of_repo

2. 找到下载目录的路径。
3. 将路径链接写入 model_ckpt 变量。

💻 使用示例

基础用法

from transformers import pipeline

frame_work = 'tf'
task = 'text-classification'
model_ckpt = 'kasrahabib/KM35NCDF '

software_requirment_cls = pipeline(task = task, model = model_ckpt, framework = frame_work)

example_1_US = 'Application needs to keep track of subtasks in a task.'
example_2_PE = 'The system shall allow users to enter time in several different formats.'
example_3_AC = 'The system shall allow users who hold any of the ORES/ORELSE/PROVIDER keys to be viewed as a clinical user and has full access privileges to all problem list options.'

software_requirment_cls([example_1_US, example_2_PE, example_3_AC])

[{'label': 'US', 'score': 0.9712953567504883},
 {'label': 'PE', 'score': 0.9457865953445435},
 {'label': 'AC', 'score': 0.9639136791229248}]

高级用法

import numpy as np
from transformers import AutoTokenizer, TFAutoModelForSequenceClassification

model_ckpt = 'kasrahabib/KM35NCDF '
tokenizer = AutoTokenizer.from_pretrained(model_ckpt)
model = TFAutoModelForSequenceClassification.from_pretrained(model_ckpt)

example_1_US = 'Application needs to keep track of subtasks in a task.'
example_2_PE = 'The system shall allow users to enter time in several different formats.'
example_3_AC = 'The system shall allow users who hold any of the ORES/ORELSE/PROVIDER keys to be viewed as a clinical user and has full access privileges to all problem list options.'
requirements = [example_1_US, example_2_PE, example_3_AC]

encoded_requirements = tokenizer(requirements, return_tensors = 'np', padding = 'longest')

y_pred = model(encoded_requirements).logits
classifications = np.argmax(y_pred, axis = 1)

classifications = [model.config.id2label[output] for output in classifications]
print(classifications)

['US', 'PE', 'AC']

本地下载使用

import numpy as np
from transformers import AutoTokenizer, TFAutoModelForSequenceClassification

model_ckpt =  'rest_of_the_path/KM35NCDF '
tokenizer = AutoTokenizer.from_pretrained(model_ckpt)
model = TFAutoModelForSequenceClassification.from_pretrained(model_ckpt)

example_1_US = 'Application needs to keep track of subtasks in a task.'
example_2_PE = 'The system shall allow users to enter time in several different formats.'
example_3_AC = 'The system shall allow users who hold any of the ORES/ORELSE/PROVIDER keys to be viewed as a clinical user and has full access privileges to all problem list options.'
requirements = [example_1_US, example_2_PE, example_3_AC]

encoded_requirements = tokenizer(requirements, return_tensors = 'np', padding = 'longest')

y_pred = model(encoded_requirements).logits
classifications = np.argmax(y_pred, axis = 1)

classifications = [model.config.id2label[output] for output in classifications]
print(classifications)

📚 详细文档

训练超参数

训练过程中使用了以下超参数：

• 优化器：{'name': 'Adam', 'weight_decay': None, 'clipnorm': None, 'global_clipnorm': None, 'clipvalue': None, 'use_ema': False, 'ema_momentum': 0.99, 'ema_overwrite_frequency': None, 'jit_compile': True, 'is_legacy_optimizer': False, 'learning_rate': {'class_name': 'PolynomialDecay', 'config': {'initial_learning_rate': 2e-05, 'decay_steps': 6735, 'end_learning_rate': 0.0, 'power': 1.0, 'cycle': False, 'name': None}}, 'beta_1': 0.9, 'beta_2': 0.999, 'epsilon': 1e-08, 'amsgrad': False}
• 训练精度：float32

框架版本

• Transformers 4.26.1
• TensorFlow 2.11.0
• Datasets 2.10.0
• Tokenizers 0.13.2

📄 许可证

本项目采用 Apache-2.0 许可证。