Skip to content

Commit b91b786

Browse files
[Fix] correct 'ArtefactDetection' to 'ArtefactDetector' in documentation (#1993)
1 parent 8a83800 commit b91b786

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

docs/source/using_doctr/using_contrib_modules.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,20 @@ Available contribution modules
2020
2121
Here are all contribution modules that are available through docTR:
2222

23-
ArtefactDetection
23+
ArtefactDetector
2424
^^^^^^^^^^^^^^^^^
2525

26-
The ArtefactDetection module provides a set of functions to detect artefacts in the document images, such as logos, QR codes, bar codes, etc.
26+
The ArtefactDetector module provides a set of functions to detect artefacts in the document images, such as logos, QR codes, bar codes, etc.
2727
It is based on the YOLOv8 architecture, which is a state-of-the-art object detection model.
2828

2929
.. code:: python3
3030
3131
from doctr.io import DocumentFile
32-
from doctr.contrib.artefacts import ArtefactDetection
32+
from doctr.contrib.artefacts import ArtefactDetector
3333
3434
# Load the document
3535
doc = DocumentFile.from_images(["path/to/your/image"])
36-
detector = ArtefactDetection(batch_size=2, conf_threshold=0.5, iou_threshold=0.5)
36+
detector = ArtefactDetector(batch_size=2, conf_threshold=0.5, iou_threshold=0.5)
3737
artefacts = detector(doc)
3838
3939
# Visualize the detected artefacts
@@ -46,6 +46,6 @@ Reference: `YOLOv8 <https://github.com/ultralytics/ultralytics>`_
4646

4747
.. code:: python3
4848
49-
from doctr.contrib import ArtefactDetection
49+
from doctr.contrib import ArtefactDetector
5050
51-
detector = ArtefactDetection(model_path="path/to/your/model.onnx", labels=["table", "figure"])
51+
detector = ArtefactDetector(model_path="path/to/your/model.onnx", labels=["table", "figure"])

0 commit comments

Comments
 (0)