Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stavrostheocharis/quotera

Text paraphrasing tool
https://github.com/stavrostheocharis/quotera

fastapi paraphrase paraphrase-generation streamlit

Last synced: 2 months ago
JSON representation

Text paraphrasing tool

Host: GitHub
URL: https://github.com/stavrostheocharis/quotera
Owner: stavrostheocharis
License: mit
Created: 2022-10-10T16:40:40.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-08-29T14:50:39.000Z (over 1 year ago)
Last Synced: 2024-10-12T07:35:34.117Z (4 months ago)
Topics: fastapi, paraphrase, paraphrase-generation, streamlit
Language: Python
Homepage:
Size: 585 KB
Stars: 11
Watchers: 1
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

![Quotera](src/streamlit_quotera/references/logo_2.png)

[![Python Version](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9-blue.svg)](#supported-python-versions)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![License](https://img.shields.io/badge/License-MIT-informational.svg)](https://github.com/stavrostheocharis/quotera/blob/main/LICENSE)

Deploy a [Streamlit](https://streamlit.io/) app, or a [FastAPI](https://fastapi.tiangolo.com/) API to paraphrase text

## Requirements
### Python version
* Main supported version : 3.9

* Other supported versions : 3.7 & 3.8

To use the scripts on your computer, please make sure you have one of these versions installed.

### Install environment & dependencies

In order to run the needed scripts you need to have python installed and run the command below.
```
python3 -m venv /path/to/new/virtual/environment
```

To activate your `venv` run `source "env_name"/bin/activate`.

To install dependencies run the command:

```bash
pip install -r requirements.txt
```

Also for the parrot library run the command:

```bash
pip install git+https://github.com/PrithivirajDamodaran/Parrot_Paraphraser.git
```
### Paraphrase models

This implementation has taken into consideration AI models coming from [Hugging Face](https://huggingface.co/) (specifically the "prithivida/parrot_paraphraser_on_T5" in combination with the [Parrot_Paraphraser](https://github.com/PrithivirajDamodaran/Parrot_Paraphraser) package, but you can use other variations too). In order to run everything, an account and a token from Hugging Face are mandatory. In order to get everything ready, please read this [guide](https://huggingface.co/docs/hub/security-tokens).

Once you have a token from Hugging Face, create a token.txt file in your quotera folder and paste it inside your token (it will automatically be used by the app).

### How to use it

As stated there are 2 ways. You can use the Streamlit app, or the API.

Once installed the dependencies
- run the following command from CLI to open the app in the default web browser:

```
python quotera_streamlit_cli.py
```
- run the following command from CLI to open the API in the default web browser:

```
python quotera_cli.py serve
```

## How to contribute?

We welcome any suggestions, problem reports, and contributions!
For any changes you would like to make to this project, we invite you to submit an [issue]("https://github.com/stavrostheocharis/quotera/issues").

For more information, see [`CONTRIBUTING`](https://github.com/stavrostheocharis/quotera/blob/main/CONTRIBUTING.md) instructions.

If you wish to containerize the app, see [`DOCKER`](https://github.com/stavrostheocharis/quotera/blob/main/DOCKER.md) instructions.

## References
1. [How To Create an End-2-End Text Paraphrase App](https://medium.com/towards-artificial-intelligence/how-to-create-an-end-2-end-text-paraphrase-app-db83a4e05918)