Daryl Lim commited on
Commit
af43646
·
1 Parent(s): 5d4b13d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +37 -0
README.md CHANGED
@@ -11,4 +11,41 @@ license: apache-2.0
11
  short_description: Summarize documents with Granite models.
12
  ---
13
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
11
  short_description: Summarize documents with Granite models.
12
  ---
13
 
14
+ # Granite Document Summarization
15
+
16
+ A streamlined document summarization application powered by IBM's Granite 3.3 Large Language Model.
17
+
18
+ ## Features
19
+
20
+ - Upload and process documents in multiple formats (PDF, DOCX, PPTX, HTML)
21
+ - Customize summaries by specifying the number of sentences (1-10) or paragraphs (1-3)
22
+ - GPU-optimized for fast processing
23
+ - Memory-efficient chunking and processing
24
+
25
+ ## How It Works
26
+
27
+ 1. Document Conversion: Uploaded documents are converted to markdown using Docling
28
+ 2. Text Chunking: The text is split into manageable chunks with semantic boundaries preserved
29
+ 3. Embedding Creation: Text chunks are converted to embeddings using Nomic Embed
30
+ 4. Summary Generation: IBM Granite 3.3 generates concise summaries based on your specifications
31
+
32
+ ## Requirements
33
+
34
+ - Python 3.9+
35
+ - GPU environment for optimal performance
36
+ - Dependencies listed in requirements.txt
37
+
38
+ ## Usage
39
+
40
+ 1. Upload a document (PDF, DOCX, PPTX, HTML)
41
+ 2. Choose between sentence-based or paragraph-based summarization
42
+ 3. Adjust the length using the slider or radio buttons
43
+ 4. Click "Summarize" to generate your summary
44
+
45
+ ## License
46
+
47
+ Apache 2.0
48
+
49
+ ---
50
+
51
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference