Clarify how --code arg works

This adds a few sentences to the docs to clarify how the `--code`
argument works, including an explanation of how to load custom
components in your own code.
This commit is contained in:
Paul O'Leary McCann 2023-01-13 18:38:16 +09:00
parent 9ef7d26032
commit 2c57c3fa69

View File

@ -684,10 +684,14 @@ If your pipeline includes
[custom components](/usage/processing-pipelines#custom-components), model [custom components](/usage/processing-pipelines#custom-components), model
architectures or other [code](/usage/training#custom-code), those functions need architectures or other [code](/usage/training#custom-code), those functions need
to be registered **before** your pipeline is loaded. Otherwise, spaCy won't know to be registered **before** your pipeline is loaded. Otherwise, spaCy won't know
how to create the objects referenced in the config. The how to create the objects referenced in the config. If you're loading your own
[`spacy package`](/api/cli#package) command lets you provide one or more paths pipeline in Python, you can make custom components available just by importing
to Python files containing custom registered functions using the `--code` the code that defines them before calling `spacy.load`. This is also how the
argument. `--code` argument to CLI commands works.
With the [`spacy package`](/api/cli#package) command, you can provide one or
more paths to Python files containing custom registered functions using the
`--code` argument.
> #### \_\_init\_\_.py (excerpt) > #### \_\_init\_\_.py (excerpt)
> >