explosion/spaCy
1
1
Fork 0
mirror of https://github.com/explosion/spaCy.git synced 2025-08-04 04:10:20 +03:00
Code Issues Packages Projects Releases Wiki Activity

Docstring fixes

Browse Source
This commit is contained in:
Daniël de Kok 2023-01-11 17:39:42 +01:00
parent b3d0754b1a
commit a880e017ca
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
spacy/training/batchers.py
View File

@ -26,8 +26,8 @@ def configure_minibatch_by_padded_size(
The padded size is defined as the maximum length of sequences within the The padded size is defined as the maximum length of sequences within the
batch multiplied by the number of sequences in the batch. batch multiplied by the number of sequences in the batch.
size (int or Iterable[int]): The largest padded size to batch sequences into. size (int, Iterable[int] or Schedule): The largest padded size to batch sequences
Can be a single integer, or a sequence, allowing for variable batch sizes. into. Can be a single integer, or a sequence, allowing for variable batch sizes.
buffer (int): The number of sequences to accumulate before sorting by length. buffer (int): The number of sequences to accumulate before sorting by length.
A larger buffer will result in more even sizing, but if the buffer is A larger buffer will result in more even sizing, but if the buffer is
very large, the iteration order will be less random, which can result very large, the iteration order will be less random, which can result
@ -58,7 +58,7 @@ def configure_minibatch_by_words(
) -> BatcherT: ) -> BatcherT:
"""Create a batcher that uses the "minibatch by words" strategy. """Create a batcher that uses the "minibatch by words" strategy.
size (int or Iterable[int]): The target number of words per batch. size (int, Iterable[int] or Schedule): The target number of words per batch.
Can be a single integer, or a sequence, allowing for variable batch sizes. Can be a single integer, or a sequence, allowing for variable batch sizes.
tolerance (float): What percentage of the size to allow batches to exceed. tolerance (float): What percentage of the size to allow batches to exceed.
discard_oversize (bool): Whether to discard sequences that by themselves discard_oversize (bool): Whether to discard sequences that by themselves
@ -82,7 +82,7 @@ def configure_minibatch(
) -> BatcherT: ) -> BatcherT:
"""Create a batcher that creates batches of the specified size. """Create a batcher that creates batches of the specified size.
size (int or Iterable[int]): The target number of items per batch. size (int, Iterable[int] or Schedule): The target number of items per batch.
Can be a single integer, or a sequence, allowing for variable batch sizes. Can be a single integer, or a sequence, allowing for variable batch sizes.
""" """
optionals = {"get_length": get_length} if get_length is not None else {} optionals = {"get_length": get_length} if get_length is not None else {}
@ -140,7 +140,7 @@ def minibatch_by_words(
themselves, or be discarded if discard_oversize=True. themselves, or be discarded if discard_oversize=True.
seqs (Iterable[Sequence]): The sequences to minibatch. seqs (Iterable[Sequence]): The sequences to minibatch.
size (int or Sequence[int]): The target number of words per batch. size (int or Iterable[int]): The target number of words per batch.
Can be a single integer, or a sequence, allowing for variable batch sizes. Can be a single integer, or a sequence, allowing for variable batch sizes.
tolerance (float): What percentage of the size to allow batches to exceed. tolerance (float): What percentage of the size to allow batches to exceed.
discard_oversize (bool): Whether to discard sequences that by themselves discard_oversize (bool): Whether to discard sequences that by themselves