Skip to content

Refresh docs for the base-model migration#512

Merged
FuJacob merged 1 commit into
mainfrom
chore/docs-refresh
Jun 1, 2026
Merged

Refresh docs for the base-model migration#512
FuJacob merged 1 commit into
mainfrom
chore/docs-refresh

Conversation

@FuJacob

@FuJacob FuJacob commented Jun 1, 2026

Copy link
Copy Markdown
Owner

Summary

Markdown docs drifted after the open-source completion path moved from instruction-tuned to base models (+ a default-off constrained decoder) and the visual-context summarizer was removed. This brings them back in line with main. Each change was verified against the current code by a per-file audit.

  • README.md — model table now lists the tabby-2-* base GGUFs (Qwen3.5 0.8B/2B/4B + Gemma E2B/E4B) with real sizes and mradermacher sources; the Open Source engine is reframed as base-model continuation (conditioned, not instructed).
  • ARCHITECTURE.md / AGENTS.md / .claude/CLAUDE.md — drop the deleted LlamaVisualContextSummarizer and instruct LlamaPromptRenderer; describe the OCRTextHygiene cleanup (no summarization step), BaseCompletionPromptRenderer, and the default-off constrained decoder; point the llama integration at the CotabbyInference SwiftPM package instead of a nonexistent LlamaRuntime/ dir / llama.swift.
  • docs/POLLING_AND_DELAYS.md — remove the deleted summarizer timeout row.

CONTRIBUTING.md, RELEASING.md, the issue/PR templates, CODE_OF_CONDUCT.md, and the ship skill were audited and needed no changes.

Validation

Docs-only change (no build). Audited by per-file subagents that cross-checked every factual claim against the current code; a repo-wide sweep confirms no residual references to the deleted LlamaVisualContextSummarizer, LlamaPromptRenderer, VisualContextSummaryPromptRenderer, llama.swift, or the old tabby-1-* / instruct model names.

Linked issues

None.

Risk / rollout notes

  • Documentation only; no code or behavior change.
  • The project wiki (separate repo, no PR mechanism) was refreshed in the same pass and pushed directly: How-Cotabby-Works, Debugging-Guide, How-To-Add-a-Feature, Privacy-and-Safety-Model.

Greptile Summary

This is a documentation-only PR that refreshes five markdown files to align with code that has already shipped: the OSS path migrated from instruction-tuned to base GGUFs, LlamaVisualContextSummarizer was removed, and LlamaPromptRenderer was replaced by BaseCompletionPromptRenderer.

  • README.md: Model table updated from four tabby-1-* instruct entries to five tabby-2-* base-model entries (filenames, sizes, and mradermacher HuggingFace links); all values confirmed exact matches against LlamaRuntimeModels.swift.
  • AGENTS.md / ARCHITECTURE.md / .claude/CLAUDE.md: Remove LlamaVisualContextSummarizer, describe OCRTextHygiene as the cleanup step, document BaseCompletionPromptRenderer and the default-off cotabbyConstrainedDecoderEnabled/runConstrainedDecode path; point the llama integration at the CotabbyInference SwiftPM package.
  • docs/POLLING_AND_DELAYS.md: Drops the now-deleted LlamaVisualContextSummarizer 3 s timeout row.

Confidence Score: 5/5

Documentation-only change; no code or runtime behavior is modified.

Every factual claim in the updated docs was cross-checked against the live source: model filenames, sizes, and HuggingFace URLs match LlamaRuntimeModels.swift exactly; OCRTextHygiene, BaseCompletionPromptRenderer, runConstrainedDecode, and cotabbyConstrainedDecoderEnabled all exist in the codebase; LlamaVisualContextSummarizer and LlamaPromptRenderer are confirmed absent; the CotabbyInference SwiftPM package reference matches the Xcode project. No stale claims remain.

No files require special attention.

Important Files Changed

Filename Overview
README.md Model table replaced with five tabby-2-* base GGUFs; all filenames, sizes, and mradermacher sources verified against LlamaRuntimeModels.swift. Default model claim (tabby-2-base) confirmed by LlamaRuntimeConfiguration.default.
AGENTS.md Removes LlamaVisualContextSummarizer and LlamaRuntime/ directory references; adds OCRTextHygiene, BaseCompletionPromptRenderer, and constrained-decoder details — all verified present in source.
ARCHITECTURE.md Removes stale 'legacy / deprecated' label from VisualContextCoordinator (no @available deprecated annotation exists in source) and adds OCRTextHygiene description. Clean and accurate.
.claude/CLAUDE.md Drops LlamaVisualContextSummarizer from the visual-context list; adds OSS/instruct renderer split note. Both changes reflect current code accurately.
docs/POLLING_AND_DELAYS.md Removes the LlamaVisualContextSummarizer 3 s timeout row; the remaining VisualContextCoordinator:29 entry was verified still present in source. No other timing rows affected.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    subgraph Visual Context
        VC[VisualContextCoordinator] --> SCG[ScreenshotContextGenerator]
        SCG --> WSS[WindowScreenshotService]
        SCG --> STE[ScreenTextExtractor\nVision OCR]
        STE --> OCR[OCRTextHygiene\npure cleanup]
        OCR --> EXCERPT[Bounded Excerpt]
    end

    subgraph Runtime Generation
        SER[SuggestionEngineRouter] -->|Open Source| LSE[LlamaSuggestionEngine]
        SER -->|Apple Intelligence| FMSE[FoundationModelSuggestionEngine]
        LSE --> LRM[LlamaRuntimeManager]
        LRM --> LRC[LlamaRuntimeCore\nserialised actor]
        LRC -->|default| NORM[Normal Decode]
        LRC -->|cotabbyConstrainedDecoderEnabled default-off| CD[runConstrainedDecode]
    end

    subgraph Prompt Rendering
        LSE --> BCPR[BaseCompletionPromptRenderer\nbase-model continuation]
        FMSE --> FMPR[FoundationModelPromptRenderer\ninstruct-shaped]
    end

    subgraph Models tabby-2
        M1[tabby-2-mini Qwen3.5-0.8B ~0.8 GB]
        M2[tabby-2-base default Qwen3.5-2B ~1.4 GB]
        M3[tabby-2-pro Qwen3.5-4B ~2.6 GB]
        M4[tabby-2-gemma-mini gemma-4-E2B ~4.5 GB]
        M5[tabby-2-gemma-pro gemma-4-E4B ~5.0 GB]
    end

    LRC --> M1
    LRC --> M2
    LRC --> M3
    LRC --> M4
    LRC --> M5
Loading

Reviews (1): Last reviewed commit: "Refresh docs for the base-model migratio..." | Re-trigger Greptile

Update markdown docs that drifted after the open-source completion path moved
from instruction-tuned to base models + constrained decoding, and the
visual-context summarizer was removed.

- README: model table now lists the tabby-2-* base GGUFs (Qwen3.5 + Gemma) with
  real sizes and sources; reframe the Open Source engine as base-model
  continuation (conditioned, not instructed).
- ARCHITECTURE / AGENTS / CLAUDE: drop the deleted LlamaVisualContextSummarizer
  and the instruct LlamaPromptRenderer; describe the OCRTextHygiene cleanup (no
  model-summarization step), BaseCompletionPromptRenderer, and the default-off
  constrained decoder; point the llama integration at the CotabbyInference
  SwiftPM package instead of a nonexistent LlamaRuntime/ dir.
- POLLING_AND_DELAYS: remove the deleted summarizer timeout row.

Each change verified against current code; CONTRIBUTING and the low-risk
docs were checked and needed no changes.
@FuJacob FuJacob merged commit 2ee5141 into main Jun 1, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant