RAHMAN00700 commited on
Commit
dca6fb4
·
1 Parent(s): 0c94dfd

updated Readme.md

Browse files
Files changed (2) hide show
  1. README.md +27 -0
  2. requirements.txt +1 -2
README.md CHANGED
@@ -9,4 +9,31 @@ app_file: app.py
9
  pinned: false
10
  ---
11
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
 
 
9
  pinned: false
10
  ---
11
 
12
+ # Summarization with txtai
13
+
14
+ This project allows you to summarize text and documents using the `txtai` library. The app provides an easy-to-use interface powered by **Streamlit** to input text or upload documents and get concise summaries generated through machine learning models.
15
+
16
+ ## Features
17
+ - **Text Summarization:** Input text and get a summarized version.
18
+ - **Document Summarization:** Upload documents (e.g., PDFs) and receive a concise summary.
19
+ - **Streamlit UI:** A simple and intuitive interface to interact with the summarization engine.
20
+
21
+ ## Technologies
22
+ - `txtai` for semantic search and text summarization
23
+ - `Streamlit` for building the user interface
24
+ - `PyPDF2` for reading PDF files
25
+
26
+ ## How to Run:
27
+
28
+ 1. Clone the repository and navigate into the project directory.
29
+ 2. Install the dependencies by running `pip install -r requirements.txt`.
30
+ 3. Start the Streamlit app with `streamlit run app.py`.
31
+ 4. Access the app on your browser (usually at `http://localhost:8501`), where you can input text or upload documents for summarization.
32
+
33
+ # Author
34
+ Developed by Abdul Rahman H
35
+
36
+ ## Show Your Support
37
+ If you like this project, please give a⭐
38
+
39
 
requirements.txt CHANGED
@@ -1,5 +1,4 @@
1
  txtai[all]
2
  streamlit
3
  PyPDF2
4
- #python-dotenv
5
- #langchain_2
 
1
  txtai[all]
2
  streamlit
3
  PyPDF2
4
+