docs: Updated remaining docTR spelling

mindee · fg-mindee · Oct 25, 2021 · Oct 25, 2021 · Oct 25, 2021 · Oct 25, 2021
commit 3ede6e6c154e4e23ac252da8e03530af0f8f1147
diff --git a/README.md b/README.md
@@ -229,7 +229,7 @@ If you wish to cite this project, feel free to use this [BibTeX](http://www.bibt
 
 ```bibtex
 @misc{doctr2021,
-    title={DocTR: Document Text Recognition},
+    title={docTR: Document Text Recognition},
     author={Mindee},
     year={2021},
     publisher = {GitHub},

diff --git a/api/app/config.py b/api/app/config.py
@@ -7,7 +7,7 @@
 import doctr
 
 
-PROJECT_NAME: str = 'DocTR API'
+PROJECT_NAME: str = 'docTR API template'
 PROJECT_DESCRIPTION: str = 'Template API for Optical Character Recognition'
 VERSION: str = doctr.__version__
 DEBUG: bool = os.environ.get('DEBUG', '') != 'False'
diff --git a/api/app/routes/detection.py b/api/app/routes/detection.py
@@ -16,7 +16,7 @@
 
 @router.post("/", response_model=List[DetectionOut], status_code=200, summary="Perform text detection")
 async def text_detection(file: UploadFile = File(...)):
-    """Runs DocTR text detection model to analyze the input"""
+    """Runs docTR text detection model to analyze the input"""
     img = decode_img_as_tensor(file.file.read())
     boxes, _ = det_predictor([img])[0]
     return [DetectionOut(box=box.tolist()) for box in boxes[:, :-1]]
diff --git a/api/app/routes/ocr.py b/api/app/routes/ocr.py
@@ -16,7 +16,7 @@
 
 @router.post("/", response_model=List[OCROut], status_code=200, summary="Perform OCR")
 async def perform_ocr(file: UploadFile = File(...)):
-    """Runs DocTR OCR model to analyze the input"""
+    """Runs docTR OCR model to analyze the input"""
     img = decode_img_as_tensor(file.file.read())
     out = predictor([img])
 

diff --git a/api/app/routes/recognition.py b/api/app/routes/recognition.py
@@ -15,7 +15,7 @@
 
 @router.post("/", response_model=RecognitionOut, status_code=200, summary="Perform text recognition")
 async def text_recognition(file: UploadFile = File(...)):
-    """Runs DocTR text recognition model to analyze the input"""
+    """Runs docTR text recognition model to analyze the input"""
     img = decode_img_as_tensor(file.file.read())
     out = reco_predictor([img])
     return RecognitionOut(value=out[0][0])
diff --git a/demo/app.py b/demo/app.py
@@ -30,7 +30,7 @@ def main():
     st.set_page_config(layout="wide")
 
     # Designing the interface
-    st.title("DocTR: Document Text Recognition")
+    st.title("docTR: Document Text Recognition")
     # For newline
     st.write('\n')
     # Instructions

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,4 +1,4 @@
-DocTR: Document Text Recognition
+docTR: Document Text Recognition
 ================================
 
 State-of-the-art Optical Character Recognition made seamless & accessible to anyone, powered by TensorFlow 2 & PyTorch

diff --git a/references/classification/README.md b/references/classification/README.md
@@ -1,10 +1,10 @@
 # Character classification
 
-The sample training script was made to train a character classification model with DocTR
+The sample training script was made to train a character classification model with docTR.
 
 ## Setup
 
-First, you need to install doctr (with pip, for instance)
+First, you need to install `doctr` (with pip, for instance)
 
 ```shell
 pip install -e . --upgrade

diff --git a/references/detection/README.md b/references/detection/README.md
@@ -1,10 +1,10 @@
 # Text detection
 
-The sample training script was made to train text detection model with doctr
+The sample training script was made to train text detection model with docTR.
 
 ## Setup
 
-First, you need to install doctr (with pip, for instance)
+First, you need to install `doctr` (with pip, for instance)
 
 ```shell
 pip install -e . --upgrade

diff --git a/references/recognition/README.md b/references/recognition/README.md
@@ -1,10 +1,10 @@
 # Text recognition
 
-The sample training script was made to train text recognition model with doctr
+The sample training script was made to train text recognition model with docTR.
 
 ## Setup
 
-First, you need to install doctr (with pip, for instance)
+First, you need to install `doctr` (with pip, for instance)
 
 ```shell
 pip install -e . --upgrade