Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Index your code
hub
/
github.com/StarTrail-org/PixelRAG
/ types & classes
Types & classes
108 in github.com/StarTrail-org/PixelRAG
⨍
Functions
1,050
◇
Types & classes
108
↳
Endpoints
6
↓ 68 callers
Class
RetrievalResult
Result from a retrieval operation.
eval/lib/retrieval.py:22
↓ 17 callers
Class
TileCapture
Raw capture result for one tile. Decoded later during verification.
render/src/pixelrag_render/strategies/base.py:15
↓ 16 callers
Class
ArticleCapture
Raw capture results for all tiles of one article.
render/src/pixelrag_render/strategies/base.py:29
↓ 14 callers
Class
LogitScale
Learnable logit scale (from contrastors/OpenCLIP). Contrastors uses a learnable log-scale initialized to ln(1/0.07) ≈ 2.66. The parameter is
train/train_contrastors.py:101
↓ 10 callers
Class
WebsocketConnection
Direct websocket CDP connection.
render/src/pixelrag_render/strategies/connection.py:20
↓ 5 callers
Class
Document
index/src/pixelrag_index/sources/base.py:8
↓ 3 callers
Class
ApiRequestError
Raised when text LLM calls fail after retries.
train/filter_text_hard_negatives_llm.py:82
↓ 3 callers
Class
ApiRequestError
Raised when VLM API calls fail after retries.
train/filter_hard_negatives_vqa.py:76
↓ 3 callers
Class
QueryImageDataset
Dataset of (query, positive_path, [negative_paths...]) from JSONL. Supports two formats: - Simple: {"query": "...", "chunk_path": "..."}
train/train_contrastors.py:549
↓ 3 callers
Class
TextAPIRetriever
Retrieve text chunks from a text search API (wiki-screenshot text_search_api.py). The API accepts: POST /search {"queries": [{"te
eval/lib/retrieval.py:3259
↓ 2 callers
Class
JinaReaderRetriever
Use Jina Reader API to fetch clean markdown text from URL. Jina Reader (r.jina.ai) converts any URL to LLM-friendly markdown text.
eval/lib/retrieval.py:829
↓ 2 callers
Class
LLMClient
Simplified async LLM client for Gemini using Vertex AI.
eval/lib/llm.py:453
↓ 2 callers
Class
LocalAPIRetriever
Retrieve tiles from a local search API (e.g. localhost:30888/search). The API accepts batch queries: {"queries": [{"text": "..."}, ...],
eval/lib/retrieval.py:2157
↓ 2 callers
Class
MissingImageError
Raised when a referenced image path no longer exists on disk.
train/filter_hard_negatives_vqa.py:72
↓ 2 callers
Class
WorldVQANoRetrievalRetriever
WorldVQA without retrieval: query + image from dataset only. WorldVQA images are embedded in the HuggingFace dataset (PIL or base64).
eval/lib/retrieval.py:574
↓ 1 callers
Class
CDPSequentialStrategy
Sequential tile capture. One screenshot at a time per page. Args: chrome_path: Chrome binary path. n_workers: Number of Chrome pr
render/src/pixelrag_render/strategies/cdp_sequential.py:26
↓ 1 callers
Class
ChunkInfo
Metadata for a single chunk image (1024px strip of a tile).
embed/src/pixelrag_embed/embed.py:179
↓ 1 callers
Class
ColQwenVectorRetriever
Retrieve similar screenshots using ColQwen2 LEANN multi-vector retrieval.
eval/lib/retrieval.py:1376
↓ 1 callers
Class
DsServeRetriever
Use ds-serve API for external text augmentation. Calls ds-serve search API to retrieve relevant text passages for the query.
eval/lib/retrieval.py:2041
↓ 1 callers
Class
EMAModel
Exponential Moving Average of model parameters for better generalization.
train/train_contrastors.py:124
↓ 1 callers
Class
EVQANoRetrievalRetriever
EVQA without retrieval: query + iNaturalist image only, no Wikipedia tiles. Used to test VLM's ability to answer from the species image alone.
eval/lib/retrieval.py:458
↓ 1 callers
Class
HTMLDOMLookupRetriever
Text-retrieve → DOM lookup: retrieve text chunks, then find their HTML context. Wraps TextAPIRetriever. For each retrieved text chunk: 1. Fet
eval/lib/retrieval.py:3809
↓ 1 callers
Class
Hit
serve/src/pixelrag_serve/api.py:90
↓ 1 callers
Class
HybridRetriever
Merge image (LocalAPIRetriever) and text (TextAPIRetriever) hits by raw score. Both underlying retrievers embed with Qwen3-VL-Embedding-2B agains
eval/lib/retrieval.py:3723
↓ 1 callers
Class
KiwixServeManager
Manages multiple kiwix-serve processes for high-concurrency serving. Benchmark results (80 concurrent requests, 2000 articles): 1x --thre
index/src/pixelrag_index/sources/kiwix.py:22
↓ 1 callers
Class
LocalWikiTiledScreenshotRetriever
Ground-truth tiled retriever using pre-rendered Wikipedia tiles from local kiwix. For each example, looks up the Wikipedia URL in the local kiwix
eval/lib/retrieval.py:722
↓ 1 callers
Class
MixedBatchSampler
Yields batches with exact per-source counts from a ConcatDataset. Each source occupies a contiguous index range [start, start+length). Every
train/train_contrastors.py:634
↓ 1 callers
Class
NaiveRetriever
No retrieval - returns empty result, LLM answers from its own knowledge.
eval/lib/retrieval.py:451
↓ 1 callers
Class
NoopProc
render/src/pixelrag_render/strategies/cdp_overlap.py:110
↓ 1 callers
Class
NoopProc
render/src/pixelrag_render/strategies/cdp_multitab.py:139
↓ 1 callers
Class
OCRWrappedRetriever
Wraps an image retriever; OCRs retrieved tiles and returns text. Ablation A pipeline: image retrieve -> OCR -> text to reader. Talks to an Op
eval/lib/retrieval.py:3454
↓ 1 callers
Class
PersistentGpuWorkerPool
Pool of persistent one-GPU workers with dynamic work distribution. Workers share a single work queue. Fast GPUs pull more work items, elimina
embed/src/pixelrag_embed/embed.py:1321
↓ 1 callers
Class
PixelQueryRenderer
Renders text queries as small, clear PNG images. Images are cached on disk so each query is only rendered once.
eval/lib/pixel_query.py:63
↓ 1 callers
Class
PlaywrightConnection
Playwright-managed CDP connection.
render/src/pixelrag_render/strategies/connection.py:157
↓ 1 callers
Class
QueryChunkDataset
Dataset of (query, chunk_path) pairs from JSONL.
train/dataset.py:18
↓ 1 callers
Class
QueryImageTextRenderer
Renders query text + query image together into a single card image. Reuses PixelQueryRenderer for text rendering. Layout: image on top, text belo
eval/lib/pixel_query.py:159
↓ 1 callers
Class
QueryResult
serve/src/pixelrag_serve/api.py:103
↓ 1 callers
Class
RandContext
Save/restore RNG state for GradCache replay (from contrastors/rand_state.py).
train/train_contrastors.py:72
↓ 1 callers
Class
RenderedTextWrapper
Wraps a text retriever; renders each chunk as an image. Ablation B pipeline: text retrieve -> render as Wikipedia-style image -> VLM reader.
eval/lib/retrieval.py:3645
↓ 1 callers
Class
S3ShardCoordinator
Coordinates shard distribution across machines via S3 claim files. Each machine runs a claim loop: while True: shard = coordi
index/src/pixelrag_index/distributed.py:29
↓ 1 callers
Class
ScreenshotRetriever
Use screenshot that was prepared in data layer. Expects screenshot to be captured beforehand. This retriever just loads and encodes the exist
eval/lib/retrieval.py:589
↓ 1 callers
Class
SearchResponse
serve/src/pixelrag_serve/api.py:107
↓ 1 callers
Class
StatusResponse
serve/src/pixelrag_serve/api.py:111
↓ 1 callers
Class
TextQueryDataset
Dataset of (query, positive_text, [negative_texts...]) from text-qa-pair JSONL. Each row has: query, passage (positive), neg_passages (list of ha
train/train_contrastors.py:692
↓ 1 callers
Class
TextRetriever
Use text content fetched from URL. Can use pre-cached text or fetch on demand.
eval/lib/retrieval.py:779
↓ 1 callers
Class
TextVectorRetriever
Retrieve text using LEANN vector search. Uses LEANN's integrated embedding + indexing system for text retrieval. Supports various embedding m
eval/lib/retrieval.py:1829
↓ 1 callers
Class
ThreadedHTTPServer
serve/src/pixelrag_serve/zim_server.py:19
↓ 1 callers
Class
TileInfo
Metadata for a single tile image (or a chunk of one).
embed/src/pixelrag_embed/embed.py:167
↓ 1 callers
Class
TiledColQwenVectorRetriever
Retrieve similar image tiles using ColQwen2 LEANN multi-vector retrieval. Splits dataset screenshots into fixed-size tiles, embeds each tile with
eval/lib/retrieval.py:1666
↓ 1 callers
Class
TiledQwen3VLEmbeddingRetriever
Retrieves context by searching through image tiles using Qwen3-VL-Embedding. Uses single vector embeddings (2048 dim) with cosine similarity for
eval/lib/retrieval.py:2706
↓ 1 callers
Class
TiledScreenshotRetriever
Use tiled screenshot from ground truth URL. Captures screenshot for the example's URL, splits it into tiles, and returns tiles. This is groun
eval/lib/retrieval.py:643
↓ 1 callers
Class
TiledVectorRetriever
Retrieve similar image tiles using vector similarity search. Splits dataset screenshots into fixed-size tiles, embeds each tile, and retrieve
eval/lib/retrieval.py:1514
↓ 1 callers
Class
TwoTabConnection
Chrome process with two tabs, each independently controllable.
render/src/pixelrag_render/strategies/cdp_pipelined_dc.py:55
↓ 1 callers
Class
VectorRetriever
Retrieve similar screenshots using vector similarity search. Uses Jina API for embedding and retrieval across dataset screenshots only.
eval/lib/retrieval.py:1265
↓ 1 callers
Class
WikipediaAPIRetriever
Use Wikipedia API to fetch clean article text. Extracts Wikipedia page title from URL and fetches content via API. Much cleaner and faster th
eval/lib/retrieval.py:1010
↓ 1 callers
Class
ZimApp
serve/src/pixelrag_serve/zim_server_async.py:20
↓ 1 callers
Class
_Conn
Minimal CDP connection with a receive loop.
render/src/pixelrag_render/backends/fast_cdp.py:147
Interface
ArticleGroup
web/lib/types.ts:48
Class
BaseRetriever
Base class for retrieval strategies.
eval/lib/retrieval.py:56
Class
Bench
Benchmark harness. Measures throughput/latency and verifies correctness. Usage: bench = Bench(zim_path="...", chrome_path="...", output_d
render/src/pixelrag_render/bench/bench_throughput.py:387
Class
BiQwen3
Single-vector bi-encoder with last-token pooling + L2 normalization.
train/models/biqwen3.py:40
Class
CDPDCsingleStrategy
render/src/pixelrag_render/strategies/cdp_dc_single.py:49
Class
CDPDirectClipStrategy
Parallel tile capture via directClip. For each viewport-sized chunk of the page: 1. Scroll to chunk position, wait 2 rAF 2. Fire N parall
render/src/pixelrag_render/strategies/cdp_directclip.py:38
Class
CDPDynamicStrategy
Capture tiles dynamically — no upfront height measurement. 1. Navigate, wait for load event only (no fonts.ready) 2. Capture tile at y=0 imme
render/src/pixelrag_render/strategies/cdp_dynamic.py:24
Class
CDPFullpageStrategy
Single full-page screenshot, crop tiles in Python. 1. Set viewport to 1080px, navigate, measure scrollHeight (true height) 2. Inject CSS to l
render/src/pixelrag_render/strategies/cdp_fullpage.py:28
Class
CDPMultiTabStrategy
Multi-tab igpu: fewer processes, more tabs per process.
render/src/pixelrag_render/strategies/cdp_multitab.py:57
Class
CDPNoScrollStrategy
Capture tiles using clip.y offset without scrolling. Sets viewport once, then captures each tile region via clip parameter with captureBeyond
render/src/pixelrag_render/strategies/cdp_noscroll.py:23
Class
CDPOneShotStrategy
One-shot: fresh headless_shell process per article. n_workers controls how many articles are captured concurrently (each in its own short-liv
render/src/pixelrag_render/strategies/cdp_oneshot.py:132
Class
CDPOverlapStrategy
2-tab overlapping nav+capture with semaphore-limited captures.
render/src/pixelrag_render/strategies/cdp_overlap.py:129
Class
CDPParallelStrategy
Fire all tile screenshots simultaneously per page. Same setup as CDPSequentialStrategy, but within one page, all tiles are sent at once witho
render/src/pixelrag_render/strategies/cdp_parallel.py:23
Class
CDPPerTileImgWaitStrategy
Fonts-only nav + per-tile viewport image wait. Fast nav (~70ms), images loaded on-demand per tile.
render/src/pixelrag_render/strategies/cdp_pertile_imgwait.py:40
Class
CDPPhasedStrategy
Semaphore-limited concurrent captures. n_workers Chrome processes, but only capture_limit capture simultaneously. The rest are free to naviga
render/src/pixelrag_render/strategies/cdp_phased.py:51
Class
CDPPipelinedDCStrategy
render/src/pixelrag_render/strategies/cdp_pipelined_dc.py:134
Class
CDPPipelinedTabsStrategy
Two-tab ping-pong: overlap nav (I/O) with capture (mem BW). Each Chrome process has 2 pages. While one captures, the other loads.
render/src/pixelrag_render/strategies/cdp_pipelined_tabs.py:50
Class
CaptureStrategy
Interface for capture strategies.
render/src/pixelrag_render/strategies/base.py:58
Interface
ChatMessage
web/app/chat/page.tsx:44
Class
ChromeConnection
Abstract connection to one Chrome process.
render/src/pixelrag_render/strategies/base.py:48
Interface
ComparePanelProps
web/components/ComparePanel.tsx:9
Interface
Endpoint
web/app/docs/page.tsx:16
Interface
Field
web/app/docs/page.tsx:8
Interface
Hit
web/lib/types.ts:15
Class
KiwixSource
Data source backed by a local Kiwix ZIM file served via kiwix-serve. Both article HTML and embedded images are served from the ZIM archive, e
index/src/pixelrag_index/sources/kiwix.py:263
Interface
LightboxProps
web/components/Lightbox.tsx:10
Class
LocalSource
index/src/pixelrag_index/sources/local.py:18
Interface
ModeToggleProps
web/components/ModeToggle.tsx:8
Class
PDFSource
index/src/pixelrag_index/sources/pdf.py:9
Interface
PlaygroundProps
web/components/ApiPlayground.tsx:7
Class
Query
serve/src/pixelrag_serve/api.py:75
Interface
Query
web/lib/types.ts:1
Interface
QueryResult
web/lib/types.ts:27
Class
ReconstructRequest
serve/src/pixelrag_serve/api.py:409
Interface
ResultGroupProps
web/components/ResultGroup.tsx:8
Interface
SearchBarProps
web/components/SearchBar.tsx:17
Interface
SearchControlsProps
web/components/SearchControls.tsx:19
Interface
SearchHit
web/app/api/chat/route.ts:7
Interface
SearchOptions
web/components/SearchControls.tsx:12
Class
SearchRequest
serve/src/pixelrag_serve/api.py:81
Interface
SearchRequest
web/lib/types.ts:7
Interface
SearchResponse
web/lib/types.ts:31
Interface
SearchResult
web/app/chat/page.tsx:26
next →
1–100 of 108, ranked by callers