Update README.md
Browse files
README.md
CHANGED
@@ -32,40 +32,53 @@ This service allows for the segmentation and classification of different parts o
|
|
32 |
|
33 |
|
34 |
## Quick Start
|
|
|
35 |
|
36 |
-
|
37 |
-
|
38 |
-
|
39 |
-
|
40 |
|
41 |
-
|
|
|
|
|
|
|
42 |
|
43 |
-
|
44 |
|
45 |
-
Get the segments of a PDF:
|
46 |
-
|
47 |
-
# With visual models
|
48 |
curl -X POST -F 'file=@/PATH/TO/PDF/pdf_name.pdf' localhost:5060
|
49 |
-
|
50 |
-
# With non-visual models [with the models in this model card]
|
51 |
-
curl -X POST -F 'file=@/PATH/TO/PDF/pdf_name.pdf' -F "fast=true" localhost:5060
|
52 |
-
|
53 |
|
54 |
To stop the server:
|
55 |
|
56 |
-
|
57 |
-
|
58 |
|
59 |
## Contents
|
60 |
- [Quick Start](#quick-start)
|
|
|
61 |
- [Dependencies](#dependencies)
|
62 |
- [Requirements](#requirements)
|
63 |
- [Models](#models)
|
64 |
- [Data](#data)
|
65 |
- [Usage](#usage)
|
66 |
-
- [
|
|
|
|
|
67 |
- [Related Services](#related-services)
|
68 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
69 |
## Dependencies
|
70 |
* Docker Desktop 4.25.0 [install link](https://www.docker.com/products/docker-desktop/)
|
71 |
* For GPU support [install link](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html)
|
|
|
32 |
|
33 |
|
34 |
## Quick Start
|
35 |
+
Run the service:
|
36 |
|
37 |
+
- With GPU support:
|
38 |
+
```
|
39 |
+
docker run --rm --name pdf-document-layout-analysis --gpus '"device=0"' -p 5060:5060 --entrypoint ./start.sh huridocs/pdf-document-layout-analysis:v0.0.14
|
40 |
+
```
|
41 |
|
42 |
+
- Without GPU support:
|
43 |
+
```
|
44 |
+
docker run --rm --name pdf-document-layout-analysis -p 5060:5060 --entrypoint ./start.sh huridocs/pdf-document-layout-analysis:v0.0.14
|
45 |
+
```
|
46 |
|
47 |
+
Get the segments from a PDF:
|
48 |
|
|
|
|
|
|
|
49 |
curl -X POST -F 'file=@/PATH/TO/PDF/pdf_name.pdf' localhost:5060
|
|
|
|
|
|
|
|
|
50 |
|
51 |
To stop the server:
|
52 |
|
53 |
+
docker stop pdf-document-layout-analysis
|
|
|
54 |
|
55 |
## Contents
|
56 |
- [Quick Start](#quick-start)
|
57 |
+
- [Build From Source](#build-from-source)
|
58 |
- [Dependencies](#dependencies)
|
59 |
- [Requirements](#requirements)
|
60 |
- [Models](#models)
|
61 |
- [Data](#data)
|
62 |
- [Usage](#usage)
|
63 |
+
- [Benchmarks](#benchmarks)
|
64 |
+
- [Performance](#performance)
|
65 |
+
- [Speed](#speed)
|
66 |
- [Related Services](#related-services)
|
67 |
|
68 |
+
## Build From Source
|
69 |
+
|
70 |
+
Start the service:
|
71 |
+
|
72 |
+
make start
|
73 |
+
|
74 |
+
Get the segments from a PDF:
|
75 |
+
|
76 |
+
curl -X POST -F 'file=@/PATH/TO/PDF/pdf_name.pdf' localhost:5060
|
77 |
+
|
78 |
+
To stop the server:
|
79 |
+
|
80 |
+
make stop
|
81 |
+
|
82 |
## Dependencies
|
83 |
* Docker Desktop 4.25.0 [install link](https://www.docker.com/products/docker-desktop/)
|
84 |
* For GPU support [install link](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html)
|