README.md

# Gradio Flow <img src="frontend/src/images/logo.svg" style="width:40px; height:40px;"/> 

## 👋 Reach Me For Inquiry or Bugs
```console
@Discord-Server: Hugging Face https://discord.com/invite/feTf9x3ZSB
@Discord-Name : Luca Vivona

```

## What Is Gradio Flow
**A web application with a backend in [Flask](https://flask.palletsprojects.com/en/2.2.x/) and frontend in [React](https://reactjs.org), and  [React flow](https://reactflow.dev/) node base environment to
stream both [Gradio](https://gradio.app) ( and later [Streamlit](https://streamlit.io) ) interfaces, within a single application.**
 
 
## Tabel Of Contents 📚
 - [**Application**](#application-%EF%B8%8F)


 - [**Updates**](#updates-%EF%B8%8F)
    
    
    - [**Backend**](#backend-)
    
    
    - [**Frontend**](#frontend-%EF%B8%8F)
    
    
    - [**In The Works**](#in-the-works-)

 - [**App Architecture**](#app-architecture-%EF%B8%8F)
 
 - [**Prerequisites**](#prerequisites-)
 
 - [**Running The App**](#running-the-app-%EF%B8%8F)
 
   - [**Makefile Run**](#makefile-run-docker-)

    
     - [**Running the docker container**](#1-running-the-docker-container)
    
    
     - [**Entering the backend enviorment**](#2-entering-the-backend-enviorment)
    
    
     - [**Appending Nodes To Frontend From The Backend**](3-appending-nodes-to-frontend-from-the-backend)
   
   
   - [**Non-Docker Build**](#non-docker-build)
   
   
     - [**Build frontend**](#1-build-frontend-within-the-directory-frontend)
    
    
     - [**Run frontend**](#2-run-frontend-within-the-directory-frontend)
    
    
     - [**Build backend dependency**](#3-build-backend-dependency-within-the-directory-backend)
    
    
     - [**Build backend**](#4-run-backend-within-the-directory-backend)
    
    
     - [**Run Gradio within Gradio-Flow**](#5-run-gradio-within-gradio-flow)
 
 - [**More Demos**](#more-demos-)
 


## Application 🏛️
![Dark-Application](images/application_dark.png)
![Light-Application](images/application_light.png)

## Updates ⚒️
### Backend 💽
- errors within the function InterLauncher fixed
- port mapping fixed
- removed test prints
- ``__init__`` function takes inputs within class wrapper
- better determine registered functions within classes
- more examples located in the ``backend/src/example``
    - just import and launch or run them within the demoE.py file in ``backend/src``
- launch interface functions that takes the interface and appends it within the gradio-flow so if it's (load, from_pipline, Block, or any other prebuilt interface you have you can append them into Gradio-Flow)

```python
def InterLauncher(name, interface, listen=2000, **kwargs):
    port= kwargs["port"] if "port" in kwargs else DOCKER_PORT.determinePort()
    try:
        requests.post(f"http://{DOCKER_LOCAL_HOST}:{listen}/api/append/port", json={"port" : port, "host" : f'http://localhost:{port}', "file" : "Not Applicable", "name" : name, "kwargs" : kwargs})
    except Exception as e:
        print(f"**{bcolor.BOLD}{bcolor.FAIL}CONNECTION ERROR{bcolor.ENDC}** 🐛The listening api is either not up or you choose the wrong port.🐛 \n {e}")
        return

    interface.launch(server_port=port,
                     server_name=f"{DOCKER_LOCAL_HOST}",
                     inline= kwargs['inline'] if "inline" in kwargs else True,
                     share=kwargs['share'] if "share" in kwargs else None,
                     debug=kwargs['debug'] if "debug" in kwargs else False,
                     enable_queue=kwargs['enable_queue'] if "enable_queue" in kwargs else None,
                     max_threads=kwargs['max_threads'] if "max_threads" in kwargs else None,
                     auth=kwargs['auth'] if "auth" in kwargs else None,
                     auth_message=kwargs['auth_message'] if "auth_message" in kwargs else None,
                     prevent_thread_lock=kwargs['prevent_thread_lock'] if "prevent_thread_lock" in kwargs else False,
                     show_error=kwargs['show_error'] if "show_error" in kwargs else True,
                     show_tips=kwargs['show_tips'] if "show_tips" in kwargs else False,
                     height=kwargs['height'] if "height" in kwargs else 500,
                     width=kwargs['width'] if "width" in kwargs else 900,
                     encrypt=kwargs['encrypt'] if "encrypt" in kwargs else False,
                     favicon_path=kwargs['favicon_path'] if "favicon_path" in kwargs else None,
                     ssl_keyfile=kwargs['ssl_keyfile'] if "ssl_keyfile" in kwargs else None,
                     ssl_certfile=kwargs['ssl_certfile'] if "ssl_certfile" in kwargs else None,
                     ssl_keyfile_password=kwargs['ssl_keyfile_password'] if "ssl_keyfile_password" in kwargs else None,
                     quiet=kwargs['quiet'] if "quiet" in kwargs else False)
    
    try:
        requests.post(f"http://{DOCKER_LOCAL_HOST}:{ listen }/api/remove/port", json={"port" : port, "host" : f'http://localhost:{port}', "file" : 'Not Applicable', "name" : name, "kwargs" : kwargs})
    except Exception as e:    
        print(f"**{bcolor.BOLD}{bcolor.FAIL}CONNECTION ERROR{bcolor.ENDC}** 🐛The api either lost connection or was turned off...🐛 \n {e}")
```


### Frontend 🖥️
- Node Menu
    - Save Board Button
        - When the pages refreshes it loads the last saved board
    - Dynamic adjust the size of node
        - Draggable bottom to expand height
    - Delete node Button
        - Delete All Nodes if removed from Gradio-Flow
    - Link to gradio to host it in seprate tab
    - Refresh Button to refresh the iframe if need be
    - fixed some bugs from ``+ button`` for catching errors and wrong inputs
    - ``+ button`` now includes hugginface spaces, and gradio share
        - https://hf.space/embed/name_of_user/name_of_space/+
        - Examples: (https://hf.space/embed/marcop/musika/+, https://hf.space/embed/stabilityai/stable-diffusion/+)



![Node Menu](images/new_feature.png)

### In The Works 🚧
- Mutiple windows within the react-flow environment 
- Appending streamlit into gradio-flow
- Directory tree search that looks for files that contain classes and functions that are registered under the decorators that are in ``backend/src/resources`` allowing you to append all your registered functions with only using the frontend.



 ## App Architecture 🏗️
![architecture](images/architecture.png)
 
## Prerequisites 📝
You will need:
(Docker build 🐳 Currently Only on: Linux/Windows/Mac)
- [🐳  Docker](https://docs.docker.com/get-docker/)
- [🐋 Docker Compose](https://docs.docker.com/compose/install/) (included with Docker Desktop on Windows and macOS)
 
(Running Without docker)
- 🐍 Python 3.2+ (backend)
- npm 8.5.0 (frontend)
- node v16.14.2 (frontend)
## Running The App 🖥️
 
Starting up it's simple as every command is already within the Makefile.
 
### Makefile Run (Docker 🐳)
#### **1.** Running the docker container
```console
make up
// command running: docker-compose up -d --remove-orphans;
// **Ubuntu** sudo make up
```
The React application will be running on ``http://localhost:3001`` and the Flask will be running on ``http://localhost:2000``
#### **2.** Entering the backend enviorment
```console
make environment
// command running: docker exec -it backend bash;
// **Ubuntu** sudo make environment
```
Now that you're within the docker backend container environment you can start adding gradio/streamlit nodes within the frontend. (**Extra Note**) You do not need to be within the container environment to append nodes there is a feature to just run your own gradio application and then append it within the frontend by using the **+ button**. 
 
#### **3.** Appending Nodes To Frontend From The Backend

```console
> cd ./src/demo
> python demo.py -l 2000
//run example gradio application
```

### Non-Docker Build

#### **1.** Build Frontend (within the directory ``./frontend``)
```console
npm install
```
#### **2.** Run Frontend (within the directory ``./frontend``)
```console
npm start
```

#### **3.** Build Backend Dependency (within the directory ``./backend``)
```console
pip install -r requirements.txt
```

#### **4.** Run Backend (within the directory backend)

```console
python app.py -p 2000
//**NOTE** -p 2000 just assignes it localhost port 2000 anyother port will not work
```
#### **5.** Run Gradio within Gradio-Flow 
It is quite simple, and similar within the docker build, the first way you can append your gradio to the Gradio flow is through running your application at a reachable url that is provided ed when you run Gradio and appending it via ``+ button`` within the frontend, another way that is possible is that within the directory ``./backend/src/resources`` there is a code that you can use to convert your own class or functional  base code into basic gradio tabular interface by using decorators, these decorators will send the nesarry information to the backend flask api and update the frontend menu state in which you'll will be able to interact with it within the front end creating a hub for gradio build functions(**read more** [**here**](https://github.com/LVivona/GradioWrapper) or look at the code [**here**](https://github.com/LVivona/Gradio-Flow/blob/main/backend/src/resources/module.py) ).

**NOTE** If you use the gradio decorator compiler for gradio flow you need to set a listen port to 2000 or else the api will never get the key and will throw you an error, I'll also provided an example below if this isn't clear.

```python
# (functional base)
##########
from resources import register, tabularGradio

@register(["text"], ["text"], examples=[["Luca Vivona"]])
def Hello_World(name):
        return f"👋 Hello {name}, and welcome to Gradio Flow 🤗" 

if __name__ == "__main__":
    # run single gradio
    tabularGradio([Hello_World])  # tabularGradio([Hello_World], ["Greeting"])

    # run it within Gradio-Flow
    # tabularGradio([Hello_World], listen=2000) # tabularGradio([Hello_World], ["Greeting"], listen=2000)
    
```

```python
#(Class Base)
###########
from resources import GradioModule, register

@GradioModule
class Greeting:

    @register(["text"], ["text"], examples=[["Luca Vivona"]])
    def Hello_World(self, name):
        return f"👋 Hello {name}, and welcome to Gradio Flow 🤗" 

if __name__ == "__main__":
    # run just gradio
    Greeting().launch()
    # run it within Gradio-flow
    # Greeting().launch(listen=2000)
```

# More Demos ➕
Within the ``backend/src/demo`` directory there are some demos
```command
# type : class | function | load | None
# port : 2000 | None 
# python demo.py -e [type] -l [port]
(e.g)
> python demo.py -e class -l 2000
> python demo.py -e class
```