Text Classification
Transformers
English
bert
bert-mini
classification
decision-model
dynamic-classification
calibrated-classification
option-scoring
oryn
Instructions to use timosarkar/oryn with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use timosarkar/oryn with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-classification", model="timosarkar/oryn")# pip install -U transformers accelerate # Load model directly from transformers import AutoModel model = AutoModel.from_pretrained("timosarkar/oryn", device_map="auto") - Notebooks
- Google Colab
- Kaggle
File size: 6,532 Bytes
cac788c | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 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 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 | import argparse
import json
import time
from pathlib import Path
import torch
import torch.nn as nn
import torch.nn.functional as F
from transformers import AutoConfig, AutoModel, AutoTokenizer
MODEL_DIR = Path(__file__).resolve().parent
# ---------------------------------------------------------------------
# Model architecture
# ---------------------------------------------------------------------
class DecisionHead(nn.Module):
def __init__(self, hidden_size):
super().__init__()
heads = next(
head_count
for head_count in (8, 4, 2, 1)
if hidden_size % head_count == 0
)
layer = nn.TransformerEncoderLayer(
d_model=hidden_size,
nhead=heads,
dim_feedforward=hidden_size * 4,
batch_first=True,
activation="gelu",
)
self.encoder = nn.TransformerEncoder(
layer,
num_layers=2,
enable_nested_tensor=False,
)
self.scorer = nn.Linear(hidden_size, 1)
def forward(self, hidden, attention_mask):
return self.encoder(
hidden,
src_key_padding_mask=attention_mask == 0,
)
class LayaModel(nn.Module):
def __init__(self, backbone_name):
super().__init__()
# Downloads only the backbone configuration when it is not cached.
backbone_config = AutoConfig.from_pretrained(
backbone_name
)
self.backbone = AutoModel.from_config(
backbone_config
)
self.head = DecisionHead(
backbone_config.hidden_size
)
def forward(
self,
input_ids,
attention_mask,
mask_positions,
):
hidden = self.backbone(
input_ids=input_ids,
attention_mask=attention_mask,
).last_hidden_state
hidden = self.head(
hidden,
attention_mask,
)
return [
self.head.scorer(
hidden[index, positions]
).squeeze(-1)
for index, positions in enumerate(mask_positions)
]
# ---------------------------------------------------------------------
# Load model
# ---------------------------------------------------------------------
with open(
MODEL_DIR / "config.json",
encoding="utf-8",
) as file:
settings = json.load(file)
BACKBONE = settings["backbone"]
MAX_LEN = settings.get("max_len", 256)
device = (
"cuda"
if torch.cuda.is_available()
else "mps"
if torch.backends.mps.is_available()
else "cpu"
)
tokenizer = AutoTokenizer.from_pretrained(
MODEL_DIR,
local_files_only=True,
)
model = LayaModel(BACKBONE)
state_dict = torch.load(
MODEL_DIR / "model.bin",
map_location="cpu",
weights_only=True,
)
model.load_state_dict(
state_dict,
strict=True,
)
model = model.to(device)
model.eval()
# ---------------------------------------------------------------------
# Inference
# ---------------------------------------------------------------------
@torch.inference_mode()
def predict(text, question, options):
option_text = ", ".join(
f"{option} {tokenizer.mask_token}"
for option in options
)
prefix = f"question: {question}\nstate: "
suffix = f"\noptions: {option_text}"
reserved_tokens = len(
tokenizer(
prefix + suffix,
add_special_tokens=True,
)["input_ids"]
)
state_ids = tokenizer(
text,
add_special_tokens=False,
)["input_ids"][
:max(1, MAX_LEN - reserved_tokens)
]
prompt = (
prefix
+ tokenizer.decode(
state_ids,
skip_special_tokens=True,
)
+ suffix
)
encoded = tokenizer(
prompt,
max_length=MAX_LEN,
truncation=True,
return_tensors="pt",
)
mask_positions = (
encoded["input_ids"][0]
== tokenizer.mask_token_id
).nonzero(as_tuple=True)[0].tolist()
if len(mask_positions) != len(options):
raise ValueError(
"Option markers were truncated. "
"Use shorter text or fewer options."
)
input_ids = encoded["input_ids"].to(device)
attention_mask = encoded["attention_mask"].to(device)
logits = model(
input_ids,
attention_mask,
[mask_positions],
)[0]
probabilities = F.softmax(
logits.float(),
dim=0,
).cpu().tolist()
scores = dict(zip(options, probabilities))
prediction = max(scores, key=scores.get)
return {
"prediction": prediction,
"confidence": scores[prediction],
"probabilities": scores,
}
def synchronize():
if device == "cuda":
torch.cuda.synchronize()
elif device == "mps":
torch.mps.synchronize()
# ---------------------------------------------------------------------
# Command-line interface
# ---------------------------------------------------------------------
def main():
parser = argparse.ArgumentParser(
description="Run Oryn classification inference."
)
parser.add_argument(
"--text",
default=(
"Your account will be suspended unless "
"you verify your password immediately."
),
)
parser.add_argument(
"--question",
default=(
"Is this message a phishing, scam, "
"or fraud attempt?"
),
)
parser.add_argument(
"--options",
nargs="+",
default=["true", "false"],
)
args = parser.parse_args()
# Warm up the device before measuring latency.
for _ in range(10):
predict(
args.text,
args.question,
args.options,
)
synchronize()
start = time.perf_counter()
result = predict(
args.text,
args.question,
args.options,
)
synchronize()
latency_ms = (
time.perf_counter() - start
) * 1000
print(f"Device: {device}")
print(f"Prediction: {result['prediction']}")
print(f"Confidence: {result['confidence']:.4f}")
print(f"Latency: {latency_ms:.2f} ms")
print("Probabilities:")
for option, probability in sorted(
result["probabilities"].items(),
key=lambda item: item[1],
reverse=True,
):
print(f" {option}: {probability:.4f}")
if __name__ == "__main__":
main()
|