# Summarize

# What is it?

After the AI sends back a message, the Summarize extension looks through the chat history and then uses an AI summarization model that runs on the Extras host machine to create a dynamic summary of events. This summary is then sent along with every user input afterwards.

# How is that useful?

Summarize helps the AI remain aware of the general developments of a long chat.

# Setup Instructions

Summarize requires the Extras server to run. It has no offline mode.

Install or Update Extras to the latest version.
Run Extras with the summarize module enabled: python server.py --enable-modules=summarize

# Configuration

Once Summarize is enabled, it will show up in ST's Extensions panel list.

Summary Contents Box - this displays the current summary. Summary is updated and embedded into the chat file's metadata for every message recieved from the AI.
Restore Previous State - Replaces the current summaryt with the summary from the previous message. This is useful if the summarizer does a poor job at any given point.
Stop Summarization Updates checkbox - check this to prevent the summary from being automatically updated. This is useful if you want to provide a custom summary of your own, or to effectively disable the summary by clearing the box and stopping udpates.
Chat to Summarize buffer length - This is the amount of chat context to be summarized, including the previous message's sumnmary. Limited to 1024 tokens.
Summary Output Length - The desired total length of the finished summary (what you see in the box). The summary will not always match this length, but the model will be encouraged to write enough to fill it.
Temperature - determines how creative the summary model is in writing the summary. higher values will produce more variation in the summary, at potential risk of inaccuracy.
Repetition Penalty - high numbers here will help reduce the amount of repetitious phrases in the summary. 1.15-1.2 are good values.
Length Preference - values below 1 will pressure the AI to create shorter summarize, and values over 1 will encentive the AI to create longer summaries.

# Changing Summary Model

By default, Summarize uses the Qiliang/bart-large-cnn-samsum-ChatGPT_v3 model for summarization purposes.

This can be changed by using the command line argument --summarization-model=(###Hugging-Face-Model-URL-Here###)

A known alternate Summarize model is Qiliang/bart-large-cnn-samsum-ElectrifAi_v10.

# Useage Notes

Sumamry does not begin working until the chat has continued long enough that all chat messages are no longer able to fit into the context window.
Summaries are saved individually as metadata for each message in the chat file.
Deleting a message from the chat will effectively remove its summary as well.