Skip to content

Version 0.5.0

Pre-release
Pre-release
Compare
Choose a tag to compare
@thomashacker thomashacker released this 06 Mar 12:33
· 12 commits to main since this release
v0.5.0
9c66e79
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

Version 0.5.0 Pre-release of the VScode spaCy extension.

The extension provides additional tooling and features for working with spaCy's config files. It includes hover descriptions for registry functions, variables, and section names within the config as an installable extension.

🚀 Quickstart

  • Step 1. Download the .vsix file from the release

  • Step 2. Install a supported version of Python on your system (>=3.7)

  • Step 3. Install the Python Extension for Visual Studio Code

  • Step 4. Create a virtual python environment

  • Step 5. Install all python requirements

    • spaCy >= 3.4.0
    • pygls >= 1.0.0

  • Step 6. Install spaCy Extension for Visual Studio Code (right-click on the .vsix file inside VScode and click on install extension)

  • Step 7. Reload your VScode client

  • Step 8. Select your python environment by clicking on the spaCy status bar on the bottom.

  • Step 9. You are ready to work with .cfg files in spaCy!

🔥 Features

The extension displays additional information on hover for some components and validates the config file on open.

Hover

The hover feature provides three different types of information.

  1. The function registry
    Functions within the config file are registered within spaCy's registry system. When one of these functions is hovered over, the feature will provide information about the function and its arguments, along with a link to the code for the function, if available.

  2. Resolving references to variables
    Variables are denoted in the config file as ${<variable-name>}. When a variable is hovered over, the feature will provide the value of that variable specified in the config file.

  3. Section titles
    The config system is separated by sections such as [training.batcher] or [components]. When a section, such as "training" or "components", or subsection, such as "batcher", is hovered over, the feature will provide a description of it, if available.

Assets 3
Loading