for repo review

[HLasse]

No description provided.

[HLasse]

great work my man! very clear and concise code, well documented and easy to follow along.

a couple of points:

• It would be optimal if yield_original when used in combination with set_doc_level did not yield the same Example twice if no augmentation took place.
• An extra getting started/appetizer section would help new users adopt easier. The notebook is great, but it takes some effort to get there, and some users might get lost/impatient before working through the example. Perhaps a very short example directly in the README so users do not have to refer to the documentation for an API example
• we should consider adding a tutorial showing how to train a new spaCy model using the augmenters (also for own reference)
• relatedly, we should consider making a couple of sample combinations of augmenters with sensible defaults for model training/model evaluation (could be part of the tutorial)
• check the comments for a couple of other small notes

I will give the readme/docs/notebook a read through for grammar tomorrow

[KennethEnevoldsen]

It would be optimal if yield_original when used in combination with set_doc_level did not yield the same Example twice if no augmentation took place.

Added in the newest commit as we discussed.

An extra getting started/appetizer section would help new users adopt easier. The notebook is great, but it takes some effort to get there, and some users might get lost/impatient before working through the example. Perhaps a very short example directly in the README so users do not have to refer to the documentation for an API example

Added in the newest commit.

we should consider adding a tutorial showing how to train a new spaCy model using the augmenters (also for own reference)

Added an issue #33

relatedly, we should consider making a couple of sample combinations of augmenters with sensible defaults for model training/model evaluation (could be part of the tutorial)

Agree. Let us do it when we have a bit more augmenters.