BERTopicFitModel
Python template · sinapsis_bertopic.templates.bertopic_fit_model
Overview
A class for fitting and managing a BERTopic model.
This class provides methods for fitting a BERTopic model on input documents, generating visualizations, and saving both the model and visualizations to disk. It also supports exporting visualizations as images and saving training data used for fitting the model.
Attributes: bertopic_model_params (BERTopicModelParams): Configuration parameters for the BERTopic model. Defaults to an empty dictionary which is converted to a BERTopicModelParams instance during validation. umap_model_params (UMAPModelParams): Configuration parameters for the UMAP dimensionality reduction model. Defaults to an empty dictionary which is converted to a UMAPModelParams instance during validation. hdbscan_model_params (HDBSCANModelParams): Configuration parameters for the HDBSCAN clustering model. Defaults to an empty dictionary which is converted to a HDBSCANModelParams instance during validation. bertopic_save_model_params (BERTopicSaveModelParams): Parameters for saving the BERTopic model. Defaults to BERTopicSaveModelParams(). export_visualization_to_image (bool): Whether to export visualizations as image files. Defaults to True. image_export_params (ToImageParams): Parameters for image export configuration. Defaults to ToImageParams(). root_dir (str): Root directory for storing model and visualization files. Defaults to SINAPSIS_CACHE_DIR. save_documents_visualization_path (str): Relative path for saving documents visualization HTML file. Defaults to "documents_visualization.html". save_model_path (str): Relative path for saving the BERTopic model. save_training_data (bool): Whether to save training data to disk. Defaults to False. save_training_data_path (str): Relative path for saving training data pickle file. Defaults to "training_data.pkl". sentence_model_name (str): Identifier for the sentence transformer model. Defaults to "sentence-transformers/all-MiniLM-L6-v2". visualize_documents_params (VisualizeDocumentsParams): Parameters for document visualization. Defaults to VisualizeDocumentsParams().
Capabilities
Capabilities: not setInstallation
Install the published package using pip or uv.
pip install sinapsis-bertopic==1.0.0uv pip install sinapsis-bertopic==1.0.0uv add sinapsis-bertopic==1.0.0Configuration
Effective fields from the inspector schema, including nested Pydantic model fields.
Optional
Default: null
Root directory for storing model and visualization files. Defaults to SINAPSIS_CACHE_DIR.
Optional
Default: "/home/ariel/.cache/sinapsis"
Relative path for saving the BERTopic model.
Optional
Default: "bertopic_model"
Configuration parameters for the UMAP dimensionality reduction model. Defaults to an empty dictionary which is converted to a UMAPModelParams instance during validation.
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: "spectral"
Optional
Default: "euclidean"
Optional
Default: -1
Optional
Default: 1
Optional
Default: false
Optional
Default: false
Optional
Default: false
Optional
Default: 0.1
Optional
Default: null
Optional
Default: 0.3
Optional
Default: null
Optional
Default: true
Optional
Default: 2
Optional
Default: null
Optional
Default: 15
Optional
Default: false
Optional
Default: 2
Optional
Default: null
Optional
Default: 1
Optional
Default: "euclidean"
Optional
Default: "categorical"
Optional
Default: 0.5
Optional
Default: 0.1
Optional
Default: "embedding"
Optional
Default: 42
Optional
Default: [null,null,null]
Optional
Default: 1
Optional
Default: false
Optional
Default: 1
Optional
Default: null
Optional
Default: 1
Optional
Default: null
Optional
Default: -1
Optional
Default: 5
Optional
Default: 4
Optional
Default: null
Optional
Default: false
Whether to save training data to disk. Defaults to False.
Optional
Default: false
Configuration parameters for the ClassTfidfTransformer model used in BERTopic. Defaults to CTFIDFModelParams().
Optional
Default: null
Optional
Default: null
Optional
Default: true
Optional
Default: 2
Optional
Default: true
Parameters for image export configuration. Defaults to ToImageParams().
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: "png"
Optional
Default: null
Optional
Default: true
Identifier for the sentence transformer model. Defaults to "sentence-transformers/all-MiniLM-L6-v2".
Optional
Default: "sentence-transformers/all-MiniLM-L6-v2"
Configuration parameters for the HDBSCAN clustering model. Defaults to an empty dictionary which is converted to a HDBSCANModelParams instance during validation.
Optional
Default: null
Optional
Default: null
Optional
Default: 1
Optional
Default: null
Optional
Default: "euclidean"
Optional
Default: "best"
Optional
Default: 40
Optional
Default: null
Optional
Default: true
Optional
Default: 4
Optional
Default: 0
Optional
Default: 5
Optional
Default: false
Optional
Default: false
Optional
Default: true
Optional
Default: false
Optional
Default: "eom"
Optional
Default: 0
Optional
Default: null
Optional
Default: 0
Optional
Default: false
Configuration parameters for the BERTopic model. Defaults to an empty dictionary which is converted to a BERTopicModelParams instance during validation.
Optional
Default: null
Optional
Default: "english"
Optional
Default: null
Optional
Default: false
Optional
Default: 10
Optional
Default: [1,1]
Optional
Default: 5
Optional
Default: null
Optional
Default: null
Optional
Default: false
Optional
Default: 0.7
Relative path for saving training data pickle file. Defaults to "training_data.pkl".
Optional
Default: "training_data.pkl"
Parameters for saving the BERTopic model. Defaults to BERTopicSaveModelParams().
Optional
Default: null
Optional
Default: true
Optional
Default: "safetensors"
Parameters for document visualization. Defaults to VisualizeDocumentsParams(). Properties: full_visualization_path (str): Absolute path to the documents visualization file. full_training_data_path (str): Absolute path to the training data file. full_save_model_path (str): Absolute path to the saved model file.
Optional
Default: null
Optional
Default: "<b>Documents and Topics</b>"
Optional
Default: 1200
Optional
Default: 750
Optional
Default: null
Optional
Default: null
Optional
Default: false
Optional
Default: false
Optional
Default: false
Whether to export visualizations as image files. Defaults to True.
Optional
Default: true
Relative path for saving documents visualization HTML file. Defaults to "documents_visualization.html".
Optional
Default: "documents_visualization.html"
Configuration example
Generated from documented defaults. Replace any placeholders and complete required nested settings before running.
templates:
- template_name: "BERTopicFitModel"
class_name: "BERTopicFitModel"
attributes:
root_dir: "/home/ariel/.cache/sinapsis"
save_model_path: "bertopic_model"
umap_model_params:
a: null
b: null
init: "spectral"
metric: "euclidean"
n_jobs: -1
spread: 1
unique: false
densmap: false
verbose: false
min_dist: 0.1
n_epochs: null
dens_frac: 0.3
tqdm_kwds: null
low_memory: true
dens_lambda: 2
metric_kwds: null
n_neighbors: 15
output_dens: false
n_components: 2
random_state: null
learning_rate: 1
output_metric: "euclidean"
target_metric: "categorical"
target_weight: 0.5
dens_var_shift: 0.1
transform_mode: "embedding"
transform_seed: 42
precomputed_knn: {}
set_op_mix_ratio: 1
angular_rp_forest: false
local_connectivity: 1
output_metric_kwds: null
repulsion_strength: 1
target_metric_kwds: null
target_n_neighbors: -1
negative_sample_rate: 5
transform_queue_size: 4
disconnection_distance: null
force_approximation_algorithm: false
save_training_data: false
ctfidf_model_params:
seed_words: null
bm25_weighting: true
seed_multiplier: 2
reduce_frequent_words: true
image_export_params:
scale: null
width: null
format: "png"
height: null
validate_figure: true
sentence_model_name: "sentence-transformers/all-MiniLM-L6-v2"
hdbscan_model_params:
p: null
alpha: 1
kwargs: null
metric: "euclidean"
algorithm: "best"
leaf_size: 40
min_samples: null
prediction_data: true
core_dist_n_jobs: 4
max_cluster_size: 0
min_cluster_size: 5
gen_min_span_tree: false
allow_single_cluster: false
approx_min_span_tree: true
branch_detection_data: false
cluster_selection_method: "eom"
cluster_selection_epsilon: 0
cluster_selection_epsilon_max: null
cluster_selection_persistence: 0
match_reference_implementation: false
bertopic_model_params:
language: "english"
nr_topics: null
low_memory: false
top_n_words: 10
n_gram_range: [1, 1]
min_topic_size: 5
seed_topic_list: null
zeroshot_topic_list: null
calculate_probabilities: false
zeroshot_min_similarity: 0.7
save_training_data_path: "training_data.pkl"
bertopic_save_model_params:
save_ctfidf: true
serialization: "safetensors"
visualize_documents_params:
title: "<b>Documents and Topics</b>"
width: 1200
height: 750
sample: null
topics: null
custom_labels: false
hide_annotations: false
hide_document_hover: false
export_visualization_to_image: true
save_documents_visualization_path: "documents_visualization.html"
Inheritance
sinapsis_bertopic.templates.bertopic_base.BERTopicBaseEnvironment variables
Environment definitions belong to their canonical Python modules.