Skip to content

Commit

Permalink
Update docs (#199)
Browse files Browse the repository at this point in the history
  • Loading branch information
adrianeboyd committed Jul 31, 2023
1 parent 393e79f commit e24a085
Show file tree
Hide file tree
Showing 16 changed files with 78 additions and 76 deletions.
4 changes: 2 additions & 2 deletions benchmarks/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<a href="https://explosion.ai"><img src="https://explosion.ai/assets/img/logo.svg" width="125" height="125" align="right" /></a>

# 🪐 Project Templates: Benchmarks (8)
# 🪐 Project Templates: Benchmarks (10)

| Template | Description |
| --- | --- |
Expand All @@ -9,7 +9,7 @@
| [`ner_conll03`](ner_conll03) | Named Entity Recognition (CoNLL-2003) |
| [`ner_embeddings`](ner_embeddings) | Comparing embedding layers in spaCy |
| [`parsing_penn_treebank`](parsing_penn_treebank) | Dependency Parsing (Penn Treebank) |
| [`pretraining_morphologizer_oscar`](pretraining_morphologizer_oscar) | Pretraining Morphologizer |
| [`pretraining_morphologizer_oscar`](pretraining_morphologizer_oscar) | Enhancing Morphological Analysis with spaCy Pretraining |
| [`span-labeling-datasets`](span-labeling-datasets) | Span labeling datasets |
| [`speed`](speed) | Project for speed benchmarking of various pretrained models of different NLP libraries. |
| [`textcat_architectures`](textcat_architectures) | Textcat performance benchmarks |
Expand Down
3 changes: 1 addition & 2 deletions benchmarks/ner_conll03/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ Commands are only re-run if their inputs have changed.

| Command | Description |
| --- | --- |
| `install` | Install dependencies |
| `corpus` | Convert the data to spaCy's format |
| `vectors` | Convert, truncate and prune the vectors. |
| `train` | Train the full pipeline |
Expand All @@ -32,7 +31,7 @@ inputs have changed.

| Workflow | Steps |
| --- | --- |
| `all` | `install` &rarr; `vectors` &rarr; `corpus` &rarr; `train` &rarr; `evaluate` |
| `all` | `vectors` &rarr; `corpus` &rarr; `train` &rarr; `evaluate` |

### 🗂 Assets

Expand Down
3 changes: 1 addition & 2 deletions benchmarks/parsing_penn_treebank/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ Commands are only re-run if their inputs have changed.

| Command | Description |
| --- | --- |
| `install` | Install dependencies |
| `corpus` | Convert the data to spaCy's format |
| `vectors` | Convert, truncate and prune the vectors. |
| `train` | Train the full pipeline |
Expand All @@ -32,7 +31,7 @@ inputs have changed.

| Workflow | Steps |
| --- | --- |
| `all` | `install` &rarr; `vectors` &rarr; `corpus` &rarr; `train` &rarr; `evaluate` |
| `all` | `vectors` &rarr; `corpus` &rarr; `train` &rarr; `evaluate` |

### 🗂 Assets

Expand Down
3 changes: 1 addition & 2 deletions benchmarks/speed/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ Commands are only re-run if their inputs have changed.

| Command | Description |
| --- | --- |
| `install` | Install dependencies |
| `download` | Download models |
| `timing_cpu` | Run all timing benchmarks on CPU and add the numbers to output/results.csv |
| `timing_gpu` | Run all timing benchmarks on GPU and add the numbers to output/results.csv |
Expand All @@ -33,7 +32,7 @@ inputs have changed.

| Workflow | Steps |
| --- | --- |
| `setup` | `install` &rarr; `download` |
| `setup` | `download` |
| `benchmark` | `timing_cpu` &rarr; `timing_gpu` |

### 🗂 Assets
Expand Down
1 change: 0 additions & 1 deletion benchmarks/textcat_architectures/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ Commands are only re-run if their inputs have changed.

| Command | Description |
| --- | --- |
| `install` | Install dependencies. |
| `data` | Extract the datasets from their archives. |
| `train` | Run customized training runs: 3 textcat architectures trained on 2 datasets. |
| `summarize` | Summarize the results from the runs and print the best & last scores for each run. |
Expand Down
8 changes: 4 additions & 4 deletions experimental/ner_spancat_compare/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Commands are only re-run if their inputs have changed.

| Command | Description |
| --- | --- |
| `install` | Install dependencies |
| `download` | Download model-related assets |
| `convert` | Convert IOB file into the spaCy format |
| `create-ner` | Split corpus into separate NER datasets for each GENIA label |
| `train-ner` | Train an NER model for each label |
Expand All @@ -39,9 +39,9 @@ inputs have changed.

| Workflow | Steps |
| --- | --- |
| `all` | `install` &rarr; `convert` &rarr; `create-ner` &rarr; `train-ner` &rarr; `assemble-ner` &rarr; `train-spancat` &rarr; `evaluate-ner` &rarr; `evaluate-spancat` |
| `spancat` | `install` &rarr; `convert` &rarr; `train-spancat` &rarr; `evaluate-spancat` |
| `ner` | `install` &rarr; `convert` &rarr; `create-ner` &rarr; `train-ner` &rarr; `evaluate-ner` &rarr; `assemble-ner` |
| `all` | `download` &rarr; `convert` &rarr; `create-ner` &rarr; `train-ner` &rarr; `assemble-ner` &rarr; `train-spancat` &rarr; `evaluate-ner` &rarr; `evaluate-spancat` |
| `spancat` | `download` &rarr; `convert` &rarr; `train-spancat` &rarr; `evaluate-spancat` |
| `ner` | `download` &rarr; `convert` &rarr; `create-ner` &rarr; `train-ner` &rarr; `evaluate-ner` &rarr; `assemble-ner` |

### 🗂 Assets

Expand Down
12 changes: 6 additions & 6 deletions integrations/fastapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# 🪐 spaCy Project: FastAPI integration

Use [FastAPI](https://fastapi.tiangolo.com/) to serve your spaCy models and host modern REST APIs. To install the dependencies and start the server, you can run `spacy project run start`. To explore the REST API interactively, navigate to `http://127.0.0.1:5000/docs` in your browser. See the examples for how to query the API using Python or JavaScript.
Use [FastAPI](https://fastapi.tiangolo.com/) to serve your spaCy models and host modern REST APIs. To start the server, you can run `spacy project run start`. To explore the REST API interactively, navigate to `http://127.0.0.1:5000/docs` in your browser. See the examples for how to query the API using Python or JavaScript.

## 📋 project.yml

Expand All @@ -16,10 +16,10 @@ The following commands are defined by the project. They
can be executed using [`spacy project run [name]`](https://spacy.io/api/cli#project-run).
Commands are only re-run if their inputs have changed.

| Command | Description |
|------------|-----------------------------------------------------------------------|
| `download` | Download models |
| `serve` | Serve the models via a FastAPI REST API using the given host and port |
| Command | Description |
| --- | --- |
| `download` | Download models |
| `serve` | Serve the models via a FastAPI REST API using the given host and port |

### ⏭ Workflows

Expand All @@ -30,7 +30,7 @@ inputs have changed.

| Workflow | Steps |
| --- | --- |
| `start` | `install` &rarr; `serve` |
| `start` | `download` &rarr; `serve` |

### 🗂 Assets

Expand Down
16 changes: 8 additions & 8 deletions integrations/huggingface_hub/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ The following commands are defined by the project. They
can be executed using [`spacy project run [name]`](https://spacy.io/api/cli#project-run).
Commands are only re-run if their inputs have changed.

| Command | Description |
|---------------|--------------------------------------------------|
| `login` | Log in to Hugging Face and download a model |
| `preprocess` | Convert the data to spaCy's binary format |
| `train` | Train a named entity recognition model |
| `evaluate` | Evaluate the model and export metrics |
| `package` | Package the trained model so it can be installed |
| `push_to_hub` | Push the model to the Hub |
| Command | Description |
| --- | --- |
| `login` | Log in to Hugging Face and download a model |
| `preprocess` | Convert the data to spaCy's binary format |
| `train` | Train a named entity recognition model |
| `evaluate` | Evaluate the model and export metrics |
| `package` | Package the trained model so it can be installed |
| `push_to_hub` | Push the model to the Hub |

### ⏭ Workflows

Expand Down
1 change: 0 additions & 1 deletion integrations/ray/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ Commands are only re-run if their inputs have changed.

| Command | Description |
| --- | --- |
| `install` | Install dependencies |
| `convert` | Convert the data to spaCy's format |
| `train` | Train UD_English-EWT |

Expand Down
2 changes: 1 addition & 1 deletion integrations/streamlit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Commands are only re-run if their inputs have changed.

| Command | Description |
| --- | --- |
| `install` | Install dependencies and download models |
| `download` | Download models |
| `visualize` | Visualize a pipeline interactively using Streamlit |

<!-- SPACY PROJECT: AUTO-GENERATED DOCS END (do not remove) -->
Expand Down
12 changes: 6 additions & 6 deletions integrations/wandb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ The following commands are defined by the project. They
can be executed using [`spacy project run [name]`](https://spacy.io/api/cli#project-run).
Commands are only re-run if their inputs have changed.

| Command | Description |
|----------------|-----------------------------------------------------------------------------------------------------------------------------|
| `login` | Log in to Weights & Biases |
| `data` | Extract the gold-standard annotations |
| `train` | Train a model using the default config |
| Command | Description |
| --- | --- |
| `login` | Log in to Weights & Biases |
| `data` | Extract the gold-standard annotations |
| `train` | Train a model using the default config |
| `train-search` | Run customized training runs for hyperparameter search using [Weights & Biases Sweeps](https://docs.wandb.ai/guides/sweeps) |
| `clean` | Remove intermediate files. |
| `clean` | Remove intermediate files. |

### ⏭ Workflows

Expand Down
Loading

0 comments on commit e24a085

Please sign in to comment.