Skip to content

Commit 6d715dc

Browse files
feat: expand README with detailed site overview, features, and usage instructions; adjust header styles for improved title scaling and text overflow handling
1 parent 0b6a489 commit 6d715dc

File tree

2 files changed

+99
-5
lines changed

2 files changed

+99
-5
lines changed

README.md

Lines changed: 96 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,97 @@
1-
# DeepBench paper site
1+
# DeepBench Paper – Interactive Site
22

3-
Static site for the DeepBench paper preview. This repository is configured to publish with GitHub Pages.
3+
Short description (use in GitHub About):
4+
Interactive companion site for the DeepBench paper: domain-specific robustness evaluation of Vision–Language Models (VLMs) with live corruption galleries, per-domain experiments (RQ1–RQ6), and copyable citations.
5+
6+
Live demo
7+
- GitHub Pages: https://ml-lab-htw.github.io/deepbench_paper/
8+
9+
Overview
10+
This repository contains a static, self-contained web site (HTML/CSS/JS) that presents the DeepBench paper’s results in an interactive format:
11+
- Corruption gallery with thumbnails and 4-up severity examples
12+
- Use Cases panel showing datasets and example images
13+
- Experiments panels RQ1–RQ6 with plots per domain and optional per-corruption filtering
14+
- Expandable Sources parsed from a BibTeX file (paper-style, no links)
15+
- “How to Cite” section with a light-themed, directly copyable BibTeX block
16+
- Graphical abstract and highlights
17+
- Modern sticky UI: shrinking page title, compact nav, sticky corruption thumbnails
18+
19+
Key features
20+
- Corruption Examples
21+
- Click thumbnails to switch corruption; shows four examples (severity levels) from assets/images/<Corruption>/
22+
- Supports a dynamic manifest at assets/images/manifest.json; falls back to conventional filenames
23+
- Use Cases
24+
- Dedicated panel with thumbnails, short domain descriptions, and 4 example images per use case
25+
- Experiments (RQ1–RQ6)
26+
- RQ1: LLM-based corruption selection
27+
- RQ2: Main robustness experiment across models and domains
28+
- RQ3: Domain specialists
29+
- RQ4: Architecture ablations
30+
- RQ5: Pretraining data effects (Acc + MCE/Flip)
31+
- RQ6: Label-Flip Probability correlation with accuracy
32+
- Per-domain plots live under assets/experiments/<experiment>/
33+
- Sources and Citations
34+
- BibTeX loaded from assets/references.bib and rendered as paper-style references (expandable)
35+
- Copyable BibTeX in “How to Cite,” light code theme with a one-click copy button
36+
- Polished UX
37+
- Sticky shrinking title + compact menu
38+
- Sticky corruption thumbnails that span multiple experiment sections
39+
- Smooth scrolling and automatic anchor offset so section headers aren’t covered
40+
- “Coming Soon” overlay toggle: ?comingSoon=1 or window.setComingSoon(true)
41+
42+
Project structure
43+
- index.html – Main page
44+
- css/style.css – Styles (header/menu, sticky title, thumbnails, code block theme, etc.)
45+
- js/main.js – Interactive logic (thumbnails, plots, sticky behavior, BibTeX rendering)
46+
- assets/
47+
- references.bib – Paper references (BibTeX)
48+
- images/ – Corruption examples and thumbnails (supports manifest.json)
49+
- experiments/ – Plots for RQ1–RQ6 (grouped by experiment)
50+
- CVIU_*.pdf, LaTeX sources, tables, and section .tex files used for content
51+
52+
Local preview
53+
You can serve the site locally with any static server. For example (Python 3):
54+
55+
```bash
56+
cd deepbench_paper
57+
python3 -m http.server 8000
58+
# Open http://localhost:8000
59+
```
60+
61+
Publishing with GitHub Pages (via Actions)
62+
This repository is pre-configured to deploy using GitHub Pages + Actions.
63+
64+
1) Enable Pages for this repo
65+
- On GitHub: Settings → Pages → Build and deployment → Source: GitHub Actions
66+
67+
2) Push to main
68+
- Every push to the main branch triggers the workflow at .github/workflows/deploy.yml
69+
- The deployed URL appears under Settings → Pages and in the “Deploy to GitHub Pages” step logs
70+
71+
Manual gh-pages alternative (optional)
72+
If you prefer a branch deployment:
73+
- Create a gh-pages branch with this site at the repo root
74+
- Settings → Pages → Deploy from a branch → gh-pages / (root)
75+
76+
Editing content
77+
- Add/replace plot images under assets/experiments/<experiment>/
78+
- Add or adjust corruption example images under assets/images/<Corruption>/
79+
- Optional: list the exact example filenames in assets/images/manifest.json to override auto-fallbacks
80+
- Update the bibliography in assets/references.bib
81+
- Update textual content in index.html (graphical abstract, highlights, RQ summaries) and css/style.css/js/main.js as needed
82+
83+
Useful toggles and behaviors
84+
- Coming Soon overlay
85+
- Enable via URL: ?comingSoon=1 or programmatically: window.setComingSoon(true)
86+
- Sticky thumbnails bar
87+
- Automatically sticks from “Corruption Examples” through the end of RQ6
88+
- Thumbnails shrink by 50% while sticky
89+
- Anchor offset
90+
- Sections use scroll-margin-top driven by a dynamic header offset so titles aren’t hidden under the sticky header
91+
92+
Suggested repository topics (GitHub → About → Topics)
93+
- computer-vision, robustness, benchmark, corruptions, vision-language-models, clip, siglip, llava, gemma, laion, datacomp, label-flip-probability, deepbench
94+
95+
Issues and contributions
96+
- Please open issues for bugs or enhancement requests
97+
- Pull requests welcome for plots, content, styles, or small JS improvements

css/style.css

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ header h1 {
4242

4343
header.scrolled h1 {
4444
transform: translateY(-2px);
45-
font-size: clamp(0.9rem, 4.25vw, 1.2rem); /* responsive small title */
45+
font-size: clamp(0.9rem, 4.25vw, 2.0rem); /* responsive small title */
4646
white-space: nowrap;
4747
overflow: hidden;
48-
text-overflow: ellipsis;
48+
text-overflow: clip;
4949
}
5050

5151
header.scrolled h1 br {
@@ -58,7 +58,7 @@ header.scrolled .affiliations {
5858
}
5959

6060
.small-of {
61-
font-size: 2.0rem; /* slightly smaller than surrounding title text */
61+
font-size: 1.7rem; /* slightly smaller than surrounding title text */
6262
}
6363

6464
header .site-nav {

0 commit comments

Comments
 (0)