# 🪐 Weasel Project: Demo spancat in a new pipeline (Span Categorization) A minimal demo spancat project for spaCy v3 ## 📋 project.yml The [`project.yml`](project.yml) defines the data assets required by the project, as well as the available commands and workflows. For details, see the [Weasel documentation](https://github.com/explosion/weasel). ### ⏯ Commands The following commands are defined by the project. They can be executed using [`weasel run [name]`](https://github.com/explosion/weasel/tree/main/docs/cli.md#rocket-run). Commands are only re-run if their inputs have changed. | Command | Description | | --- | --- | | `download` | Download a spaCy model with pretrained vectors | | `convert` | Convert the data to spaCy's binary format | | `create-config` | Create a new config with a spancat pipeline component | | `train` | Train the spancat model | | `train-with-vectors` | Train the spancat model with vectors | | `evaluate` | Evaluate the model and export metrics | | `package` | Package the trained model as a pip package | | `clean` | Remove intermediary directories | ### ⏭ Workflows The following workflows are defined by the project. They can be executed using [`weasel run [name]`](https://github.com/explosion/weasel/tree/main/docs/cli.md#rocket-run) and will run the specified commands in order. Commands are only re-run if their inputs have changed. | Workflow | Steps | | --- | --- | | `all` | `convert` → `create-config` → `train` → `evaluate` | | `all-vectors` | `download` → `convert` → `create-config` → `train-with-vectors` → `evaluate` | ### 🗂 Assets The following assets are defined by the project. They can be fetched by running [`weasel assets`](https://github.com/explosion/weasel/tree/main/docs/cli.md#open_file_folder-assets) in the project directory. | File | Source | Description | | --- | --- | --- | | [`assets/train.json`](assets/train.json) | Local | Demo training data adapted from the `ner_demo` project | | [`assets/dev.json`](assets/dev.json) | Local | Demo development data |