docs: add Web App section to README and webapp user guide#1367
docs: add Web App section to README and webapp user guide#1367natoscott wants to merge 2 commits into
Conversation
WalkthroughThe documentation adds Web App installation and launch instructions, default server settings, a user-guide link, CLI flag details, and descriptions of always-visible and optional Gradio tabs. ChangesWeb App Documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 196-197: The default access documentation must clarify that the
app binds to 0.0.0.0 and that localhost:7860 is only the local access URL.
Update README.md lines 196-197 and docs/webapp_user_guide.md line 16 to include
the exposure warning and recommend invoking the app with --server-name 127.0.0.1
for local-only access.
- Line 192: Quote the webapp extra in both installation commands: update
README.md lines 192-192 and docs/webapp_user_guide.md lines 9-9 to use the
quoted aiconfigurator[webapp] requirement, while preserving the editable-install
command.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 35782dd7-9582-4982-9687-084667fa5e7e
📒 Files selected for processing (2)
README.mddocs/webapp_user_guide.md
📜 Review details
⏰ Context from checks skipped due to timeout. (6)
- GitHub Check: Collect snapshot (old)
- GitHub Check: Collect snapshot (new)
- GitHub Check: Build and Test (unit)
- GitHub Check: Cargo Deny
- GitHub Check: Rust/Python engine-step parity
- GitHub Check: Build and Test (e2e)
🧰 Additional context used
📓 Path-based instructions (2)
**/*
📄 CodeRabbit inference engine (.claude/rules/repo-guide.md)
**/*: Treat this file as the only always-injected rule file; do not add new always-on rules here without human approval. New rule files must includepaths:frontmatter.
When reviewing changes in a governed area, read that area's rule files first, even if path-based auto-loading does not occur during a read-only review. Rule violations are review findings even when the code works.
A task must remain within its module: collector tasks may change onlycollector/and its tests, generator tasks onlysrc/aiconfigurator/generator/and its tests, and SDK tasks must not modify either. Cross-module contract changes require explicit human approval.
Files:
docs/webapp_user_guide.mdREADME.md
⚙️ CodeRabbit configuration file
**/*: - Prefer applicable inline comments. When the correct fix is clear, small, and limited to the commented diff hunk, include it as a GitHub Suggested Change so the author can apply it with one click.
- Do not use a suggested change when the fix requires broader design choices, multiple files, generated artifacts, unavailable context, or validation that cannot be inferred from the diff.
- If a comment is not directly applicable, state the smallest concrete next step and why a one-click suggestion is not safe.
Files:
docs/webapp_user_guide.mdREADME.md
docs/**
⚙️ CodeRabbit configuration file
docs/**: - Check that docs match changed CLI, SDK, generator, backend, and support-matrix behavior.
- Flag docs that describe unsupported runtimes, stale command names, or behavior not covered by tests or support-matrix evidence.
Files:
docs/webapp_user_guide.md
🪛 LanguageTool
docs/webapp_user_guide.md
[grammar] ~5-~5: Ensure spelling is correct
Context: ...but with visual controls and plots. The webapp is not a CLI subcommand -- launch it di...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~41-~41: Ensure spelling is correct
Context: ... --server-port 8080 ``` ## Tabs The webapp is organized into tabs. Some are always...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
|
Thanks for the contribution. A side question though, do you guys actually use webapp often ? There are some internal discussions about fully retiring the webapp. Would this decision negatively impact your workflow ? @natoscott |
|
@Arsene12358 Hi! Just speaking for myself, I wouldn't say I use it "often" but I do find it useful occasionally. I've found it handy for exploring the available functionality. It presents all the options relating to an area in a single pane of glass, while perusing command line options its easier to miss things or not see the relationships between options as clearly. Low usage may also be a side-effect of it not being documented previously, so it lacked visibility? |
Document the Gradio webapp launch command, available flags, and tab descriptions. The webapp was previously undocumented. Signed-off-by: Nathan Scott <nathans@redhat.com> Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
e066578 to
bd36f31
Compare
Arsene12358
left a comment
Arsene12358
left a comment
There was a problem hiding this comment.
Reviewed against webapp/main.py::configure_parser on main — the flags table is fully accurate (all 8 flags, defaults, and gating match), the webapp extra and module entry point check out, and documenting the 0.0.0.0 default bind with the --server-name 127.0.0.1 recommendation is a good call.
Two things before merge:
- Tab names — 5 of the 9 documented tab names don't match the labels the UI actually renders (see inline comments). Since this is a user guide, the list should use the exact
gr.Tab(...)labels users will see on screen. - PR title — the title says "README and CLI user guide", but
docs/cli_user_guide.mdis untouched; the new file is a standalone webapp guide. Suggest retitling to something likedocs: add Web App section to README and new webapp user guide.
Coordination note: if #1369 lands, its always-visible Sizing Recommender tab will be missing from this guide's tab list — whichever PR merges second should update the list.
| - **Readme** -- Embedded documentation and version info. | ||
| - **Static** -- Single-point static latency exploration (select model, system, parallelism, and batch size to see estimated TTFT/TPOT). | ||
| - **Agg Pareto** -- Aggregated serving Pareto frontier search (analogous to `cli default` in agg mode). | ||
| - **Disagg Pareto** -- Disaggregated serving Pareto frontier search. | ||
| - **Pareto Comparison** -- Save and compare results from the Agg/Disagg Pareto tabs side by side. | ||
| - **Support Matrix** -- Interactive support matrix for model/system/backend combinations. |
There was a problem hiding this comment.
Three of these names don't match the labels the UI renders (from gr.Tab(...) in src/aiconfigurator/webapp/components/):
| Guide says | UI shows |
|---|---|
| Static | Static Estimation |
| Agg Pareto | Agg(IFB) Pareto Estimation |
| Disagg Pareto | Disaggregation Pareto Estimation |
(Readme, Pareto Comparison, and Support Matrix match.) Suggest using the exact on-screen labels so users can find the tabs the guide points at.
| - **Agg** (`--enable-agg`) -- Aggregated serving configuration explorer. | ||
| - **Disagg PD Ratio** (`--enable-disagg-pd-ratio`) -- Disaggregated prefill/decode ratio analysis. |
There was a problem hiding this comment.
Same here for the flag-gated tabs:
| Guide says | UI shows |
|---|---|
| Agg | Agg Estimation |
| Disagg PD Ratio | Disaggregation PD Ratio Analysis |
(Profiling matches.)
Fixes tab names to match the actual gr.Tab() labels rendered in the UI, as noted by Arsene12358 in review. Signed-off-by: Nathan Scott <nathans@redhat.com> Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
natoscott
changed the title
2 participants
Overview:
Documents the Gradio webapp launch command, available flags, and tab
descriptions. The webapp was previously undocumented — this adds a
standalone
docs/webapp_user_guide.mdand a short pointer in the README.Details:
docs/webapp_user_guide.mdcovering installation (pip install 'aiconfigurator[webapp]'), launch command (python -m aiconfigurator.webapp.main), server flags, and descriptions of allalways-visible and flag-gated tabs.
README.mdwith install/launch quickstartand a link to the full guide.
0.0.0.0(all interfaces)and recommended
--server-name 127.0.0.1for local-only access.Where should the reviewer start?
docs/webapp_user_guide.md— the new standalone guide (single file)README.md— the short "Web App" section (~10 lines)Related Issues:
Summary by CodeRabbit