docs: Add comment about the generation of no-answer samples in FARMReader training (#3404)

* Add comment about no-answer generation

* Add comment about no-answer generation

* Fix typo

Co-authored-by: Sebastian <sjrl@users.noreply.github.com>

* Incorporate reviewer feedback

* Incorporate reviewer feedback

Co-authored-by: Sebastian <sjrl@users.noreply.github.com>
This commit is contained in:
Branden Chan 2022-10-18 14:37:37 +02:00 committed by GitHub
parent 15a59fd040
commit 3bf5d4350f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -377,6 +377,9 @@ class FARMReader(BaseReader):
Checkpoints can be stored via setting `checkpoint_every` to a custom number of steps.
If any checkpoints are stored, a subsequent run of train() will resume training from the latest available checkpoint.
Note that when performing training with this function, long documents are split into chunks.
If a chunk doesn't contain the answer to the question, it is treated as a no-answer sample.
:param data_dir: Path to directory containing your training data in SQuAD style
:param train_filename: Filename of training data
:param dev_filename: Filename of dev / eval data