_save_utils.py
17.1 KB
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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
import os
import json
import numpy as np
from pathlib import Path
from tempfile import TemporaryDirectory
# HuggingFace Hub
try:
from huggingface_hub import (
create_repo,
get_hf_file_metadata,
hf_hub_download,
hf_hub_url,
repo_type_and_id_from_hf_id,
upload_folder,
)
_has_hf_hub = True
except ImportError:
_has_hf_hub = False
# Typing
from typing import Union
# Pytorch check
try:
import torch
_has_torch = True
except ImportError:
_has_torch = False
# Image check
try:
from PIL import Image
_has_vision = True
except ImportError:
_has_vision = False
TOPICS_NAME = "topics.json"
CONFIG_NAME = "config.json"
HF_WEIGHTS_NAME = "topic_embeddings.bin" # default pytorch pkl
HF_SAFE_WEIGHTS_NAME = "topic_embeddings.safetensors" # safetensors version
CTFIDF_WEIGHTS_NAME = "ctfidf.bin" # default pytorch pkl
CTFIDF_SAFE_WEIGHTS_NAME = "ctfidf.safetensors" # safetensors version
CTFIDF_CFG_NAME = "ctfidf_config.json"
MODEL_CARD_TEMPLATE = """
---
tags:
- bertopic
library_name: bertopic
pipeline_tag: {PIPELINE_TAG}
---
# {MODEL_NAME}
This is a [BERTopic](https://github.com/MaartenGr/BERTopic) model.
BERTopic is a flexible and modular topic modeling framework that allows for the generation of easily interpretable topics from large datasets.
## Usage
To use this model, please install BERTopic:
```
pip install -U bertopic
```
You can use the model as follows:
```python
from bertopic import BERTopic
topic_model = BERTopic.load("{PATH}")
topic_model.get_topic_info()
```
## Topic overview
* Number of topics: {NR_TOPICS}
* Number of training documents: {NR_DOCUMENTS}
<details>
<summary>Click here for an overview of all topics.</summary>
{TOPICS}
</details>
## Training hyperparameters
{HYPERPARAMS}
## Framework versions
{FRAMEWORKS}
"""
def push_to_hf_hub(
model,
repo_id: str,
commit_message: str = "Add BERTopic model",
token: str = None,
revision: str = None,
private: bool = False,
create_pr: bool = False,
model_card: bool = True,
serialization: str = "safetensors",
save_embedding_model: Union[str, bool] = True,
save_ctfidf: bool = False,
):
"""Push your BERTopic model to a HuggingFace Hub.
Arguments:
model: The BERTopic model to push
repo_id: The name of your HuggingFace repository
commit_message: A commit message
token: Token to add if not already logged in
revision: Repository revision
private: Whether to create a private repository
create_pr: Whether to upload the model as a Pull Request
model_card: Whether to automatically create a modelcard
serialization: The type of serialization.
Either `safetensors` or `pytorch`
save_embedding_model: A pointer towards a HuggingFace model to be loaded in with
SentenceTransformers. E.g.,
`sentence-transformers/all-MiniLM-L6-v2`
save_ctfidf: Whether to save c-TF-IDF information
"""
if not _has_hf_hub:
raise ValueError("Make sure you have the huggingface hub installed via `pip install --upgrade huggingface_hub`")
# Create repo if it doesn't exist yet and infer complete repo_id
repo_url = create_repo(repo_id, token=token, private=private, exist_ok=True)
_, repo_owner, repo_name = repo_type_and_id_from_hf_id(repo_url)
repo_id = f"{repo_owner}/{repo_name}"
# Temporarily save model and push to HF
with TemporaryDirectory() as tmpdir:
# Save model weights and config.
model.save(
tmpdir,
serialization=serialization,
save_embedding_model=save_embedding_model,
save_ctfidf=save_ctfidf,
)
# Add README if it does not exist
try:
get_hf_file_metadata(hf_hub_url(repo_id=repo_id, filename="README.md", revision=revision))
except: # noqa: E722
if model_card:
readme_text = generate_readme(model, repo_id)
readme_path = Path(tmpdir) / "README.md"
readme_path.write_text(readme_text, encoding="utf8")
# Upload model
return upload_folder(
repo_id=repo_id,
folder_path=tmpdir,
revision=revision,
create_pr=create_pr,
commit_message=commit_message,
)
def load_local_files(path):
"""Load local BERTopic files."""
# Load json configs
topics = load_cfg_from_json(path / TOPICS_NAME)
params = load_cfg_from_json(path / CONFIG_NAME)
# Load Topic Embeddings
safetensor_path = path / HF_SAFE_WEIGHTS_NAME
if safetensor_path.is_file():
tensors = load_safetensors(safetensor_path)
else:
torch_path = path / HF_WEIGHTS_NAME
if torch_path.is_file():
tensors = torch.load(torch_path, map_location="cpu")
tensors = {k: v.numpy() for k, v in tensors.items()}
# c-TF-IDF
try:
ctfidf_tensors = None
safetensor_path = path / CTFIDF_SAFE_WEIGHTS_NAME
if safetensor_path.is_file():
ctfidf_tensors = load_safetensors(safetensor_path)
else:
torch_path = path / CTFIDF_WEIGHTS_NAME
if torch_path.is_file():
ctfidf_tensors = torch.load(torch_path, map_location="cpu")
ctfidf_tensors = {k: v.numpy() for k, v in ctfidf_tensors.items()}
ctfidf_config = load_cfg_from_json(path / CTFIDF_CFG_NAME)
except: # noqa: E722
ctfidf_config, ctfidf_tensors = None, None
# Load images
images = None
if _has_vision:
try:
Image.open(path / "images/0.jpg")
_has_images = True
except: # noqa: E722
_has_images = False
if _has_images:
topic_list = list(topics["topic_representations"].keys())
images = {}
for topic in topic_list:
image = Image.open(path / f"images/{topic}.jpg")
images[int(topic)] = image
return topics, params, tensors, ctfidf_tensors, ctfidf_config, images
def load_files_from_hf(path):
"""Load files from HuggingFace."""
path = str(path)
# Configs
topics = load_cfg_from_json(hf_hub_download(path, TOPICS_NAME, revision=None))
params = load_cfg_from_json(hf_hub_download(path, CONFIG_NAME, revision=None))
# Topic Embeddings
try:
tensors = hf_hub_download(path, HF_SAFE_WEIGHTS_NAME, revision=None)
tensors = load_safetensors(tensors)
except: # noqa: E722
tensors = hf_hub_download(path, HF_WEIGHTS_NAME, revision=None)
tensors = torch.load(tensors, map_location="cpu")
# c-TF-IDF
try:
ctfidf_config = load_cfg_from_json(hf_hub_download(path, CTFIDF_CFG_NAME, revision=None))
try:
ctfidf_tensors = hf_hub_download(path, CTFIDF_SAFE_WEIGHTS_NAME, revision=None)
ctfidf_tensors = load_safetensors(ctfidf_tensors)
except: # noqa: E722
ctfidf_tensors = hf_hub_download(path, CTFIDF_WEIGHTS_NAME, revision=None)
ctfidf_tensors = torch.load(ctfidf_tensors, map_location="cpu")
except: # noqa: E722
ctfidf_config, ctfidf_tensors = None, None
# Load images if they exist
images = None
if _has_vision:
try:
hf_hub_download(path, "images/0.jpg", revision=None)
_has_images = True
except: # noqa: E722
_has_images = False
if _has_images:
topic_list = list(topics["topic_representations"].keys())
images = {}
for topic in topic_list:
image = Image.open(hf_hub_download(path, f"images/{topic}.jpg", revision=None))
images[int(topic)] = image
return topics, params, tensors, ctfidf_tensors, ctfidf_config, images
def generate_readme(model, repo_id: str):
"""Generate README for HuggingFace model card."""
model_card = MODEL_CARD_TEMPLATE
topic_table_head = "| Topic ID | Topic Keywords | Topic Frequency | Label | \n|----------|----------------|-----------------|-------| \n"
# Get Statistics
model_name = repo_id.split("/")[-1]
params = {param: value for param, value in model.get_params().items() if "model" not in param}
params = "\n".join([f"* {param}: {value}" for param, value in params.items()])
topics = sorted(list(set(model.topics_)))
nr_topics = str(len(set(model.topics_)))
if model.topic_sizes_ is not None:
nr_documents = str(sum(model.topic_sizes_.values()))
else:
nr_documents = ""
# Topic information
topic_keywords = [" - ".join(list(zip(*model.get_topic(topic)))[0][:5]) for topic in topics]
topic_freq = [model.get_topic_freq(topic) for topic in topics]
topic_labels = model.custom_labels_ if model.custom_labels_ else [model.topic_labels_[topic] for topic in topics]
topics = [
f"| {topic} | {topic_keywords[index]} | {topic_freq[topic]} | {topic_labels[index]} | \n"
for index, topic in enumerate(topics)
]
topics = topic_table_head + "".join(topics)
frameworks = "\n".join([f"* {param}: {value}" for param, value in get_package_versions().items()])
# Fill Statistics into model card
model_card = model_card.replace("{MODEL_NAME}", model_name)
model_card = model_card.replace("{PATH}", repo_id)
model_card = model_card.replace("{NR_TOPICS}", nr_topics)
model_card = model_card.replace("{TOPICS}", topics.strip())
model_card = model_card.replace("{NR_DOCUMENTS}", nr_documents)
model_card = model_card.replace("{HYPERPARAMS}", params)
model_card = model_card.replace("{FRAMEWORKS}", frameworks)
# Fill Pipeline tag
has_visual_aspect = check_has_visual_aspect(model)
if not has_visual_aspect:
model_card = model_card.replace("{PIPELINE_TAG}", "text-classification")
else:
model_card = model_card.replace("pipeline_tag: {PIPELINE_TAG}\n", "") # TODO add proper tag for this instance
return model_card
def save_hf(model, save_directory, serialization: str):
"""Save topic embeddings, either safely (using safetensors) or using legacy pytorch."""
tensors = np.array(model.topic_embeddings_, dtype=np.float32)
if serialization == "safetensors":
tensors = {"topic_embeddings": tensors}
save_safetensors(save_directory / HF_SAFE_WEIGHTS_NAME, tensors)
if serialization == "pytorch":
assert _has_torch, "`pip install pytorch` to save as bin"
tensors = {"topic_embeddings": torch.from_numpy(tensors)}
torch.save(tensors, save_directory / HF_WEIGHTS_NAME)
def save_ctfidf(model, save_directory: str, serialization: str):
"""Save c-TF-IDF sparse matrix."""
indptr = model.c_tf_idf_.indptr
indices = model.c_tf_idf_.indices
data = model.c_tf_idf_.data
shape = np.array(model.c_tf_idf_.shape)
diag = np.array(model.ctfidf_model._idf_diag.data)
if serialization == "safetensors":
tensors = {
"indptr": indptr,
"indices": indices,
"data": data,
"shape": shape,
"diag": diag,
}
save_safetensors(save_directory / CTFIDF_SAFE_WEIGHTS_NAME, tensors)
if serialization == "pytorch":
assert _has_torch, "`pip install pytorch` to save as .bin"
tensors = {
"indptr": torch.from_numpy(indptr),
"indices": torch.from_numpy(indices),
"data": torch.from_numpy(data),
"shape": torch.from_numpy(shape),
"diag": torch.from_numpy(diag),
}
torch.save(tensors, save_directory / CTFIDF_WEIGHTS_NAME)
def save_ctfidf_config(model, path):
"""Save parameters to recreate CountVectorizer and c-TF-IDF."""
config = {}
# Recreate ClassTfidfTransformer
config["ctfidf_model"] = {
"bm25_weighting": model.ctfidf_model.bm25_weighting,
"reduce_frequent_words": model.ctfidf_model.reduce_frequent_words,
}
# Recreate CountVectorizer
cv_params = model.vectorizer_model.get_params()
del cv_params["tokenizer"], cv_params["preprocessor"], cv_params["dtype"]
if not isinstance(cv_params["analyzer"], str):
del cv_params["analyzer"]
config["vectorizer_model"] = {
"params": cv_params,
"vocab": model.vectorizer_model.vocabulary_,
}
with path.open("w") as f:
json.dump(config, f, indent=2)
def save_config(model, path: str, embedding_model):
"""Save BERTopic configuration."""
path = Path(path)
params = model.get_params()
config = {param: value for param, value in params.items() if "model" not in param}
# Embedding model tag to be used in sentence-transformers
if isinstance(embedding_model, str):
config["embedding_model"] = embedding_model
with path.open("w") as f:
json.dump(config, f, indent=2)
return config
def check_has_visual_aspect(model):
"""Check if model has visual aspect."""
if _has_vision:
for aspect, value in model.topic_aspects_.items():
if isinstance(value[0], Image.Image):
return True
def save_images(model, path: str):
"""Save topic images."""
if _has_vision:
visual_aspects = None
for aspect, value in model.topic_aspects_.items():
if isinstance(value[0], Image.Image):
visual_aspects = model.topic_aspects_[aspect]
break
if visual_aspects is not None:
path.mkdir(exist_ok=True, parents=True)
for topic, image in visual_aspects.items():
image.save(path / f"{topic}.jpg")
def save_topics(model, path: str):
"""Save Topic-specific information."""
path = Path(path)
if _has_vision:
selected_topic_aspects = {}
for aspect, value in model.topic_aspects_.items():
if not isinstance(value[0], Image.Image):
selected_topic_aspects[aspect] = value
else:
selected_topic_aspects["Visual_Aspect"] = True
else:
selected_topic_aspects = model.topic_aspects_
topics = {
"topic_representations": model.topic_representations_,
"topics": [int(topic) for topic in model.topics_],
"topic_sizes": model.topic_sizes_,
"topic_mapper": np.array(model.topic_mapper_.mappings_, dtype=int).tolist(),
"topic_labels": model.topic_labels_,
"custom_labels": model.custom_labels_,
"_outliers": int(model._outliers),
"topic_aspects": selected_topic_aspects,
}
with path.open("w") as f:
json.dump(topics, f, indent=2, cls=NumpyEncoder)
def load_cfg_from_json(json_file: Union[str, os.PathLike]):
"""Load configuration from json."""
with open(json_file, "r", encoding="utf-8") as reader:
text = reader.read()
return json.loads(text)
class NumpyEncoder(json.JSONEncoder):
def default(self, obj):
if isinstance(obj, np.integer):
return int(obj)
if isinstance(obj, np.floating):
return float(obj)
return super(NumpyEncoder, self).default(obj)
def get_package_versions():
"""Get versions of main dependencies of BERTopic."""
try:
import platform
from numpy import __version__ as np_version
from pandas import __version__ as pandas_version
from sklearn import __version__ as sklearn_version
from plotly import __version__ as plotly_version
try:
from importlib.metadata import version
hdbscan_version = version("hdbscan")
except (ImportError, ModuleNotFoundError):
hdbscan_version = None
try:
from umap import __version__ as umap_version
except (ImportError, ModuleNotFoundError):
umap_version = None
try:
from sentence_transformers import __version__ as sbert_version
except (ImportError, ModuleNotFoundError):
sbert_version = None
try:
from numba import __version__ as numba_version
except (ImportError, ModuleNotFoundError):
numba_version = None
try:
from transformers import __version__ as transformers_version
except (ImportError, ModuleNotFoundError):
transformers_version = None
return {
"Numpy": np_version,
"HDBSCAN": hdbscan_version,
"UMAP": umap_version,
"Pandas": pandas_version,
"Scikit-Learn": sklearn_version,
"Sentence-transformers": sbert_version,
"Transformers": transformers_version,
"Numba": numba_version,
"Plotly": plotly_version,
"Python": platform.python_version(),
}
except Exception as e:
return e
def load_safetensors(path):
"""Load safetensors and check whether it is installed."""
try:
import safetensors.numpy
return safetensors.numpy.load_file(path)
except ImportError:
raise ValueError("`pip install safetensors` to load .safetensors")
def save_safetensors(path, tensors):
"""Save safetensors and check whether it is installed."""
try:
import safetensors.numpy
safetensors.numpy.save_file(tensors, path)
except ImportError:
raise ValueError("`pip install safetensors` to save as .safetensors")