Gradio アプリが正常に動作しているのに、ブラウザーのタブに汎用的な地球アイコンしか表示されない場合、そのアプリにはアイコンのメタデータが設定されていません。Gradio の favicon は launcher 経由で追加するのが最も簡単です。launcher から設定すれば、Gradio にファイルを登録できるため、生成されるページテンプレートを編集せずに済みます。
gr.HTML コンポーネントの中に <link> タグを挿入したり、すべてのコンポーネントで favicon を重複設定したりする必要はありません。アプリケーションの起動時に一度だけ favicon を設定し、その後、ブラウザーが実際にそのファイルをリクエストすることを確認してください。
前提条件
着手する前に、再起動できる Gradio アプリケーション、正方形のアイコンファイル、およびアプリを起動するプロセスへのアクセス権が必要です。
app.pyファイルまたはその他の Python エントリーポイントを備えた Gradio プロジェクトが必要です。- 正方形の
.icoファイルが必要です。ブラウザーでのフォールバックを安定させるには、ICO コンテナーに 16 px、32 px、48 px のアートワークを含めてください。 - launch コマンドまたは hosting platform へアクセスできることが必要です。アイコンファイルを読み取る権限も含めます。
アートワークが PNG または SVG として用意されている場合は、deployment 前に変換してください。Mzu favicondl を使って ICO を作成し、生成されたファイルは favicon.ico という名前のままにしてください。PNG to ICO ガイド では、サイズの選択肢を説明しています。
1. favicon ファイルを準備する
Python のエントリーポイントの隣に assets ディレクトリを作成してください。アイコンは安定したパスに保存し、ローカル環境、コンテナ、ホスティング環境のいずれでも、プロジェクトの各コピーが同じ参照を使うようにします。
your-gradio-app/
├── app.py
└── assets/
└── favicon.ico
タブ表示を想定してデザインしてください。通常、細かい文字よりも、太い形状や1文字だけの表現のほうが、16 px で描画されても識別しやすくなります。元画像は正方形に保ち、横幅の広い画像が予想外の形で切り取られることに依存しないでください。
2. launch() で Gradio の favicon を設定する
demo.launch() の favicon_path 引数に、アイコンファイルの絶対パスを渡してください。これは Gradio 固有の設定項目です。gr.Blocks() の中に指定しないでください。
from pathlib import Path
import gradio as gr
app_dir = Path(__file__).resolve().parent
favicon = app_dir / 'assets' / 'favicon.ico'
if not favicon.is_file():
raise FileNotFoundError(f'Favicon not found: {favicon}')
with gr.Blocks() as demo:
gr.Markdown('# My Gradio app')
demo.launch(favicon_path=str(favicon))Path(__file__).resolve().parent式は、アイコンの基準をシェルのカレントディレクトリではなくスクリプトに固定します。is_file()チェックにより、起動処理を続ける前に、存在しない、またはパスの指定に誤りがあるアセットを検出できます。このオプションにはローカルファイルを指定してください。リモートの画像URLは、デプロイ可能なアセットの代替にはなりません。
3. ローカルでアイコンを確認する
コードを変更したら、実行中のサーバーを停止して、もう一度起動してください。ブラウザーのタブはアイコンを強くキャッシュするため、以前のタブを信頼せず、新しいタブまたはプライベートウィンドウで結果を確認してください。
ページソースの<head>内を確認し、relの値がiconであるリンクを探してください。HTML仕様では、iconは外部リソースのlink relationとして定義されています。これにより、ブラウザーはアプリページとは別に、そのファイルを取得できます。
Developer ToolsでNetworkパネルを開き、ページを再読み込みしてください。アイコンのリクエストが404ではなく200を返すことを確認し、レスポンスがアップロードしたファイルになっているかを確認してください。リンクは存在するものの、タブには古いアイコンが表示されている場合は、キャッシュや競合するアイコンリンクを調べるための、より包括的なfaviconトラブルシューティングチェックリストを利用してください。
4. アセットをアプリと一緒にデプロイする
アイコンはノートPCだけでなく、アプリケーションと一緒にデプロイしてください。アプリの配布パッケージには、上で示された相対位置に置かれたapp.pyとassets/favicon.icoの両方が必要です。
- container imageを利用する場合、
app.pyを含む同じstageまたは最終イメージにassetsディレクトリをコピーしてください。 - Gitベースのデプロイでは、
.icoファイルをcommitしてください。ただし、ホスティングポリシーによってバイナリアセットを別の場所に保存している場合は除きます。 - カスタムサーバーを利用する場合は、起動コマンドがスクリプトの
demo.launch(...)呼び出しを実行するようにしてください。リポジトリ内のファイルだけでは、実行中のサーバーをそれ自体で設定することはできません。
プラットフォームが独自のサイトアイコン設定を用意している場合も、同じ確認事項が必要です。Gradio アプリを別のページに埋め込む場合、ブラウザータブを制御するのは top-level document になることがあります。この構成では、親ページのアイコンと Gradio の launcher のアイコンの両方を更新してください。
よくある落とし穴
Gradio の favicon 設定が失敗するケースの多くは、次のような小さなミスが原因です。
- 引数の指定位置が誤っている:
favicon_pathはlaunch()の引数であり、Blocks()やInterface()の引数ではありません。 - 相対パスが不安定:
assets/favicon.icoは process の開始位置によって解決結果が変わります。例示されているとおり、パスを__file__を基準に固定してください。 - デプロイ対象のファイルがない: ローカルでの実行が成功しただけでは、hosted build に
.icoファイルが含まれていることを確認できません。 - ファイルの内容が不正: PNG ファイルの名前を
favicon.icoに変更しないでください。代わりに、元の画像を ICO format に変換してください。 - browser cache が古い: application code を再び変更する前に、新しいタブを開くか、サイトの favicon データを消去してください。
- 親ページとの競合: Gradio が iframe 内に配置されている場合、タブアイコンは依然として外側のページによって決定されることもあります。
まとめ
Gradio の favicon は、launch 時の asset として管理するのが最も簡単です。アプリの横に正方形の ICO ファイルを配置し、解決後の path を launch(favicon_path=...) に渡して、表示に使うアイコンの request を確認してください。これにより実装は簡潔になり、local と hosted の Gradio app のどちらでも、mark を変更Bouときの更新対象が分かりやすい1つのファイルにまとまります。