mirror of
https://github.com/explosion/spaCy.git
synced 2025-01-13 02:36:32 +03:00
Update docs [ci skip]
This commit is contained in:
parent
5ebb2a2ac8
commit
85e5910102
|
@ -90,7 +90,7 @@ can also use any private repo you have access to with Git.
|
||||||
> git:
|
> git:
|
||||||
> repo: 'https://github.com/example/repo'
|
> repo: 'https://github.com/example/repo'
|
||||||
> branch: 'master'
|
> branch: 'master'
|
||||||
> path: 'path/developments.spacy'
|
> path: 'path/development.spacy'
|
||||||
> checksum: '5113dc04e03f079525edd8df3f4f39e3'
|
> checksum: '5113dc04e03f079525edd8df3f4f39e3'
|
||||||
> ```
|
> ```
|
||||||
|
|
||||||
|
@ -910,9 +910,6 @@ https://github.com/explosion/projects/blob/v3/integrations/fastapi/scripts/main.
|
||||||
|
|
||||||
### Ray {#ray} <IntegrationLogo name="ray" width={100} height="auto" align="right" />
|
### Ray {#ray} <IntegrationLogo name="ray" width={100} height="auto" align="right" />
|
||||||
|
|
||||||
<Infobox title="This section is still under construction" emoji="🚧" variant="warning">
|
|
||||||
</Infobox>
|
|
||||||
|
|
||||||
> #### Installation
|
> #### Installation
|
||||||
>
|
>
|
||||||
> ```cli
|
> ```cli
|
||||||
|
@ -926,21 +923,27 @@ https://github.com/explosion/projects/blob/v3/integrations/fastapi/scripts/main.
|
||||||
training with spaCy via our lightweight
|
training with spaCy via our lightweight
|
||||||
[`spacy-ray`](https://github.com/explosion/spacy-ray) extension package. If the
|
[`spacy-ray`](https://github.com/explosion/spacy-ray) extension package. If the
|
||||||
package is installed in the same environment as spaCy, it will automatically add
|
package is installed in the same environment as spaCy, it will automatically add
|
||||||
[`spacy ray`](/api/cli#ray) commands to your spaCy CLI.
|
[`spacy ray`](/api/cli#ray) commands to your spaCy CLI. See the usage guide on
|
||||||
|
[parallel training](/usage/training#parallel-training) for more details on how
|
||||||
|
it works under the hood.
|
||||||
|
|
||||||
You can integrate [`spacy ray train`](/api/cli#ray-train) into your
|
You can integrate [`spacy ray train`](/api/cli#ray-train) into your
|
||||||
`project.yml` just like the regular training command:
|
`project.yml` just like the regular training command and pass it the config, and
|
||||||
|
optional output directory or remote storage URL and config overrides if needed.
|
||||||
|
|
||||||
<!-- prettier-ignore -->
|
<!-- prettier-ignore -->
|
||||||
```yaml
|
```yaml
|
||||||
### project.yml
|
### project.yml
|
||||||
- name: "ray"
|
commands:
|
||||||
|
- name: "ray"
|
||||||
help: "Train a model via parallel training with Ray"
|
help: "Train a model via parallel training with Ray"
|
||||||
script:
|
script:
|
||||||
- "python -m spacy ray train configs/config.cfg --paths.train corpus/train.spacy --paths.dev corpus/dev.spacy"
|
- "python -m spacy ray train configs/config.cfg -o training/ --paths.train corpus/train.spacy --paths.dev corpus/dev.spacy"
|
||||||
deps:
|
deps:
|
||||||
- "corpus/train.spacy"
|
- "corpus/train.spacy"
|
||||||
- "corpus/dev.spacy"
|
- "corpus/dev.spacy"
|
||||||
|
outputs:
|
||||||
|
- "training/model-best"
|
||||||
```
|
```
|
||||||
|
|
||||||
<!-- TODO: <Project id="integrations/ray">
|
<!-- TODO: <Project id="integrations/ray">
|
||||||
|
|
|
@ -92,6 +92,26 @@ spaCy's binary `.spacy` format. You can either include the data paths in the
|
||||||
$ python -m spacy train config.cfg --output ./output --paths.train ./train.spacy --paths.dev ./dev.spacy
|
$ python -m spacy train config.cfg --output ./output --paths.train ./train.spacy --paths.dev ./dev.spacy
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<Accordion title="How are the config recommendations generated?" id="quickstart-source">
|
||||||
|
|
||||||
|
The recommended config settings generated by the quickstart widget and the
|
||||||
|
[`init config`](/api/cli#init-config) command are based on some general **best
|
||||||
|
practices** and things we've found to work well in our experiments. The goal is
|
||||||
|
to provide you with the most **useful defaults**.
|
||||||
|
|
||||||
|
Under the hood, the
|
||||||
|
[`quickstart_training.jinja`](%%GITHUB_SPACY/spacy/cli/templates/quickstart_training.jinja)
|
||||||
|
template defines the different combinations – for example, which parameters to
|
||||||
|
change if the pipeline should optimize for efficiency vs. accuracy. The file
|
||||||
|
[`quickstart_training_recommendations.yml`](%%GITHUB_SPACY/spacy/cli/templates/quickstart_training_recommendations.yml)
|
||||||
|
collects the recommended settings and available resources for each language
|
||||||
|
including the different transformer weights. For some languages, we include
|
||||||
|
different transformer recommendations, depending on whether you want the model
|
||||||
|
to be more efficient or more accurate. The recommendations will be **evolving**
|
||||||
|
as we run more experiments.
|
||||||
|
|
||||||
|
</Accordion>
|
||||||
|
|
||||||
## Training config {#config}
|
## Training config {#config}
|
||||||
|
|
||||||
Training config files include all **settings and hyperparameters** for training
|
Training config files include all **settings and hyperparameters** for training
|
||||||
|
|
|
@ -8,9 +8,9 @@ import socialImageApi from '../images/social_api.jpg'
|
||||||
import socialImageUniverse from '../images/social_universe.jpg'
|
import socialImageUniverse from '../images/social_universe.jpg'
|
||||||
import socialImageNightly from '../images/social_nightly.jpg'
|
import socialImageNightly from '../images/social_nightly.jpg'
|
||||||
|
|
||||||
function getPageTitle(title, sitename, slogan, sectionTitle) {
|
function getPageTitle(title, sitename, slogan, sectionTitle, nightly) {
|
||||||
if (sectionTitle && title) {
|
if (sectionTitle && title) {
|
||||||
return `${title} · ${sitename} ${sectionTitle}`
|
return `${title} · ${sitename} ${sectionTitle}${nightly ? ' (nightly)' : ''}`
|
||||||
}
|
}
|
||||||
if (title) {
|
if (title) {
|
||||||
return `${title} · ${sitename}`
|
return `${title} · ${sitename}`
|
||||||
|
@ -44,7 +44,8 @@ export default function SEO({
|
||||||
title,
|
title,
|
||||||
siteMetadata.title,
|
siteMetadata.title,
|
||||||
siteMetadata.slogan,
|
siteMetadata.slogan,
|
||||||
sectionTitle
|
sectionTitle,
|
||||||
|
nightly
|
||||||
)
|
)
|
||||||
const socialImage = siteMetadata.siteUrl + getImage(section, nightly)
|
const socialImage = siteMetadata.siteUrl + getImage(section, nightly)
|
||||||
const meta = [
|
const meta = [
|
||||||
|
|
Loading…
Reference in New Issue
Block a user