Skip to main content

Tool for word sense disambiguation (WSD) based on SALDO, ported to Rust.

Project description

saldowsd-rs

PyPI version PyPI - Python Version

Maturity badge - level 3 Stage

Code Coverage

CI(check) CI(release) CI(scheduled) CI(test)

A rewrite of the Java app saldowsd.jar in sparv-wsd in Rust.

Usage

Build from source

To build saldowsd from source:

cargo build --release

After the build succeeds, you can find the binary in ./target/release/saldowsd.

Command-line interface

The supported interface as of today:

> ./target/release/saldowsd --help
Usage: saldowsd [OPTIONS] --format <FORMAT> <COMMAND>

Commands:
  vector-wsd
  help        Print this message or the help of the given subcommand(s)

Options:
      --format <FORMAT>          Format of the output [possible values: sbxml, tab, eval]
      --batch-size <BATCH_SIZE>  The size of each batch [default: 1]
      --max-sen <MAX_SEN>        The maximum sense [default: 4294967295]
  -v, --verbose...               Verbosity
  -h, --help                     Print help
  -V, --version                  Print version

Currently supported command is vector-wsd:

Usage: saldowsd --format <FORMAT> vector-wsd [OPTIONS] --context-width <CONTEXT_WIDTH> --sv-file <SV_FILE> --cv-file <CV_FILE>

Options:
      --decay
      --s1-prior <S1_PRIOR>            [default: 0]
      --context-width <CONTEXT_WIDTH>
      --sv-file <SV_FILE>
      --cv-file <CV_FILE>
  -h, --help                           Print help
  -V, --version                        Print version

Development

You must have Rust and git-lfs installed.

Clone the repository

Clone this repo with recursing submodules.

git clone --recurse-submodules https://github.com/spraakbanken/wsd-rs.git

or, if you are using ssh:

git clone --recurse-submodules git@github.com:spraakbanken/wsd-rs.git

or, if using GitHub cli:

gh repo clone spraakbanken/wsd-rs -- --recurse-submodules

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

saldowsd-0.2.2-py3-none-manylinux_2_34_x86_64.whl (2.3 MB view details)

Uploaded Python 3manylinux: glibc 2.34+ x86-64

File details

Details for the file saldowsd-0.2.2-py3-none-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for saldowsd-0.2.2-py3-none-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 a08fec746efa0af532891fb1522929f96792f1b4f1e9b414a338c8353013dae0
MD5 a27ad8975630b332c8f99dcfa46983f4
BLAKE2b-256 f8f2fbe882b5994c84020a296af0dc6e2deadd290d7d13e6de6882289210b05d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page