Sunil Surendra Singh commited on
Commit
f7510e6
·
1 Parent(s): 48fc275

Corrected assets path

Browse files
Files changed (1) hide show
  1. README.md +10 -10
README.md CHANGED
@@ -1,12 +1,12 @@
1
- <a href="https://text-paraphraser-gpt-sssingh.streamlit.app/" target="_blank"><img src="https://img.shields.io/badge/open_app_in_streamlit-f63366?style=for-the-badge&logo=streamlit&logoColor=black" /></a>
2
 
3
- <img src="https://github.com/sssingh/text-paraphraser-gpt/blob/main/assets/title.png?raw=true" width="1000" height="300"/><br><br>
4
 
5
- # Text Paraphraser
6
  ***This App demonstrates the `text paraphrasing` NLP functionality.***
7
  >Although this app focuses on `text-paraphrasing`, the design philosophy and architecture used in this app can easily be extended to include other NLP functionalities such as 'FAQ Generation from a text context', 'Question Answering', 'Document Summarization', 'Language Translation', and so on.
8
 
9
- # App UI Details
10
  The app contains two tabs: "ABOUT" and "TEXT PARAPHRASER".
11
 
12
  ## ABOUT
@@ -16,20 +16,20 @@ This page, describes the app usage and architecture
16
  Input a text paragraph in the provided text space and then click the 'Para' button. The app will analyse the input text and generate a 'paraphrased' version of the input text paragraph while keeping the sense of the paragraph unaltered. Below is an example of input and output...
17
 
18
  #### Input
19
- <img src="https://github.com/sssingh/text-paraphraser-gpt/blob/main/assets/input-text.png?raw=true"/><br>
20
 
21
  #### Output
22
- <img src="https://github.com/sssingh/text-paraphraser-gpt/blob/main/assets/output-text.png?raw=true"/>
23
 
24
  * Please keep in mind that this sample demo app is hosted utilizing the free tiers of'streamlit community cloud' and 'Amazon Web Services,' making it useable but somewhat lacking in speed and quality of paraphrasing.
25
  * Due to cost and resource limits, the App currently only supports a maximum of 100 words per paraphrase request.
26
  * Please also keep in mind that while using it for the first time or after a lengthy interval (more than 1 hour), the app may throw an "Internal Error" message. This is to be expected, as the free tier of AWS services is configured for 'cold-start,' and it may take a few minutes to warm up before serving the request. Having said that the performance appears to be fairly satisfactory for demo and testing purposes; but, if we had dedicated premium AWS resources provisioned, there will be no wait..
27
 
28
- #### Technical details
29
 
30
- ##### App Architecture:
31
 
32
- <img src="https://github.com/sssingh/text-paraphraser-gpt/blob/main/assets/architecture.png?raw=true"/>
33
 
34
  The app has three main components:
35
  1. **Streamlit cloud hosted UI**:
@@ -48,7 +48,7 @@ The app has three main components:
48
  * The app is set up to utilize the 'text-davinci-003' LLM. This may easily be changed to utilize any other more powerful LLM for better results, but the charges to be paid to OpenAI will most likely increase proportionally.
49
 
50
  # Project Source
51
- [👉 Visit GitHub Repo](https://github.com/sssingh/text-paraphraser-gpt)
52
 
53
  # Contact Me
54
  [![email](https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:sunil.surendra.singh7@gmail.com)
 
1
+ <a href="https://nlp-text-paraphraser-gpt-sssingh.streamlit.app/" target="_blank"><img src="https://img.shields.io/badge/open_app_in_streamlit-f63366?style=for-the-badge&logo=streamlit&logoColor=black" /></a>
2
 
3
+ <img src="https://github.com/sssingh/nlp-text-paraphraser-gpt/blob/main/assets/title.png?raw=true" width="1000" height="300"/><br><br>
4
 
5
+ # Introduction
6
  ***This App demonstrates the `text paraphrasing` NLP functionality.***
7
  >Although this app focuses on `text-paraphrasing`, the design philosophy and architecture used in this app can easily be extended to include other NLP functionalities such as 'FAQ Generation from a text context', 'Question Answering', 'Document Summarization', 'Language Translation', and so on.
8
 
9
+ # App Details
10
  The app contains two tabs: "ABOUT" and "TEXT PARAPHRASER".
11
 
12
  ## ABOUT
 
16
  Input a text paragraph in the provided text space and then click the 'Para' button. The app will analyse the input text and generate a 'paraphrased' version of the input text paragraph while keeping the sense of the paragraph unaltered. Below is an example of input and output...
17
 
18
  #### Input
19
+ <img src="https://github.com/sssingh/nlp-text-paraphraser-gpt/blob/main/assets/input-text.png?raw=true"/><br>
20
 
21
  #### Output
22
+ <img src="https://github.com/sssingh/nlp-text-paraphraser-gpt/blob/main/assets/output-text.png?raw=true"/>
23
 
24
  * Please keep in mind that this sample demo app is hosted utilizing the free tiers of'streamlit community cloud' and 'Amazon Web Services,' making it useable but somewhat lacking in speed and quality of paraphrasing.
25
  * Due to cost and resource limits, the App currently only supports a maximum of 100 words per paraphrase request.
26
  * Please also keep in mind that while using it for the first time or after a lengthy interval (more than 1 hour), the app may throw an "Internal Error" message. This is to be expected, as the free tier of AWS services is configured for 'cold-start,' and it may take a few minutes to warm up before serving the request. Having said that the performance appears to be fairly satisfactory for demo and testing purposes; but, if we had dedicated premium AWS resources provisioned, there will be no wait..
27
 
28
+ ## Technical details
29
 
30
+ ### App Architecture:
31
 
32
+ <img src="https://github.com/sssingh/nlp-text-paraphraser-gpt/blob/main/assets/architecture.png?raw=true"/>
33
 
34
  The app has three main components:
35
  1. **Streamlit cloud hosted UI**:
 
48
  * The app is set up to utilize the 'text-davinci-003' LLM. This may easily be changed to utilize any other more powerful LLM for better results, but the charges to be paid to OpenAI will most likely increase proportionally.
49
 
50
  # Project Source
51
+ [👉 Visit GitHub Repo](https://github.com/sssingh/nlp-text-paraphraser-gpt)
52
 
53
  # Contact Me
54
  [![email](https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:sunil.surendra.singh7@gmail.com)