Skip to content

Augmented View 0.6.2

Choose a tag to compare

View all tags
@Gameboard-dev Gameboard-dev released this 28 Oct 23:38
· 13 commits to main since this release
0.6.2
9c59021

Augmented View 0.6.2

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.1

  • The server can download its models when you start it yourself. Started by hand in a terminal with models missing, the server lists them (size, page, licence, folder and the total) and asks Download them now? [y/N]. "y" downloads them, checked and resumable as with --download all, and then starts the server; any other answer downloads nothing and prints the command to run later. --no-prompt turns the question off. When the plugin starts the server nothing changes: it never asks and never downloads. See The terminal question.
  • Better sentence boundaries for sentence colours. A full stop after a citation or a link now ends the sentence; abbreviations such as "et al." and pieces cut at a colon or a line break are joined to the sentence they belong to; a sentence that opens with bold or italic starts at its markers. Block ids and LaTeX spacing are no longer passed to the model.
  • "None of these". The sentence model is told to choose "None of these" when no colour fits well, so fewer sentences get a colour that does not suit them. A colour you hide in the key can serve as a place for such sentences.
  • Settings contents. The settings tab has a Contents column at the side listing every section, which stays in view as you scroll.
  • Documentation moved from one long README into docs/: installation, usage, colour codes and rules, settings, the server, models, GPU and memory, performance, privacy and security, troubleshooting, building and licences, with a Disclosures page that goes through Obsidian's developer policies point by point.
  • When a model download is refused for lack of a Hugging Face token, the message now names the HF_TOKEN environment variable. None of the default models needs a token.

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/ (Building from source); written for but not yet tested.
  • Disk: the models are downloaded once (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, in either of two ways:
    • run the server yourself in a terminal and answer "y" to its question, or
    • copy the download command from Settings → Augmented View → Models and run it in a terminal, for example & "<vault>\.obsidian\plugins\augmented-view\augmented-view-server.exe" --download all, then press Check again.
  5. Open a note, choose a colour code in the floating key, and read.

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 or answer yes in its terminal. Details: Disclosures.

Assets 11
Loading