Adding Markdown And Other Text

Introduction

When an interface is shared, it is usually accompanied with some form of explanatory text, links or images. This guide will go over how to easily add these on gradio.

For example, take a look at this fun chatbot interface below. It has a title, description, image as well as links in the bottom.

The parameters in `Interface`

There are three parameters in Interface where text can go:

Title: which accepts text and can displays it at the very top of interface
Description: which accepts text, markdown or HTML and places it right under the title.
Article: which is also accepts text, markdown or HTML but places it below the interface.

annotated

Code example

Here's all the text-related code required to recreate the interface above.

import gradio as gr

title = "Talk To Me Morty"
description = """
<p>
<center>
The bot was trained on Rick and Morty dialogues Kaggle Dataset using DialoGPT.
<img src="https://huggingface.co/spaces/kingabzpro/Rick_and_Morty_Bot/resolve/main/img/rick.png" alt="rick" width="200"/>
</center>
</p>
"""
article = """
<p style='text-align: center'>
<a href='https://medium.com/geekculture/discord-bot-using-dailogpt-and-huggingface-api-c71983422701' target='_blank'>Complete Tutorial</a>
</p>

<p style='text-align: center'>
<a href='https://dagshub.com/kingabzpro/DailoGPT-RickBot' target='_blank'>Project is Available at DAGsHub</a>
</p>
"""
...

gr.Interface(fn=predict, ... , title=title, description=description, article=article).launch()

Of course, you don't have to use HTML and can instead rely on markdown. Here's a neat cheatsheet with the most common markdown commands.

In fact, since this guide itself is basically just HTML, I went ahead and passed the whole thing into the article parameter of an interface, and you can read it yourself here:

Adding Markdown And Other Text

Introduction

The parameters in Interface

Code example

That's all! Happy building :)

The parameters in `Interface`