Hugging Face's logo

Spaces:
ZackBradshaw
/
chat-nface
Configuration error

App Files Community
chat-nface / README.md
LucaVivona's picture
LucaVivona
Gradio Flow Application
c132e32
preview code
|
raw history blame
5.4 kB

Gradio Flow 🤗

A web application with a backend in Flask and frontend in Rect, and React Flow that use React flow node base environment to stream both gradio and streamlit interfaces, within a single application.

Tabel Of Contents 📚

App Architecture 🏗️

architecture

Prerequisites 📝

You will need: (Docker build 🐳 Currently Only on: Linux)

(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 

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 

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 

> cd ./src
> python index.py
//run example gradio application

Non-Docker Build

1. Build Frontend (within the directory ./frontend) 

npm install

2. Run Frontend (within the directory ./frontend) 

npm start

3. Build Backend Dependency (within the directory ./backend) 

pip install -r requirements.txt

4. Run Backend (within the directory backend) 

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/helper 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).

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.

#backend/src/demo.py (functional base)
##########
from helper.compiler import functionalCompiler, tabularGradio
import gradio as gr

@functionalCompiler(inputs=[gr.Textbox(label="name")], outputs=['text'], examples=[["Luca Vivona"]])
def Hello_World(name):
        return f"Hello {name}, and welcome to Gradio Flow 🤗" 

if __name__ == "__main__":
    tabularGradio([Hello_World()], ["hello world"], listen=2000)

#backend/src/index.py (Class Base)
###########
from helper.compiler import register, GradioCompiler
import gradio as gr

@GradioCompiler
class Greeting:

    @register(inputs=[gr.Textbox(label="name")], outputs=['text'], examples=[["Luca Vivona"]])
    def Hello_World(self, name):
        return f"Hello {name}, and welcome to Gradio Flow 🤗" 



if __name__ == "__main__":
    Greeting().run(listen=2000)

Application 🏛️

Application