From a3b15c9f538ca0e940d83eaa7d0f74e5b490ba9d Mon Sep 17 00:00:00 2001 From: Paul O'Leary McCann Date: Tue, 17 Jan 2023 19:30:02 +0900 Subject: [PATCH] Clarify how `--code` arg works (#12102) * 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. * Add link to spacy.load docs --- website/docs/usage/saving-loading.mdx | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/website/docs/usage/saving-loading.mdx b/website/docs/usage/saving-loading.mdx index 87735fed1..e0daebe35 100644 --- a/website/docs/usage/saving-loading.mdx +++ b/website/docs/usage/saving-loading.mdx @@ -684,10 +684,15 @@ If your pipeline includes [custom components](/usage/processing-pipelines#custom-components), model architectures or other [code](/usage/training#custom-code), those functions need to be registered **before** your pipeline is loaded. Otherwise, spaCy won't know -how to create the objects referenced in the config. The -[`spacy package`](/api/cli#package) command lets you provide one or more paths -to Python files containing custom registered functions using the `--code` -argument. +how to create the objects referenced in the config. If you're loading your own +pipeline in Python, you can make custom components available just by importing +the code that defines them before calling +[`spacy.load`](/api/top-level#spacy.load). This is also how the `--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) >