import json
import logging
import math
from collections import OrderedDict, namedtuple
from functools import partial
from operator import attrgetter
from time import time
import numpy as np
import requests
import spacy
from sentence_transformers import SentenceTransformer
from sklearn.cluster import KMeans, MiniBatchKMeans
# Sklearn imports for cluster()
from sklearn.decomposition import TruncatedSVD
from sklearn.feature_extraction.text import (
HashingVectorizer,
TfidfTransformer,
TfidfVectorizer,
)
from sklearn.pipeline import make_pipeline
from sklearn.preprocessing import Normalizer
from sumy.nlp.stemmers import Stemmer
from sumy.nlp.tokenizers import Tokenizer
# Sumy Imports for generic_extractive_sumy()
from sumy.parsers.plaintext import PlaintextParser
from sumy.summarizers.edmundson import EdmundsonSummarizer
from sumy.summarizers.lex_rank import LexRankSummarizer
from sumy.summarizers.lsa import LsaSummarizer
from sumy.summarizers.luhn import LuhnSummarizer
from sumy.summarizers.random import RandomSummarizer
from sumy.summarizers.text_rank import TextRankSummarizer
from sumy.utils import get_stop_words
from tqdm import tqdm
# Import transformers and sentence_transformers for neural based feature extraction from text
from transformers import pipeline
logger = logging.getLogger(__name__)
[docs]def get_complete_sentences(text, return_string=False):
nlp = spacy.load("en_core_web_sm")
complete_sentences = []
text = text.replace("\n", " ").replace("\r", "")
NLP_DOC = nlp(text)
NUM_TOKENS = len(NLP_DOC)
NLP_SENTENCES = list(NLP_DOC.sents)
# Detect Complete Sentences:
# A complete sentence contains at least one subject, one predicate, one object, and closes
# with punctuation. Subject and object are almost always nouns, and the predicate is always
# a verb. Thus to check if a sentence is a complete sentence, check if it contains two nouns,
# one verb and closes with punctuation.
# https://stackoverflow.com/questions/50454857/determine-if-a-text-extract-from-spacy-is-a-complete-sentence
for sent in NLP_SENTENCES:
if sent[0].is_title and sent[-1].is_punct:
has_noun = 2
has_verb = 1
for token in sent:
if token.pos_ in ["NOUN", "PROPN", "PRON"]:
has_noun -= 1
elif token.pos_ == "VERB":
has_verb -= 1
if has_noun < 1 and has_verb < 1:
complete_sentences.append(sent)
if return_string:
return NUM_TOKENS, " ".join(complete_sentences)
return NUM_TOKENS, complete_sentences
[docs]def full_sents(ocr_text, transcript_text, remove_newlines=True, cut_off=0.70):
OCR_NUM_TOKENS, complete_sentences = get_complete_sentences(ocr_text)
OCR_NLP_SENTENCES_LENGTHS = [len(sentence) for sentence in complete_sentences]
OCR_NLP_SENTENCES_TOT_NUM_TOKENS = sum(OCR_NLP_SENTENCES_LENGTHS)
# Ratio of tokens in complete sentences to total number of token in document
# cst_to_dt = complete sentence tokens to document tokens
cst_to_dt_ratio = OCR_NLP_SENTENCES_TOT_NUM_TOKENS / OCR_NUM_TOKENS
logger.debug(
"Tokens in complete sentences: "
+ str(OCR_NLP_SENTENCES_TOT_NUM_TOKENS)
+ " | Document tokens: "
+ str(OCR_NUM_TOKENS)
+ " | Ratio: "
+ str(cst_to_dt_ratio)
)
if cst_to_dt_ratio > cut_off: # `cut_off`% of doc is complete sentences
complete_sentences_string = " ".join(complete_sentences)
return (
complete_sentences_string + transcript_text
) # use complete sentences and transcript
return transcript_text # only use transcript
[docs]def compute_ranks(sigma, v_matrix):
# Source: https://github.com/miso-belica/sumy/blob/master/sumy/summarizers/lsa.py
MIN_DIMENSIONS = 3
REDUCTION_RATIO = 1 / 1
if len(sigma) != v_matrix.shape[0]:
raise AssertionError("Matrices should be multiplicable")
dimensions = max(MIN_DIMENSIONS, int(len(sigma) * REDUCTION_RATIO))
powered_sigma = tuple(
s ** 2 if i < dimensions else 0.0 for i, s in enumerate(sigma)
)
ranks = []
# iterate over columns of matrix (rows of transposed matrix)
for column_vector in v_matrix.T:
rank = sum(s * v ** 2 for s, v in zip(powered_sigma, column_vector))
ranks.append(math.sqrt(rank))
return ranks
[docs]def get_best_sentences(sentences, count, rating, *args, **kwargs):
# Inspired by https://github.com/miso-belica/sumy/blob/master/sumy/summarizers/lsa.py
SentenceInfo = namedtuple(
"SentenceInfo",
(
"sentence",
"order",
"rating",
),
)
rate = rating
if isinstance(rating, list):
if not (not args and not kwargs):
raise AssertionError
rate = lambda o: rating[o] # noqa: E731
infos = (
SentenceInfo(s, o, rate(o, *args, **kwargs)) for o, s in enumerate(sentences)
)
# sort sentences by rating in descending order
infos = sorted(infos, key=attrgetter("rating"), reverse=True)
# get `count` first best rated sentences
infos = infos[:count]
# sort sentences by their order in document
infos = sorted(infos, key=attrgetter("order"))
return tuple(i.sentence for i in infos)
[docs]def get_sentences(text, model="en_core_web_sm"):
logger.debug("Tokenizing text...")
nlp = spacy.load(model)
NLP_DOC = nlp(text)
logger.debug("Text tokenized successfully")
NLP_SENTENCES = [str(sentence) for sentence in list(NLP_DOC.sents)]
NLP_SENTENCES_SPAN = list(NLP_DOC.sents)
NLP_SENTENCES_LEN = len(NLP_SENTENCES)
NLP_SENTENCES_LEN_RANGE = range(NLP_SENTENCES_LEN)
return (
NLP_DOC,
NLP_SENTENCES,
NLP_SENTENCES_SPAN,
NLP_SENTENCES_LEN,
NLP_SENTENCES_LEN_RANGE,
)
[docs]def keyword_based_ext(ocr_text, transcript_text, coverage_percentage=0.70):
from summa import keywords
ocr_text = ocr_text.replace("\n", " ").replace("\r", "")
ocr_keywords = keywords.keywords(ocr_text)
ocr_keywords = ocr_keywords.splitlines()
logger.debug("Number of keywords: " + str(len(ocr_keywords)))
vocab = dict(zip(ocr_keywords, range(0, len(ocr_keywords))))
vectorizer = TfidfVectorizer(vocabulary=vocab, stop_words="english")
_, NLP_SENTENCES, _, NLP_SENTENCES_LEN, _ = get_sentences(transcript_text)
NUM_SENTENCES_IN_SUMMARY = int(NLP_SENTENCES_LEN * coverage_percentage)
logger.debug(
str(NLP_SENTENCES_LEN)
+ " (Number of Sentences in Doc) * "
+ str(coverage_percentage)
+ " (Coverage Percentage) = "
+ str(NUM_SENTENCES_IN_SUMMARY)
+ " (Number of Sentences in Summary)"
)
doc_term_matrix = vectorizer.fit_transform(NLP_SENTENCES)
logger.debug("Vectorizer successfully fit")
# vectorizer.get_feature_names() is ocr_keywords
doc_term_matrix = doc_term_matrix.toarray()
doc_term_matrix = doc_term_matrix.transpose(
1, 0
) # flip axes so the sentences (documents) are the columns and the terms are the rows
u, sigma, v = np.linalg.svd(doc_term_matrix, full_matrices=False)
logger.debug("SVD successfully calculated")
ranks = iter(compute_ranks(sigma, v))
logger.debug("Ranks calculated")
sentences = get_best_sentences(
NLP_SENTENCES, NUM_SENTENCES_IN_SUMMARY, lambda s: next(ranks)
)
logger.debug("Top " + str(NUM_SENTENCES_IN_SUMMARY) + " sentences found")
return " ".join(sentences) # return as string with space between each sentence
[docs]def cluster(
text,
coverage_percentage=0.70,
final_sort_by=None,
cluster_summarizer="extractive",
title_generation=False,
num_topics=10,
minibatch=False,
hf_inference_api=False,
feature_extraction="neural_sbert",
**kwargs
):
"""Summarize ``text`` to ``coverage_percentage`` length of the original document by extracting features
from the text, clustering based on those features, and finally summarizing each cluster.
See the `scikit-learn documentation on clustering text <https://scikit-learn.org/stable/auto_examples/text/plot_document_clustering.html>`_
for more information since several sections of this function were borrowed from that example.
Notes:
* ``**kwargs`` is passed to the feature extraction function, which is either :meth:`~lecture2notes.end_to_end.summarization_approaches.extract_features_bow` or :meth:`~lecture2notes.end_to_end.summarization_approaches.extract_features_neural` depending on the ``feature_extraction`` argument.
Arguments:
text (str): a string of text to summarize
coverage_percentage (float, optional): The length of the summary as a percentage of the original document. Defaults to 0.70.
final_sort_by (str, optional): If `cluster_summarizer` is extractive and `title_generation` is False then
this argument is available. If specified, it will sort the final cluster
summaries by the specified string. Options are ``["order", "rating"]``. Defaults to None.
cluster_summarizer (str, optional): Which summarization method to use to summarize each individual cluster.
"Extractive" uses the same approach as :meth:`~lecture2notes.end_to_end.summarization_approaches.keyword_based_ext`
but instead of using keywords from another document, the keywords are
calculated in the ``TfidfVectorizer`` or ``HashingVectorizer``. Each keyword
is a feature in the document-term matrix, thus the number of words to use
is specified by the `n_features` parameter. Options are ``["extractive", "abstractive"].``
Defaults to "extractive".
title_generation (bool, optional): Option to generate titles for each cluster. Can not be used if
``final_sort_by`` is set. Generates titles by summarizing the text using
BART finetuned on XSum (a dataset of news articles and one sentence
summaries aka headline generation) and forcing results to be from 1 to
10 words long. Defaults to False.
num_topics (int, optional): The number of clusters to create. This should be set to the number of topics
discussed in the lecture if generating good titles is desired. If separating
into groups is not very important and a final summary is desired then this
parameter is not incredibly important, it just should not be set super
low (3) or super high (50) unless your document in super short or long. Defaults to 10.
minibatch (bool, optional): Two clustering algorithms are used: ordinary k-means and its more scalable
cousin minibatch k-means. Setting this to True will use minibatch k-means
with a batch size set to the number of clusters set in ``num_topics``. Defaults to False.
hf_inference_api (bool, optional): Use the huggingface inference API for abstractive summarization.
Defaults to False.
feature_extraction (str, optional): Specify how features should be extracted from the text.
* ``neural_hf``: uses a huggingface/transformers pipeline with the roberta model by default
* ``neural_sbert``: special bert and roberta models fine-tuned to extract sentence embeddings
* GitHub: https://github.com/UKPLab/sentence-transformers
* Paper: https://arxiv.org/abs/1908.10084
* ``spacy``: uses spacy model. All other options use the small spacy model to split
the text into sentences since sentence detection does not improve
with larger models. However, if spacy is specified for `feature_selection`
than the `en_core_web_lg` model will be used to extract high-quality embeddings
* ``bow``: bow = "bag of words". this method is extremely fast since it is based on
word frequencies throughout the input text. The :meth:`~lecture2notes.end_to_end.summarization_approaches.extract_features_bow`
function contains more details on recommended parameters that you can
pass to this function because of ``**kwargs``.
Options are ``["neural_hf", "neural_sbert", "spacy", "bow"]`` Default is "neural_sbert".
Raises:
Exception: If incorrect parameters are passed.
Returns:
[str]: The summarized text as a normal string. Line breaks will be included if ``title_generation`` is true.
"""
if cluster_summarizer not in ["extractive", "abstractive"]:
raise AssertionError
if feature_extraction not in ["neural_hf", "neural_sbert", "spacy", "bow"]:
raise AssertionError
if (cluster_summarizer == "extractive") and (feature_extraction != "bow"):
raise Exception(
"If cluster_summarizer is set to 'extractive', feature_extraction cannot be set to 'bow' because extractive summarization is based off the ranks calculated from the document-term matrix used for 'bow' feature extraction."
)
if final_sort_by:
if final_sort_by not in ["order", "rating"]:
raise AssertionError
if title_generation: # if final_sort_by and title_generation
raise Exception(
"Cannot sort by "
+ str(final_sort_by)
+ " and generate titles. Only one option can be specified at a time. In order to generate titles the clusters must not be resorted so each title coresponds to a cluster."
)
# If spacy is selected then return the `NLP_SENTENCES` as spacy Span objects instead of strings
# so they have the `vector` property. Also use the large model to get *real* word vectors.
# See: https://spacy.io/usage/vectors-similarity
if feature_extraction == "spacy":
(
NLP_DOC,
NLP_SENTENCES,
NLP_SENTENCES_SPAN,
NLP_SENTENCES_LEN,
NLP_SENTENCES_LEN_RANGE,
) = get_sentences(text, model="en_core_web_lg")
else:
(
NLP_DOC,
NLP_SENTENCES,
NLP_SENTENCES_SPAN,
NLP_SENTENCES_LEN,
NLP_SENTENCES_LEN_RANGE,
) = get_sentences(text)
if cluster_summarizer == "abstractive":
NLP_WORDS = [
token.text
for token in NLP_DOC
if (not token.is_stop) and (not token.is_punct)
]
NLP_WORDS_LEN = len(NLP_WORDS)
ABS_MIN_LENGTH = int(coverage_percentage * NLP_WORDS_LEN / num_topics)
logger.debug(
str(NLP_WORDS_LEN)
+ " (Number of Words in Document) * "
+ str(coverage_percentage)
+ " (Coverage Percentage) / "
+ str(num_topics)
+ " (Number Topics/Clusters) = "
+ str(ABS_MIN_LENGTH)
+ " (Abstractive Summary Minimum Length per Cluster)"
)
else:
NUM_SENTENCES_IN_SUMMARY = int(NLP_SENTENCES_LEN * coverage_percentage)
logger.debug(
str(NLP_SENTENCES_LEN)
+ " (Number of Sentences in Doc) * "
+ str(coverage_percentage)
+ " (Coverage Percentage) = "
+ str(NUM_SENTENCES_IN_SUMMARY)
+ " (Number of Sentences in Summary)"
)
NUM_SENTENCES_PER_CLUSTER = int(NUM_SENTENCES_IN_SUMMARY / num_topics)
logger.debug(
str(NUM_SENTENCES_IN_SUMMARY)
+ " (Number of Sentences in Summary) / "
+ str(num_topics)
+ " (Number Topics/Clusters) = "
+ str(NUM_SENTENCES_PER_CLUSTER)
+ " (Number of Sentences per Cluster"
)
if feature_extraction == "bow":
if cluster_summarizer == "extractive":
X, lsa_svd = extract_features_bow(
NLP_SENTENCES, return_lsa_svd=True, **kwargs
)
u, sigma, v = lsa_svd
ranks = compute_ranks(sigma, v)
logger.debug("Ranks calculated")
else:
X = extract_features_bow(NLP_SENTENCES, **kwargs)
elif feature_extraction == "spacy":
X = extract_features_spacy(NLP_SENTENCES_SPAN)
else: # `feature_extraction` contains "neural"
if "sbert" in feature_extraction:
X = extract_features_neural_sbert(NLP_SENTENCES, **kwargs)
else:
X = extract_features_neural_hf(NLP_SENTENCES, **kwargs)
if minibatch:
km = MiniBatchKMeans(n_clusters=num_topics, init_size=1000, batch_size=1000)
else:
km = KMeans(n_clusters=num_topics, max_iter=100)
logger.debug("Clustering data with %s", km)
t0 = time()
km.fit(X)
logger.debug("done in %0.3fs", (time() - t0))
sentence_clusters = [
[] for _ in range(num_topics)
] # initialize array with `num_topics` empty arrays inside
if cluster_summarizer == "extractive":
SentenceInfo = namedtuple(
"SentenceInfo",
(
"sentence",
"order",
"rating",
),
)
infos = (
SentenceInfo(*t) for t in zip(NLP_SENTENCES, NLP_SENTENCES_LEN_RANGE, ranks)
)
else:
SentenceInfo = namedtuple(
"SentenceInfo",
(
"sentence",
"order",
),
)
infos = (SentenceInfo(*t) for t in zip(NLP_SENTENCES, NLP_SENTENCES_LEN_RANGE))
logger.debug("Created sentence info tuples")
# Add sentence info tuples to the list representing their cluster number.
# If a sentence belongs to cluster 3, it is added to list 3 of the sentence_clusters master list.
for info in infos:
cluster_num = km.labels_[info.order]
sentence_clusters[cluster_num].append(info)
logger.debug("Sorted info tuples by cluster")
if title_generation:
final_sentences = []
else:
final_sentences = ""
titles = []
if cluster_summarizer == "abstractive":
summarizer_content = (
None if hf_inference_api else initialize_abstractive_model("bart")
)
if title_generation:
summarizer_title = (
"facebook/bart-large-xsum"
if hf_inference_api
else initialize_abstractive_model("facebook/bart-large-xsum")
)
for idx, cluster in tqdm(
enumerate(sentence_clusters),
desc="Summarizing Clusters",
total=len(sentence_clusters),
):
if cluster_summarizer == "extractive":
# If `title_generation` is enabled then create a single string holding the unsummarized
# sentences so it can be passed to the title generation algorithm. Also, if
# `title_generation` is enabled then
if title_generation:
cluster_unsummarized_sentences = " ".join([i.sentence for i in cluster])
# sort sentences by rating in descending order
cluster = sorted(cluster, key=attrgetter("rating"), reverse=True)
# get `count` first best rated sentences
cluster = cluster[:NUM_SENTENCES_PER_CLUSTER]
# sort sentences by their order in document
cluster = sorted(cluster, key=attrgetter("order"))
# if `title_generation` is enabled then the final cluster should be a string of sentences
if title_generation:
cluster = " ".join([i.sentence for i in cluster])
else:
# sort sentences by their order in document
cluster = sorted(cluster, key=attrgetter("order"))
# combine sentences in cluster into string
cluster_unsummarized_sentences = " ".join([i.sentence for i in cluster])
# summarize the sentences
cluster = generic_abstractive(
cluster_unsummarized_sentences,
summarizer_content,
min_length=ABS_MIN_LENGTH,
hf_inference_api=hf_inference_api,
)
if title_generation:
final_sentences.append(cluster)
else:
final_sentences += cluster
if title_generation:
# generate a title by running the
title = generic_abstractive(
cluster_unsummarized_sentences,
summarizer_title,
min_length=1,
max_length=10,
hf_inference_api=hf_inference_api,
)
titles.append(title)
if cluster_summarizer == "extractive":
if final_sort_by and not title_generation:
final_sentences = sorted(final_sentences, key=attrgetter(final_sort_by))
logger.debug("Extractive - Final sentences sorted by " + str(final_sort_by))
else:
# sort by cluster is default
logger.debug("Extractive - Final sentences sorted by cluster")
if not title_generation: # if extractive and not generating titles
final_sentences = " ".join([i.sentence for i in final_sentences])
if title_generation:
final = ""
for idx, group in enumerate(final_sentences):
final += "Title: " + titles[idx] + "\nContent: " + group + "\n\n"
return final
return final_sentences
[docs]def initialize_abstractive_model(sum_model, use_hf_pipeline=True, *args, **kwargs):
logger.debug("Loading " + sum_model + " model")
if use_hf_pipeline:
if sum_model == "bart":
sum_model = "sshleifer/distilbart-cnn-12-6"
SUMMARIZER = pipeline("summarization", model=sum_model)
else:
if sum_model == "bart":
import bart_sum
SUMMARIZER = bart_sum.BartSumSummarizer(*args, **kwargs)
elif sum_model == "presumm":
import presumm.presumm as presumm
SUMMARIZER = presumm.PreSummSummarizer(*args, **kwargs)
else:
logger.error("Valid model was not specified in `sum_model`. Returning -1.")
return -1
logger.debug(sum_model + " model loaded successfully")
return SUMMARIZER
[docs]def generic_abstractive_hf_api(
to_summarize, summarizer="facebook/bart-large-cnn", *args, **kwargs
):
api_url = "https://api-inference.huggingface.co/models/" + summarizer
data = {"inputs": to_summarize}
try:
response = requests.request("POST", api_url, data=json.dumps(data))
response.raise_for_status()
except requests.exceptions.HTTPError as e:
if e.response.status_code == 503: # Model not yet loaded on inference API
data["options"] = {"wait_for_model": True} # Wait for model to load
logger.debug(
"Waiting for huggingface inferene API to load model '%s'", summarizer
)
response = requests.request("POST", api_url, data=json.dumps(data))
else:
logger.error("Unknown error returned from huggingface inference API")
raise e
response_json = json.loads(response.content.decode("utf-8"))
return response_json
[docs]def generic_abstractive(
to_summarize,
summarizer=None,
min_length=None,
max_length=None,
hf_inference_api=False,
*args,
**kwargs
):
if hf_inference_api:
if summarizer is None:
summarizer = "facebook/bart-large-cnn"
if type(summarizer) is not str:
logger.error(
"The `summarizer` passed to `generic_abstractive()` is not a string but `hf_inference_api` is enabled. This will cause an error with the huggingface inference API."
)
summarizer = partial(generic_abstractive_hf_api, summarizer=summarizer)
else:
if summarizer is None:
summarizer = "sshleifer/distilbart-cnn-12-6"
if isinstance(summarizer, str):
summarizer = initialize_abstractive_model(summarizer, *args, **kwargs)
if not min_length:
TO_SUMMARIZE_LENGTH = len(to_summarize.split())
min_length = int(TO_SUMMARIZE_LENGTH * 0.1)
min_length = min(
min_length, 512
) # If the length is too long the model will start to repeat
if not max_length:
max_length = int(TO_SUMMARIZE_LENGTH * 0.6)
LECTURE_SUMMARIZED = summarizer(
to_summarize, min_length=min_length, max_length=max_length
) # length options have no effect when using the HF API
if type(LECTURE_SUMMARIZED) is list: # hf pipeline or api was used
return LECTURE_SUMMARIZED[0]["summary_text"]
return LECTURE_SUMMARIZED
[docs]def create_sumy_summarizer(algorithm, language="english"):
stemmer = Stemmer(language)
if algorithm == "lsa":
summarizer = LsaSummarizer(stemmer)
elif algorithm == "luhn":
summarizer = LuhnSummarizer(stemmer)
elif algorithm == "lex_rank":
summarizer = LexRankSummarizer(stemmer)
elif algorithm == "text_rank":
summarizer = TextRankSummarizer(stemmer)
elif algorithm == "edmundson":
summarizer = EdmundsonSummarizer(stemmer)
elif algorithm == "random":
summarizer = RandomSummarizer(stemmer)
return summarizer
[docs]def structured_joined_sum(
ssa_path,
transcript_json_path,
frame_every_x=1,
ending_char=".",
first_slide_frame_num=0,
to_json=False,
summarization_method="abstractive",
max_summarize_len=50,
abs_summarizer="sshleifer/distilbart-cnn-12-6",
ext_summarizer="text_rank",
hf_inference_api=False,
*args,
**kwargs
):
"""Summarize slides by combining the Slide Structure Analysis (SSA) and transcript json
to create a per slide summary of the transcript. The content from the beginning of one
slide to the start of the next to the nearest ``ending_char`` is considered the transcript
that belongs to that slide. The summarized transcript content is organized in a dictionary
where the slide titles are keys. This dictionary can be returned as json or written to a
json file.
Args:
ssa_path (str): Path to the SSA JSON file.
transcript_json_path (str): Path to the transcript JSON file.
frame_every_x (int, optional): How often frames were extracted from the video that the SSA
was conducted on. This is used to convert frame numbers to time (seconds). Defaults to 1.
ending_char (str, optional): The character that the transcript belonging to each slide will
be extended to. For instance, if the next slide appears in the middle of a word, the
transcript content will continue to be added to the previous slide until the
``ending_char`` is reached. It is recommended to use periods or a special end of
sentence token if present. These can be generated with
:meth:`lecture2notes.end_to_end.transcribe.transcribe_main.segment_sentences` Defaults to ``" "`` (nearest
complete word).
first_slide_frame_num (int, optional): The frame number of the first slide. Used to create a
'preface' (aka an introduction) if the first slide is not immediately shown. Defaults to 0.
to_json (bool or str, optional): If the output dictionary should be returned as a JSON string.
This can also be set to a path as a string and the JSON data will be dumped to the file
at that path. Defaults to False.
summarization_method (str, optional): The method to use to summarize each slide's
transcript content. Options include "abstractive", "extractive", or "none". Defaults
to "abstractive".
max_summarize_len (int, optional): Text longer than this many tokens will be summarized.
Defaults to 50.
abs_summarizer (str, optional): The abstractive summarization model to use if
`summarization_method` is "abstractive". Defaults to "sshleifer/distilbart-cnn-12-6".
hf_inference_api (bool, optional): Use the huggingface inference API for abstractive
summarization. Defaults to False.
``*args`` and ``**kwargs`` are passed to the summarization function, which is either
:meth:`~lecture2notes.end_to_end.summarization_approaches.generic_abstractive` or
:meth:`~lecture2notes.end_to_end.summarization_approaches.generic_extractive_sumy` depending on
``summarization_method``.
Returns:
dict or str: A dictionary containing the slide titles as keys and the summarized transcript
content for each slide as values. A string will be returned when ``to_json`` is set. If
``to_json`` is ``True`` (boolean) the JSON data formatted as a string will be returned.
If ``to_json`` is a path (string), then the JSON data will be dumped to the file specified
and the path to the file will be returned.
"""
if summarization_method not in [
"abstractive",
"extractive",
"none",
]:
raise AssertionError("Invalid summarization method")
first_slide_frame_num = int(first_slide_frame_num)
with open(ssa_path, "r") as ssa_file, open(
transcript_json_path, "r"
) as transcript_json_file:
ssa = json.load(ssa_file)
transcript_json = json.load(transcript_json_file)
transcript_json_idx = 0
current_time = 0
if first_slide_frame_num == 0:
# Don't create a 'preface' if the first slide is shown immediately
final_dict = OrderedDict()
else:
first_slide_timestamp_seconds = first_slide_frame_num * frame_every_x
transcript_before_slides = ""
while True:
current_letter_obj = transcript_json[transcript_json_idx]
try:
current_time_to_be_set = current_letter_obj["start"]
if current_time_to_be_set != 0:
current_time = current_time_to_be_set
except KeyError: # no `start` so use the previous value
pass
try:
add_space = not transcript_json[transcript_json_idx + 1]["word"] == "."
except IndexError:
add_space = False
to_add = current_letter_obj["word"]
if add_space:
to_add += " "
transcript_before_slides += to_add
transcript_json_idx += 1
if current_time >= first_slide_timestamp_seconds and current_letter_obj[
"word"
].strip().endswith(ending_char):
break
transcript_before_slides = transcript_before_slides.strip()
final_dict = OrderedDict({"Preface": {"transcript": transcript_before_slides}})
no_conclusion = False
for idx, slide in tqdm(
enumerate(ssa), total=len(ssa), desc="Grouping Slides and Transcript"
):
title_lines = [i for i, x in slide["category"].items() if x == 2]
all_slide_content = []
current_par_num = 0
prev_line_num = 0
for line_idx, line in slide["text"].items():
stored_line_num = slide["line_num"][line_idx]
# If the line number did not increase by 1 then assume a new paragraph
if stored_line_num != prev_line_num + 1:
current_par_num += 1
# If the line is not footer text and is not a title
if slide["category"][line_idx] not in (-1, 2):
current_line_is_bold = slide["category"][line_idx] == 1
# If the line is bold then add "**" on either side
if current_line_is_bold:
line = "**" + line + "**"
try:
# If the previously added line was bold (it ended in "**") and current
# line is bold
if (
all_slide_content[current_par_num][-2:] == "**"
and current_line_is_bold
):
# Remove the first "**" from the line to be added
line = line[2:]
# Remove the last "**" from the previously added line
all_slide_content[current_par_num] = all_slide_content[
current_par_num
][:-2]
# Add the line to the current paragraph with a space to avoid combined words
all_slide_content[current_par_num] += " " + line
except IndexError: # Paragraph not yet created, so create it
# Add the first line of a paragraph to `all_slide_content`
all_slide_content.append(line)
# Update the previous line number to the current line number
prev_line_num = stored_line_num
# Only include paragraphs greater than 3 characters
all_slide_content = [x for x in all_slide_content if len(x) > 3]
title = " ".join([slide["text"][line] for line in title_lines]).strip()
if not title:
title = "Slide {}".format(idx + 1)
current_slide_timestamp_seconds = ssa[idx]["frame_number"] * frame_every_x
coresponding_transcript_text = ""
while True:
# If `transcript_json` out of items break the loop
if transcript_json_idx == len(transcript_json):
no_conclusion = (
True # already reached end so don't created 'conclusion'
)
break
current_letter_obj = transcript_json[transcript_json_idx]
try:
current_time_to_be_set = current_letter_obj["start"]
if current_time_to_be_set != 0:
current_time = current_time_to_be_set
except KeyError: # no `start` so use the previous value
pass
try:
add_space = not transcript_json[transcript_json_idx + 1]["word"] == "."
except IndexError:
add_space = False
to_add = current_letter_obj["word"]
if add_space:
to_add += " "
coresponding_transcript_text += to_add
transcript_json_idx += 1
# If the current time is past the next slide time advance to the next slide.
# However, jump forward a few letter if necessary in order to end the current
# transcript-slide segment with `endding_char`.
if current_time >= current_slide_timestamp_seconds and current_letter_obj[
"word"
].strip().endswith(ending_char):
break
final_dict[title] = {"transcript": coresponding_transcript_text.strip()}
final_dict[title]["slide_content"] = all_slide_content
final_dict[title]["frame_number"] = slide["frame_number"]
if "figure_paths" in slide.keys():
final_dict[title]["figure_paths"] = slide["figure_paths"]
# Add 'conclusion' (transcript after last slide) as long as the end of the transcript
# has not already been reached.
if not no_conclusion:
coresponding_transcript_text = ""
while True:
# If `transcript_json` out of items break the loop
if transcript_json_idx >= len(transcript_json):
break
current_letter_obj = transcript_json[transcript_json_idx]
try:
current_time_to_be_set = current_letter_obj["start"]
if current_time_to_be_set != 0:
current_time = current_time_to_be_set
except KeyError: # no `start` so use the previous value
pass
try:
add_space = not transcript_json[transcript_json_idx + 1]["word"] == "."
except IndexError:
add_space = False
to_add = current_letter_obj["word"]
if add_space:
to_add += " "
coresponding_transcript_text += to_add
transcript_json_idx += 1
final_dict["Conclusion"] = {"transcript": coresponding_transcript_text}
if summarization_method not in ("none", None):
if summarization_method == "abstractive" and not hf_inference_api:
abs_summarizer = initialize_abstractive_model(abs_summarizer)
for title, content in tqdm(final_dict.items(), desc="Summarizing Slides"):
content = content["transcript"]
if len(content.split(" ")) > max_summarize_len:
if summarization_method == "abstractive":
final_dict[title]["transcript"] = generic_abstractive(
content,
abs_summarizer,
hf_inference_api=hf_inference_api,
*args,
**kwargs
)
else:
final_dict[title]["transcript"] = generic_extractive_sumy(
content, algorithm=ext_summarizer, *args, **kwargs
)
else:
final_dict[title]["transcript"] = content
if to_json:
json_list_dict = [{"title": key, **value} for key, value in final_dict.items()]
if type(to_json) is bool:
return json.dumps(json_list_dict)
with open(to_json, "w+") as json_file:
json.dump(json_list_dict, json_file)
return json.dumps(json_list_dict)
return final_dict
# structured_joined_sum("process/slide-ssa.json", "process/audio.json", to_json="process/summarized.json", first_slide_frame_num=0, summarization_method="none", hf_inference_api=True)