Skip to content

Commit b9fd396

Browse files
committed
Improve the installation instructions
1 parent 867b89e commit b9fd396

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,11 +101,11 @@ After several major updates, layoutparser provides various functionalities and d
101101

102102
```bash
103103
pip install layoutparser # Install the base layoutparser library with
104-
pip install layoutparser[layoutmodels] # Install DL layout model toolkit
105-
pip install layoutparser[ocr] # Install OCR toolkit
104+
pip install "layoutparser[layoutmodels]" # Install DL layout model toolkit
105+
pip install "layoutparser[ocr]" # Install OCR toolkit
106106
```
107107

108-
Please check [installation.md](installation.md) for additional details on layoutparser installation.
108+
Extra steps are needed if you want to use Detectron2-based models. Please check [installation.md](installation.md) for additional details on layoutparser installation.
109109

110110
## Examples
111111

installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ After several major updates, LayoutParser provides various functionalities and d
1414
| Command | Description |
1515
| --- | --- |
1616
| `pip install layoutparser` | **Install the base LayoutParser Library**<br>It will support all key functions in LayoutParser, including:<br />1. Layout Data Structure and operations<br />2. Layout Visualization <br />3. Load/export the layout data |
17-
| `pip install layoutparser[effdet]` | **Install LayoutParser with Layout Detection Model Support**<br />It will install the LayoutParser base library as well as<br />supporting dependencies for the ***EfficientDet***-based layout detection models. |
17+
| `pip install "layoutparser[effdet]"` | **Install LayoutParser with Layout Detection Model Support**<br />It will install the LayoutParser base library as well as<br />supporting dependencies for the ***EfficientDet***-based layout detection models. |
1818
| `pip install layoutparser torch && pip install "git+https://github.com/facebookresearch/[email protected]#egg=detectron2"` | **Install LayoutParser with Layout Detection Model Support**<br />It will install the LayoutParser base library as well as<br />supporting dependencies for the ***Detectron2***-based layout detection models. See details in [Additional Instruction: Install Detectron2 Layout Model Backend](#additional-instruction-install-detectron2-layout-model-backend). |
19-
| `pip install layoutparser[paddledetection]` | **Install LayoutParser with Layout Detection Model Support**<br />It will install the LayoutParser base library as well as<br />supporting dependencies for the ***PaddleDetection***-based layout detection models. |
20-
| `pip install layoutparser[ocr]` | **Install LayoutParser with OCR Support**<br />It will install the LayoutParser base library as well as<br />supporting dependencies for performing OCRs. See details in [Additional Instruction: Install OCR utils](#additional-instruction-install-ocr-utils). |
19+
| `pip install "layoutparser[paddledetection]"` | **Install LayoutParser with Layout Detection Model Support**<br />It will install the LayoutParser base library as well as<br />supporting dependencies for the ***PaddleDetection***-based layout detection models. |
20+
| `pip install "layoutparser[ocr]"` | **Install LayoutParser with OCR Support**<br />It will install the LayoutParser base library as well as<br />supporting dependencies for performing OCRs. See details in [Additional Instruction: Install OCR utils](#additional-instruction-install-ocr-utils). |
2121

2222
### Additional Instruction: Install Detectron2 Layout Model Backend
2323

@@ -51,7 +51,7 @@ As reported by many users, the installation of Detectron2 can be rather tricky o
5151
Layout Parser also comes with supports for OCR functions. In order to use them, you need to install the OCR utils via:
5252

5353
```bash
54-
pip install layoutparser[ocr]
54+
pip install "layoutparser[ocr]"
5555
```
5656

5757
Additionally, if you want to use the Tesseract-OCR engine, you also need to install it on your computer. Please check the

0 commit comments

Comments
 (0)