Skip to content

Commit 9b13f45

Browse files
Add README for span-suggester project (#14)
The spancat blogpost links it here, it may be nice to add some README so that it's more presentable.
1 parent 2b9bcdd commit 9b13f45

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

projects/span_suggesters/README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<!-- SPACY PROJECT: AUTO-GENERATED DOCS START (do not remove) -->
2+
3+
# 🪐 spaCy Project: Span Suggesters
4+
5+
This project introduces new experimental suggester functions
6+
7+
## 📋 project.yml
8+
9+
The [`project.yml`](project.yml) defines the data assets required by the
10+
project, as well as the available commands and workflows. For details, see the
11+
[spaCy projects documentation](https://spacy.io/usage/projects).
12+
13+
### ⏯ Commands
14+
15+
The following commands are defined by the project. They
16+
can be executed using [`spacy project run [name]`](https://spacy.io/api/cli#project-run).
17+
Commands are only re-run if their inputs have changed.
18+
19+
| Command | Description |
20+
| --- | --- |
21+
| `install` | Install requirements |
22+
| `data` | Format Healthsea annotations into .spaCy training format |
23+
| `train_spancat` | Train a spancat model |
24+
25+
### ⏭ Workflows
26+
27+
The following workflows are defined by the project. They
28+
can be executed using [`spacy project run [name]`](https://spacy.io/api/cli#project-run)
29+
and will run the specified commands in order. Commands are only re-run if their
30+
inputs have changed.
31+
32+
| Workflow | Steps |
33+
| --- | --- |
34+
| `all` | `data` &rarr; `train_spancat` |
35+
36+
### 🗂 Assets
37+
38+
The following assets are defined by the project. They can
39+
be fetched by running [`spacy project assets`](https://spacy.io/api/cli#project-assets)
40+
in the project directory.
41+
42+
| File | Source | Description |
43+
| --- | --- | --- |
44+
| `assets/healthsea_ner.jsonl` | URL | Annotations from the Healthsea dataset |
45+
46+
<!-- SPACY PROJECT: AUTO-GENERATED DOCS END (do not remove) -->

0 commit comments

Comments
 (0)