Minor adjustments to NER and textcat demos (explosion#47)

* Use lang var in package name * Update titles and descriptions in ner/textcat demos
rojaAchary · Mar 11, 2021 · fe64acf · fe64acf
1 parent 8c06175
commit fe64acf
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 14 deletions.
diff --git a/pipelines/README.md b/pipelines/README.md
@@ -4,10 +4,10 @@
 
 | Template | Description |
 | --- | --- |
-| [`ner_demo`](ner_demo) | Demo NER (Named Entity Recognition) |
-| [`ner_demo_replace`](ner_demo_replace) | Demo NER Replace |
-| [`ner_demo_update`](ner_demo_update) | Demo NER Update |
+| [`ner_demo`](ner_demo) | Demo NER in a new pipeline (Named Entity Recognition) |
+| [`ner_demo_replace`](ner_demo_replace) | Demo replacing an NER component in a pretrained pipeline |
+| [`ner_demo_update`](ner_demo_update) | Demo updating an NER component in a pretrained pipeline |
 | [`ner_wikiner`](ner_wikiner) | Named Entity Recognition (WikiNER) |
 | [`tagger_parser_ud`](tagger_parser_ud) | Part-of-speech Tagging & Dependency Parsing (Universal Dependencies) |
 | [`textcat_demo`](textcat_demo) | Demo Textcat (Text Classification) |
-| [`textcat_multilabel_demo`](textcat_multilabel_demo) | Demo Textcat (Text Classification) |
+| [`textcat_multilabel_demo`](textcat_multilabel_demo) | Demo Multilabel Textcat (Text Classification) |
diff --git a/pipelines/ner_demo/project.yml b/pipelines/ner_demo/project.yml
@@ -1,5 +1,5 @@
-title: "Demo NER (Named Entity Recognition)"
-description: "A minimal demo NER project for spaCy v3 adapted from the spaCy v2 [`train_ner.py`](https://github.com/explosion/spaCy/blob/v2.3.x/examples/training/train_ner.py) example script."
+title: "Demo NER in a new pipeline (Named Entity Recognition)"
+description: "A minimal demo NER project for spaCy v3 adapted from the spaCy v2 [`train_ner.py`](https://github.com/explosion/spaCy/blob/v2.3.x/examples/training/train_ner.py) example script for creating an NER component in a new pipeline."
 # Variables can be referenced across the project.yml using ${vars.var_name}
 vars:
   name: "ner_demo"
@@ -84,7 +84,7 @@ commands:
     deps:
       - "training/model-best"
     outputs_no_cache:
-      - "packages/en_${vars.name}-${vars.version}/dist/en_${vars.name}-${vars.version}.tar.gz"
+      - "packages/${vars.lang}_${vars.name}-${vars.version}/dist/${vars.lang}_${vars.name}-${vars.version}.tar.gz"
 
   - name: visualize-model
     help: Visualize the model's output interactively using Streamlit

diff --git a/pipelines/ner_demo_replace/project.yml b/pipelines/ner_demo_replace/project.yml
@@ -1,4 +1,4 @@
-title: "Demo NER Replace"
+title: "Demo replacing an NER component in a pretrained pipeline"
 description: "A minimal demo NER project that replaces the NER component in an existing pretrained pipeline. All other pipeline components are preserved and frozen during training."
 spacy_version: ">=3.0.5,<4.0.0"
 # Variables can be referenced across the project.yml using ${vars.var_name}
@@ -94,7 +94,7 @@ commands:
     deps:
       - "training/model-best"
     outputs_no_cache:
-      - "packages/en_${vars.name}-${vars.version}/dist/en_${vars.name}-${vars.version}.tar.gz"
+      - "packages/${vars.lang}_${vars.name}-${vars.version}/dist/${vars.lang}_${vars.name}-${vars.version}.tar.gz"
 
   - name: visualize-model
     help: Visualize the model's output interactively using Streamlit

diff --git a/pipelines/ner_demo_update/project.yml b/pipelines/ner_demo_update/project.yml
@@ -1,4 +1,4 @@
-title: "Demo NER Update"
+title: "Demo updating an NER component in a pretrained pipeline"
 description: "A demo NER project that updates the NER component in an existing pretrained pipeline. All other pipeline components are preserved and frozen during training."
 spacy_version: ">=3.0.5,<4.0.0"
 # Variables can be referenced across the project.yml using ${vars.var_name}
@@ -94,7 +94,7 @@ commands:
     deps:
       - "training/model-best"
     outputs_no_cache:
-      - "packages/en_${vars.name}-${vars.version}/dist/en_${vars.name}-${vars.version}.tar.gz"
+      - "packages/${vars.lang}_${vars.name}-${vars.version}/dist/${vars.lang}_${vars.name}-${vars.version}.tar.gz"
 
   - name: visualize-model
     help: Visualize the model's output interactively using Streamlit

diff --git a/pipelines/textcat_demo/project.yml b/pipelines/textcat_demo/project.yml
@@ -81,7 +81,7 @@ commands:
     deps:
       - "training/model-best"
     outputs_no_cache:
-      - "packages/en_${vars.name}-${vars.version}/dist/en_${vars.name}-${vars.version}.tar.gz"
+      - "packages/${vars.lang}_${vars.name}-${vars.version}/dist/${vars.lang}_${vars.name}-${vars.version}.tar.gz"
 
   - name: visualize-model
     help: Visualize the model's output interactively using Streamlit

diff --git a/pipelines/textcat_multilabel_demo/project.yml b/pipelines/textcat_multilabel_demo/project.yml
@@ -1,4 +1,4 @@
-title: "Demo Textcat (Text Classification)"
+title: "Demo Multilabel Textcat (Text Classification)"
 description: "A minimal demo textcat_multilabel project for spaCy v3."
 # Variables can be referenced across the project.yml using ${vars.var_name}
 vars:
@@ -81,7 +81,7 @@ commands:
     deps:
       - "training/model-best"
     outputs_no_cache:
-      - "packages/en_${vars.name}-${vars.version}/dist/en_${vars.name}-${vars.version}.tar.gz"
+      - "packages/${vars.lang}_${vars.name}-${vars.version}/dist/${vars.lang}_${vars.name}-${vars.version}.tar.gz"
 
   - name: visualize-model
     help: Visualize the model's output interactively using Streamlit