Skip to content

Update and simplify DocSum tutorials #354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mkbhanda merged 5 commits into from
Apr 18, 2025
Merged

Update and simplify DocSum tutorials #354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2619525
simplify and update DocSum tutorial
alexsin368 Apr 16, 2025
11feda7
update docker ps logs
alexsin368 Apr 16, 2025
2b92455
Merge branch 'opea-project:main' into val_updates_docsum
alexsin368 Apr 17, 2025
d8a0635
fix wording and typos
alexsin368 Apr 18, 2025
577cb65
Merge branch 'main' into val_updates_docsum
mkbhanda Apr 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 6 additions & 11 deletions tutorial/DocSum/DocSum_Guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,34 @@
DocSum
#####################

.. note:: This guide is in its early development and is a work-in-progress with
placeholder content.

Overview
********

The DocSum example is designed to process diverse content types—text documents, spoken language (audio),
and visual media (video)—and generate concise summaries that capture the essence of the original material.
This pipeline integrates ASR(automatic speech recognition) with an LLM using TGI to summarize the content.
This example can be used to create summaries of news articles, research papers, technical documents, legal documents,
multimedia documents, and other types of documents.
The DocSum example is designed to process diverse content types including text documents, spoken language (audio), and visual media (video) to generate concise summaries that capture the essence of the original material.
This pipeline integrates ASR (automatic speech recognition) with an LLM to summarize the content.
This example can be used to create summaries of news articles, research papers, technical documents, legal documents, multimedia documents, and other types of documents.

Purpose
*******
* Quick Content Understanding: Saves time by providing concise overviews of lengthy documents, enabling users to focus on essential information.
* Knowledge Management: Organizes and indexes large repositories of documents, making information retrieval and navigation more efficient.
* Research and Analysis: Simplifies the synthesis of insights from multiple reports or articles, accelerating data-driven decision-making.
* Content Creation and Editing : Generates drafts or summaries for presentations, briefs, or automated reports, streamlining content workflows.
* Content Creation and Editing: Generates drafts or summaries for presentations, briefs, or automated reports, streamlining content workflows.
* Legal and Compliance: Extracts key clauses and obligations from contracts or guidelines, ensuring compliance while reducing review effort.


How It Works
************

The Docsum example uses an open-source model served using a framework such as Text Generation Inference (TGI) or vLLM to construct a summary
The Docsum example uses an open-source model served using a framework such as Text Generation Inference (TGI) or vLLM to construct a summary
of the input provided. It can process textual, audio, and video input from a variety of sources as shown in the diagram below.

.. figure:: /GenAIExamples/DocSum/assets/img/docsum_architecture.png
:alt: DocSum Architecture Diagram

Deployment
**********
Here are some deployment options, depending on your hardware and environment:
Here are some deployment options, depending on the hardware and environment:

.. toctree::
:maxdepth: 1
Expand Down
Loading