sparv-bert-neighbour-plugin 0.2.1

A sparv plugin for computing word neighbours using a BERT model.

sparv-bert-neighbour-plugin

Plugin for applying bert masking as a Sparv annotation.

Install

First, install Sparv, as suggested:

pipx install sparv-pipeline

Then install install sparv-bert-neighbour-plugin with

pipx inject sparv-pipeline sparv-bert-neighbour-plugin

Usage

To use this annotation you need to specify that you want to use it:

xml_export:
    annotations:
        - <token>:sparv_bert_neighbour.transformer-neighbour

Configuration

You can configure this plugin by choosing a huggingface model, huggingface transformer and the number of neighbours to generate.

Model

The model defaults to KBLab/bert-base-swedish-cased but can be configured in config.yaml:

sparv_bert_neighbour:
    model: "KBLab/bert-base-swedish-cased"

Tokenizer

The tokenizer defaults to KBLab/bert-base-swedish-cased but can be configured in config.yaml:

sparv_bert_neighbour:
    tokenizer: "KBLab/bert-base-swedish-cased"

Number of Neighbours

The number of neighbousr defaults to 5 but can be configured in config.yaml:

sparv_bert_neighbour:
    num_neighbours: 5