mirror of
https://github.com/explosion/spaCy.git
synced 2024-11-13 05:07:03 +03:00
Remove all references to "begin_training" (#11943)
When v3 was released, `begin_training` was renamed to `initialize`. There were warnings in the code and docs about that. This PR removes them.
This commit is contained in:
parent
60379cec65
commit
6b9af38eeb
|
@ -131,13 +131,6 @@ class Warnings(metaclass=ErrorsWithCodes):
|
||||||
"and make it independent. For example, `replace_listeners = "
|
"and make it independent. For example, `replace_listeners = "
|
||||||
"[\"model.tok2vec\"]` See the documentation for details: "
|
"[\"model.tok2vec\"]` See the documentation for details: "
|
||||||
"https://spacy.io/usage/training#config-components-listeners")
|
"https://spacy.io/usage/training#config-components-listeners")
|
||||||
W088 = ("The pipeline component {name} implements a `begin_training` "
|
|
||||||
"method, which won't be called by spaCy. As of v3.0, `begin_training` "
|
|
||||||
"has been renamed to `initialize`, so you likely want to rename the "
|
|
||||||
"component method. See the documentation for details: "
|
|
||||||
"https://spacy.io/api/language#initialize")
|
|
||||||
W089 = ("As of spaCy v3.0, the `nlp.begin_training` method has been renamed "
|
|
||||||
"to `nlp.initialize`.")
|
|
||||||
W090 = ("Could not locate any {format} files in path '{path}'.")
|
W090 = ("Could not locate any {format} files in path '{path}'.")
|
||||||
W091 = ("Could not clean/remove the temp directory at {dir}: {msg}.")
|
W091 = ("Could not clean/remove the temp directory at {dir}: {msg}.")
|
||||||
W092 = ("Ignoring annotations for sentence starts, as dependency heads are set.")
|
W092 = ("Ignoring annotations for sentence starts, as dependency heads are set.")
|
||||||
|
|
|
@ -1239,15 +1239,6 @@ class Language:
|
||||||
sgd(key, W, dW) # type: ignore[call-arg, misc]
|
sgd(key, W, dW) # type: ignore[call-arg, misc]
|
||||||
return losses
|
return losses
|
||||||
|
|
||||||
def begin_training(
|
|
||||||
self,
|
|
||||||
get_examples: Optional[Callable[[], Iterable[Example]]] = None,
|
|
||||||
*,
|
|
||||||
sgd: Optional[Optimizer] = None,
|
|
||||||
) -> Optimizer:
|
|
||||||
warnings.warn(Warnings.W089, DeprecationWarning)
|
|
||||||
return self.initialize(get_examples, sgd=sgd)
|
|
||||||
|
|
||||||
def initialize(
|
def initialize(
|
||||||
self,
|
self,
|
||||||
get_examples: Optional[Callable[[], Iterable[Example]]] = None,
|
get_examples: Optional[Callable[[], Iterable[Example]]] = None,
|
||||||
|
|
|
@ -19,13 +19,6 @@ cdef class Pipe:
|
||||||
DOCS: https://spacy.io/api/pipe
|
DOCS: https://spacy.io/api/pipe
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def __init_subclass__(cls, **kwargs):
|
|
||||||
"""Raise a warning if an inheriting class implements 'begin_training'
|
|
||||||
(from v2) instead of the new 'initialize' method (from v3)"""
|
|
||||||
if hasattr(cls, "begin_training"):
|
|
||||||
warnings.warn(Warnings.W088.format(name=cls.__name__))
|
|
||||||
|
|
||||||
def __call__(self, Doc doc) -> Doc:
|
def __call__(self, Doc doc) -> Doc:
|
||||||
"""Apply the pipe to one document. The document is modified in place,
|
"""Apply the pipe to one document. The document is modified in place,
|
||||||
and returned. This usually happens under the hood when the nlp object
|
and returned. This usually happens under the hood when the nlp object
|
||||||
|
|
|
@ -529,17 +529,6 @@ def test_pipe_label_data_no_labels(pipe):
|
||||||
assert "labels" not in get_arg_names(initialize)
|
assert "labels" not in get_arg_names(initialize)
|
||||||
|
|
||||||
|
|
||||||
def test_warning_pipe_begin_training():
|
|
||||||
with pytest.warns(UserWarning, match="begin_training"):
|
|
||||||
|
|
||||||
class IncompatPipe(TrainablePipe):
|
|
||||||
def __init__(self):
|
|
||||||
...
|
|
||||||
|
|
||||||
def begin_training(*args, **kwargs):
|
|
||||||
...
|
|
||||||
|
|
||||||
|
|
||||||
def test_pipe_methods_initialize():
|
def test_pipe_methods_initialize():
|
||||||
"""Test that the [initialize] config reflects the components correctly."""
|
"""Test that the [initialize] config reflects the components correctly."""
|
||||||
nlp = Language()
|
nlp = Language()
|
||||||
|
|
|
@ -169,12 +169,6 @@ arguments it receives via the
|
||||||
[`[initialize.components]`](/api/data-formats#config-initialize) block in the
|
[`[initialize.components]`](/api/data-formats#config-initialize) block in the
|
||||||
config.
|
config.
|
||||||
|
|
||||||
<Infobox variant="warning" title="Changed in v3.0" id="begin_training">
|
|
||||||
|
|
||||||
This method was previously called `begin_training`.
|
|
||||||
|
|
||||||
</Infobox>
|
|
||||||
|
|
||||||
> #### Example
|
> #### Example
|
||||||
>
|
>
|
||||||
> ```python
|
> ```python
|
||||||
|
|
|
@ -200,12 +200,6 @@ knowledge base. This argument should be a function that takes a `Vocab` instance
|
||||||
and creates the `KnowledgeBase`, ensuring that the strings of the knowledge base
|
and creates the `KnowledgeBase`, ensuring that the strings of the knowledge base
|
||||||
are synced with the current vocab.
|
are synced with the current vocab.
|
||||||
|
|
||||||
<Infobox variant="warning" title="Changed in v3.0" id="begin_training">
|
|
||||||
|
|
||||||
This method was previously called `begin_training`.
|
|
||||||
|
|
||||||
</Infobox>
|
|
||||||
|
|
||||||
> #### Example
|
> #### Example
|
||||||
>
|
>
|
||||||
> ```python
|
> ```python
|
||||||
|
|
|
@ -165,12 +165,6 @@ arguments it receives via the
|
||||||
[`[initialize.components]`](/api/data-formats#config-initialize) block in the
|
[`[initialize.components]`](/api/data-formats#config-initialize) block in the
|
||||||
config.
|
config.
|
||||||
|
|
||||||
<Infobox variant="warning" title="Changed in v3.0" id="begin_training">
|
|
||||||
|
|
||||||
This method was previously called `begin_training`.
|
|
||||||
|
|
||||||
</Infobox>
|
|
||||||
|
|
||||||
> #### Example
|
> #### Example
|
||||||
>
|
>
|
||||||
> ```python
|
> ```python
|
||||||
|
|
|
@ -259,15 +259,6 @@ either in the [config](/usage/training#config), or by calling
|
||||||
[`pipe.add_label`](/api/pipe#add_label) for each possible output label (e.g. for
|
[`pipe.add_label`](/api/pipe#add_label) for each possible output label (e.g. for
|
||||||
the tagger or textcat).
|
the tagger or textcat).
|
||||||
|
|
||||||
<Infobox variant="warning" title="Changed in v3.0" id="begin_training">
|
|
||||||
|
|
||||||
This method was previously called `begin_training`. It now also takes a
|
|
||||||
**function** that is called with no arguments and returns a sequence of
|
|
||||||
[`Example`](/api/example) objects instead of tuples of `Doc` and `GoldParse`
|
|
||||||
objects.
|
|
||||||
|
|
||||||
</Infobox>
|
|
||||||
|
|
||||||
> #### Example
|
> #### Example
|
||||||
>
|
>
|
||||||
> ```python
|
> ```python
|
||||||
|
|
|
@ -152,12 +152,6 @@ network,
|
||||||
setting up the label scheme based on the data. This method is typically called
|
setting up the label scheme based on the data. This method is typically called
|
||||||
by [`Language.initialize`](/api/language#initialize).
|
by [`Language.initialize`](/api/language#initialize).
|
||||||
|
|
||||||
<Infobox variant="warning" title="Changed in v3.0" id="begin_training">
|
|
||||||
|
|
||||||
This method was previously called `begin_training`.
|
|
||||||
|
|
||||||
</Infobox>
|
|
||||||
|
|
||||||
> #### Example
|
> #### Example
|
||||||
>
|
>
|
||||||
> ```python
|
> ```python
|
||||||
|
|
|
@ -142,12 +142,6 @@ arguments it receives via the
|
||||||
[`[initialize.components]`](/api/data-formats#config-initialize) block in the
|
[`[initialize.components]`](/api/data-formats#config-initialize) block in the
|
||||||
config.
|
config.
|
||||||
|
|
||||||
<Infobox variant="warning" title="Changed in v3.0" id="begin_training">
|
|
||||||
|
|
||||||
This method was previously called `begin_training`.
|
|
||||||
|
|
||||||
</Infobox>
|
|
||||||
|
|
||||||
> #### Example
|
> #### Example
|
||||||
>
|
>
|
||||||
> ```python
|
> ```python
|
||||||
|
|
|
@ -187,12 +187,6 @@ arguments it receives via the
|
||||||
[`[initialize.components]`](/api/data-formats#config-initialize) block in the
|
[`[initialize.components]`](/api/data-formats#config-initialize) block in the
|
||||||
config.
|
config.
|
||||||
|
|
||||||
<Infobox variant="warning" title="Changed in v3.0" id="begin_training">
|
|
||||||
|
|
||||||
This method was previously called `begin_training`.
|
|
||||||
|
|
||||||
</Infobox>
|
|
||||||
|
|
||||||
> #### Example
|
> #### Example
|
||||||
>
|
>
|
||||||
> ```python
|
> ```python
|
||||||
|
|
Loading…
Reference in New Issue
Block a user