Skip to content

Commit 4afe099

Browse files
[DOCS] Update LP-GSG - link anchor, formatting
1 parent c33c637 commit 4afe099

1 file changed

Lines changed: 52 additions & 51 deletions

File tree

docs/user-guide/loss-prevention/get-started.md

Lines changed: 52 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
- Intel hardware (CPU, iGPU, dGPU, NPU)
1010
- Intel drivers:
1111
- [Intel GPU drivers](https://dgpu-docs.intel.com/driver/client/overview.html)
12-
- [NPU](https://docs.openedgeplatform.intel.com/dev/edge-ai-libraries/dlstreamer/dev_guide/advanced_install/advanced_install_guide_prerequisites.html#prerequisite-2-install-intel-npu-drivers)
12+
- [NPU](https://docs.openedgeplatform.intel.com/dev/edge-ai-libraries/dlstreamer/dev_guide/advanced_install/advanced_install_guide_prerequisites.html#optional-prerequisite-2-install-intel-npu-drivers)
1313
- Sufficient disk space for models, videos, and results
1414

1515
> **Note:** First-time setup downloads AI models, sample videos, and Docker images - this may take 5-15 minutes depending on your internet connection.
@@ -82,16 +82,16 @@ make run-lp CAMERA_STREAM=camera_to_workload_asc_object_detection_classification
8282
8383
## Step by step instructions
8484

85-
1. Clone the repo with the below command
85+
1. Clone the repo with the below command:
8686

87-
```
87+
```bash
8888
git clone -b <release-or-tag> --single-branch https://github.com/intel-retail/loss-prevention
8989
```
9090

91-
> Replace <release-or-tag> with the version you want to clone (for example, **v4.0.0**).
91+
> Replace <release-or-tag> with the version you want to clone (for example, **release-2026.2.0**).
9292
93-
```
94-
git clone -b v4.0.0 --single-branch https://github.com/intel-retail/loss-prevention
93+
```bash
94+
git clone -b release-2026.2.0 --single-branch https://github.com/intel-retail/loss-prevention
9595
```
9696

9797
2. **Run Loss Prevention (Recommended for First Time)**
@@ -143,13 +143,13 @@ make run-lp CAMERA_STREAM=camera_to_workload_asc_object_detection_classification
143143
CAMERA_STREAM=camera_to_workload_asc_object_detection_classification.json WORKLOAD_DIST=workload_to_pipeline_asc_object_detection_classification_gpu.json make run-lp RENDER_MODE=1
144144
```
145145

146-
> **Note:**
147-
>
148-
> **Display Options**: Add `RENDER_MODE=1` to any command above to see live video with detection boxes. Remove it for headless operation (servers/automation).
149-
>
150-
> **Choose Your Hardware**: Replace `_gpu` with `_cpu` or `_npu` based on your available hardware. See [Automated Self-Checkout Configurations](./get-started/advanced.md#automated-self-checkout-configurations) for all options.
146+
> **Note:**
147+
>
148+
> **Display Options**: Add `RENDER_MODE=1` to any command above to see live video with detection boxes. Remove it for headless operation (servers/automation).
149+
>
150+
> **Choose Your Hardware**: Replace `_gpu` with `_cpu` or `_npu` based on your available hardware. See [Automated Self-Checkout Configurations](./get-started/advanced.md#automated-self-checkout-configurations) for all options.
151151
152-
## What You'll See When Working
152+
## What You will See When Working
153153

154154
### Loss Prevention Results
155155

@@ -169,41 +169,41 @@ make run-lp CAMERA_STREAM=camera_to_workload_asc_object_detection_classification
169169
- **Processing**: Real-time video analysis at 15-30 FPS
170170
- **Results**: JSON files appear in `results/` folder within seconds
171171

172-
4. Verify Results
172+
## Verify Results
173173

174-
After starting Loss Prevention you will begin to see result files being written into the results/ directory. Here are example outputs from the 3 log files.
174+
After starting Loss Prevention you will begin to see result files being written into the results/ directory. Here are example outputs from the 3 log files.
175175

176-
gst-launch\_<time>\_gst.log
176+
Sample `gst-launch\_<time>\_gst.log` output:
177177

178-
```
179-
/GstPipeline:pipeline0/GstGvaWatermark:gvawatermark0/GstCapsFilter:capsfilter1: caps = video/x-raw(memory:VASurface), format=(string)RGBA
180-
/GstPipeline:pipeline0/GstFPSDisplaySink:fpsdisplaysink0/GstXImageSink:ximagesink0: sync = true
181-
Got context from element 'vaapipostproc1': gst.vaapi.Display=context, gst.vaapi.Display=(GstVaapiDisplay)"\(GstVaapiDisplayGLX\)\ vaapidisplayglx0", gst.vaapi.Display.GObject=(GstObject)"\(GstVaapiDisplayGLX\)\ vaapidisplayglx0";
182-
Progress: (open) Opening Stream
183-
Pipeline is PREROLLED ...
184-
Prerolled, waiting for progress to finish...
185-
Progress: (connect) Connecting to rtsp://localhost:8554/camera_0
186-
Progress: (open) Retrieving server options
187-
Progress: (open) Retrieving media info
188-
Progress: (request) SETUP stream 0
189-
```
190-
191-
pipeline<time>\_gst.log
178+
```text
179+
/GstPipeline:pipeline0/GstGvaWatermark:gvawatermark0/GstCapsFilter:capsfilter1: caps = video/x-raw(memory:VASurface), format=(string)RGBA
180+
/GstPipeline:pipeline0/GstFPSDisplaySink:fpsdisplaysink0/GstXImageSink:ximagesink0: sync = true
181+
Got context from element 'vaapipostproc1': gst.vaapi.Display=context, gst.vaapi.Display=(GstVaapiDisplay)"\(GstVaapiDisplayGLX\)\ vaapidisplayglx0", gst.vaapi.Display.GObject=(GstObject)"\(GstVaapiDisplayGLX\)\ vaapidisplayglx0";
182+
Progress: (open) Opening Stream
183+
Pipeline is PREROLLED ...
184+
Prerolled, waiting for progress to finish...
185+
Progress: (connect) Connecting to rtsp://localhost:8554/camera_0
186+
Progress: (open) Retrieving server options
187+
Progress: (open) Retrieving media info
188+
Progress: (request) SETUP stream 0
189+
```
192190

193-
```
194-
14.58
195-
14.58
196-
15.47
197-
15.47
198-
15.10
199-
15.10
200-
14.60
201-
14.60
202-
14.88
203-
14.88
204-
```
191+
Sample `pipeline<time>\_gst.log` output:
192+
193+
```text
194+
14.58
195+
14.58
196+
15.47
197+
15.47
198+
15.10
199+
15.10
200+
14.60
201+
14.60
202+
14.88
203+
14.88
204+
```
205205

206-
r<time>\_gst.jsonl
206+
Sample `r<time>\_gst.jsonl` output:
207207

208208
```json
209209
{
@@ -276,19 +276,19 @@ make run-lp CAMERA_STREAM=camera_to_workload_asc_object_detection_classification
276276

277277
> **Note:** If unable to see results folder or files, please refer to the [Troubleshooting](#troubleshooting) section for more details.
278278
279-
5. Stop the containers:
279+
## Stop the containers
280280

281-
When pre-built images are pulled-
281+
When pre-built images are pulled-
282282

283-
```bash
284-
make down-lp
285-
```
283+
```bash
284+
make down-lp
285+
```
286286

287-
When images are built locally-
287+
When images are built locally-
288288

289-
```bash
290-
make down-lp REGISTRY=false
291-
```
289+
```bash
290+
make down-lp REGISTRY=false
291+
```
292292

293293
## Troubleshooting
294294

@@ -298,6 +298,7 @@ make run-lp CAMERA_STREAM=camera_to_workload_asc_object_detection_classification
298298
```sh
299299
docker ps -a
300300
```
301+
301302
- Verify Docker containers if it is running or no errors in container logs
302303

303304
```bash

0 commit comments

Comments
 (0)