Corin1998 commited on
Commit
3979d9b
·
verified ·
1 Parent(s): 482a59c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +9 -51
README.md CHANGED
@@ -1,57 +1,15 @@
1
  ---
2
- title: Campaign Ad Space
3
- emoji: 📚
4
- colorFrom: blue
5
- colorTo: indigo
6
- sdk: gradio
7
- sdk_version: 5.44.1
8
- app_file: app.py
9
- pinned: false
10
  ---
11
 
12
  # キャンペーン生成器+自動A/Bテスト(Hugging Face Space)
13
 
14
- OpenAI API を用いて広告・LPの **クリエイティブ案を自動生成** し、Space 内で **配信・計測(CTR/CVR)**・**簡易多腕バンディット(ε-greedy)** による最適化を行うミニフレームワークです。
15
- **Hugging Face SpacesGradio)で完結** するよう構成ています。
16
 
17
- > ⚠️ 本サンプルは学習用・PoC用途です。実運用の前に各プラットフォーム規約や法令、社内ガイドラインを必ず確認くださ
18
-
19
- ---
20
-
21
- ## 主な機能
22
-
23
- - 目標(CTR/CVR)とブランドガイドを入力 → OpenAI で **複数クリエイティブ案** を JSON 生成
24
- - **ブランド従属性の簡易判定**(禁止ワード・長さなどローカルチェック)
25
- - Space 内で **配信URL** を自動生成:
26
- - `/v/<variant_id>` … 各バリアントのLP風ページ(インプレッション計測)
27
- - `/click?vid=...&to=...` … クリック計測 + リダイレクト
28
- - `/convert?vid=...` … コンバージョン計測
29
- - `/r` … **ローテータURL**(ε-greedyで割当)
30
- - **レポート**:インプレッション、クリック、コンバージョン、CTR/CVR を表で表示
31
- - **MVP要件**:生成→配信→CTR収集 を Space 内で完結
32
- - **拡張の足がかり**:
33
- - 多腕バンディット(現在は ε-greedy、UCB/Thompsonへの差し替え可)
34
- - MMM(Marketing Mix Modeling)連携用の枠は別途追加可能
35
- - 投稿スケジューラや各SNS API 連携はポリシー順守で拡張可能
36
-
37
- ---
38
-
39
- ## デモの使い方(Spaces)
40
-
41
- 1. このリポジトリを Hugging Face Spaces(SDK: **Gradio**)へデプロイ。
42
- 2. **Secrets** に `OPENAI_API_KEY` を設定。
43
- 3. スペースが起動したら `/gradio` を開き、フォームへ入力して「生成 → 反映」。
44
- 4. 返却される JSON に `"/r"`(ローテータ)と `"/v/<id>"`(各案)の URL が含まれます。
45
- 5. それらの URL に流入を集めると、Space 内で CTR/CVR が更新され、レポートで確認できます。
46
-
47
- > ※ デフォルトでは安全のため **外部ドメインへの自動リダイレクトは無効** です。`/click?vid=...&to=...` の `to` は相対パスのみ許可しています(本Space内で完結のため)。運用で外部LPへ飛ばす場合は、安全性・悪用対策を講じた上で許可制に書き換えてください。
48
-
49
- ---
50
-
51
- ## ローカル実行
52
-
53
- ```bash
54
- pip install -r requirements.txt
55
- export OPENAI_API_KEY=sk-... # もしくは .env / Secrets に設定
56
- uvicorn app:app --host 0.0.0.0 --port 7860
57
- # ブラウザで http://localhost:7860/gradio
 
1
  ---
2
+ title: Campaign Generator + Auto A/B (HF Space)
3
+ sdk: docker
4
+ license: mit
 
 
 
 
 
5
  ---
6
 
7
  # キャンペーン生成器+自動A/Bテスト(Hugging Face Space)
8
 
9
+ OpenAI API を用いて広告・LPの **クリエイティブ案を自動生成** し、Space 内で **配信・計測(CTR/CVR)**・**簡易多腕バンディット(ε-greedy)** を行います。
10
+ UI `/gradio` にあり、配信・計測用のエンドポイント`/r`, `/v/<id>`, `/click`, `/convert`も同一Space動作します。
11
 
12
+ ## 使
13
+ 1. 本リポジトリをアップロード(この README により SDK は自動で **docker** になります)
14
+ 2. Space の **Settings → Secrets** に `OPENAI_API_KEY` を設定
15
+ 3. UI: `…/<space>/gradio` を開く → 「生成 → 反映」