Skip to content

Augmented View 0.6.1

Choose a tag to compare

View all tags
@Gameboard-dev Gameboard-dev released this 28 Oct 22:27
· 16 commits to main since this release
0.6.1
d496149

Augmented View 0.6.1

Colours each sentence of a note by the role it plays (a claim, a finding, a limitation, a signpost …) and key phrases by kind, for skim reading, with local models on your own computer. The note itself is never changed.

What changed since 0.6.0

  • Rules for each colour (Settings → Augmented View → Rules, or a colour row's list button). Give a colour your own words or a pattern (a regular expression) that forces it on the sentences they match or forbids it there. A Forbid rule wins, then the first colour whose Force rule matches, then the model's choice; a phrase colour's rules mark words or drop the model's phrases. Rules apply at once, also to cached paragraphs, in Live Preview, Source mode and Reading view, and are never sent to the server. Patterns are checked as you type and cannot hang Obsidian (a linear-time engine, length and size limits). Test on a sentence shows what the rules do. See the README's Rules section.
  • The plugin never downloads anything. It no longer offers to download the models: when models are missing, the server says which and stops, and Settings → Augmented View → Models lists each model (purpose, size, licence, page, folder, files) with the download command for you to run in a terminal. The server's --download run pins each model to a published commit and checks every file's size and checksum, and resumes after an interruption.
  • Licence files ship with the server: augmented-view-server-LICENSE.txt and augmented-view-server-THIRD-PARTY-LICENSES.txt (the crates' licences and the native code compiled in).
  • Disclosures and compliance in the README: network use, files outside the vault, no account, payment, ads or telemetry, and how the plugin meets Obsidian's developer policies.
  • The floating key's check boxes show or hide each colour of the note's code.
  • The manifest's minimum Obsidian version follows the APIs used (1.8.7).

Requirements

  • Obsidian 1.8.7 or later, desktop only (the plugin starts the server as a separate program).
  • The prebuilt server: Windows x64, a CPU with AVX2 (x86-64-v3: Intel Haswell or AMD Excavator, 2013 onwards, or later).
    • On the GPU: an NVIDIA GPU of compute capability 8.0 or higher (RTX 30 series or newer) with its driver and CUDA 13's cuBLAS and cuRAND libraries, and about 4 GB of free GPU memory. Without them the server runs on the CPU by itself, more slowly, and says why.
    • On the CPU: about 5 GB of free memory.
  • macOS and Linux: build the server from server/ (README, "Build and deploy"); written for but not yet tested.
  • Disk: the models are downloaded once by the command you run (about 8.5 GB downloaded, about 2.9 GB kept; 0.84 GB more for phrase colours).

Install

  1. Copy main.js, manifest.json and styles.css into <vault>/.obsidian/plugins/augmented-view/ (or install from Obsidian's community plugins once listed), and enable the plugin.
  2. Download the server, augmented-view-server-windows-x64.exe (CUDA; uses the CPU by itself when CUDA is missing), and put it in the same folder as augmented-view-server.exe (or keep its name and set it in Settings → Augmented View → This device → Server). On a computer without an NVIDIA GPU, augmented-view-server-cpu-windows-x64.exe is smaller: save it as augmented-view-server.exe, or as augmented-view-server-cpu.exe beside the CUDA one (the CPU server setting). Check each against its .sha256 file:
    • PowerShell: Get-FileHash .\augmented-view-server-windows-x64.exe -Algorithm SHA256
    • Command Prompt: certutil -hashfile augmented-view-server-windows-x64.exe SHA256
  3. Keep augmented-view-server-LICENSE.txt and augmented-view-server-THIRD-PARTY-LICENSES.txt beside it.
  4. Download the models: start the server from the status bar's "AugView" menu; it lists what is missing, and Settings → Augmented View → Models shows the command to copy and run in a terminal, for example
    & "<vault>\.obsidian\plugins\augmented-view\augmented-view-server.exe" --download all
    Then press Check again, or start the server from the status bar.
  5. Open a note, choose a colour code in the floating key, and read.

What the plugin and the server connect to, and which files they write outside the vault, is set out in the README's Disclosures and compliance section: the plugin talks only to its server on 127.0.0.1, and the server downloads models (from Hugging Face and LINDAT) only when you run its download command.

Assets 11
Loading