TELF.post_processing.ArcticFox: Report generation tool for text data from HNMFk using local LLMs#

Report generation tool for text data from HNMFk using local LLMs.

Available Functions#

`ArcticFox.__init__`(model[, embedding_model, ...])
`ArcticFox.run_full_pipeline`(vocab, data_df)
`ArcticFox.run_labeling`(df, top_words_df, ...)
`ArcticFox.run_postprocessing`(V, D[, col_name])
`ArcticFox.run_stats`([process_parents, ...])

Module Contents#

class TELF.post_processing.ArcticFox.arcticfox.ArcticFox(model, embedding_model='SCINCL', distance_metric='cosine', center_metric='centroid', text_cols=None, top_n_words=50, clean_cols_name='clean_title_abstract', col_year='year', col_type='type', col_cluster='cluster', col_cluster_coords='cluster_coordinates', col_similarity='similarity_to_cluster_centroid')[source]#

Bases: object

run_full_pipeline(vocab, data_df, text_column=None, ollama_model='llama3.2:3b-instruct-fp16', label_clusters=True, generate_stats=True, generate_visuals=True, process_parents=True, skip_completed=True, label_criteria=None, label_info=None, number_of_labels=5)[source]#

run_labeling(df, top_words_df, ollama_model_name, label_criteria=None, additional_info=None, number_of_labels=5)[source]#

run_postprocessing(V, D, col_name=None, **kwargs)[source]#

run_stats(process_parents=True, skip_completed=True)[source]#