Skip to content

Commit 3c73f2d

Browse files
gineshidalgo99gineshidalgo99
committed
Installation and quick start separated
1 parent 96bb25a commit 3c73f2d

File tree

5 files changed

+124
-118
lines changed

5 files changed

+124
-118
lines changed

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,13 +104,15 @@ Your case if you just want to process a folder of images or video or webcam and
104104

105105
Forget about the OpenPose library details and just read the [doc/demo_overview.md](doc/demo_overview.md) 1-page section.
106106

107+
107108
#### OpenPose Wrapper
108109
Your case if you want to read a specific format of image source and/or add a specific post-processing function and/or implement your own display/saving.
109110

110111
(Almost) forget about the library, just take a look to the `Wrapper` tutorial on [examples/tutorial_wrapper/](examples/tutorial_wrapper/).
111112

112113
Note: you should not need to modify the OpenPose source code nor examples. In this way, you are able to directly upgrade OpenPose anytime in the future without changing your code. You might create your custom code on [examples/user_code/](examples/user_code/) and compile it by using `make all` in the OpenPose folder.
113114

115+
114116
#### OpenPose Library
115117
Your case if you want to change internal functions and/or extend its functionality. First, take a look at the [Demo](#demo) and [OpenPose Wrapper](#openpose-wrapper). Second, read the 2 following subsections: OpenPose Overview and Extending Functionality.
116118

@@ -120,6 +122,7 @@ Your case if you want to change internal functions and/or extend its functionali
120122

121123
3. Adding An Extra Module: Learn how to add an extra module in [doc/library_add_new_module.md](doc/library_add_new_module.md).
122124

125+
123126
#### Doxygen Documentation Autogeneration
124127
You can generate the documentation by running the following command. The documentation will be generated in `doc/doxygen/html/index.html`. You can simply open it with double-click (your default browser should automatically display it).
125128
```

‎doc/demo_overview.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ In order to learn how to use it, run `./build/examples/openpose/openpose.bin --h
88

99

1010
## Running on Images, Video or Webcam
11-
See [doc/installation.md#quick-start](./installation.md#quick-start).
11+
See [doc/quick_start.md#quick-start](./quick_start.md#quick-start).
1212

1313

1414

1515
## Pose + Face + Hands
16-
See [doc/installation.md#quick-start](./installation.md#quick-start).
16+
See [doc/quick_start.md#quick-start](./quick_start.md#quick-start).
1717

1818

1919

2020
## Maximum Accuracy Configuration
21-
See [doc/installation.md#quick-start](./installation.md#quick-start).
21+
See [doc/quick_start.md#quick-start](./quick_start.md#quick-start).
2222

2323

2424

‎doc/installation.md‎

Lines changed: 4 additions & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
OpenPose Library - Compilation and Installation
1+
OpenPose - Installation and FAQ
22
====================================
33

44
## Contents
55
1. [Requirements](#requirements)
66
2. [Ubuntu](#ubuntu)
77
3. [Windows](#windows)
88
4. [OpenPose 3D Demo](#openpose-3d-demo)
9-
5. [Quick Start](#quick-start)
10-
6. [Expected Visual Results](#expected-visual-results)
11-
7. [FAQ](#faq)
9+
5. [FAQ](#faq)
1210

1311

1412

@@ -104,7 +102,7 @@ You just need to remove the OpenPose folder, by default called `openpose/`. E.g.
104102
105103
### Installation - Library
106104
1. Install the pre-requisites:
107-
1. Microsoft Visual Studio (VS) 2015 Enterprise Update 3. VS Enterprise Update 1 will give some compiler errors, while VS 2015 Community has not been tested.
105+
1. Microsoft Visual Studio (VS) 2015 Enterprise Update 3. VS Enterprise Update 1 and VS 2017 will give some compiler errors, while VS 2015 Community has not been tested.
108106
2. [CUDA 8](https://developer.nvidia.com/cuda-downloads): Install it on the default location, `C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v8.0`. Otherwise, modify the Visual Studio project solution accordingly. Install CUDA 8.0 after Visual Studio 2015 is installed to assure that the CUDA installation will generate all necessary files for VS. If CUDA was already installed, re-install it after installing VS!
109107
3. [cuDNN 5.1](https://developer.nvidia.com/cudnn): Once you have downloaded it, just unzip it and copy (merge) the contents on the CUDA folder, `C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v8.0`.
110108
2. Download the OpenPose dependencies and models (body, face and hand models) by double-clicking on `{openpose_path}\windows\download_3rdparty_and_models.bat`. Alternatively, you might prefer to download them manually:
@@ -129,7 +127,7 @@ You just need to remove the OpenPose folder, by default called `openpose/`. E.g.
129127
3. Open the Windows cmd (Windows button + X, then A).
130128
4. Go to the OpenPose directory, assuming OpenPose has been downloaded on `C:\openpose`: `cd C:\openpose\`.
131129
5. Run the tutorial commands.
132-
7. Check [Quick Start](#quick-start) to test video, webcam and a folder with images, in order to verify OpenPose was properly installed.
130+
7. Check OpenPose was properly installed by running it on the default images, video or webcam: [doc/quick_start.md#quick-start](./quick_start.md#quick-start).
133131
134132
135133
@@ -158,114 +156,6 @@ If you want to try our OpenPose 3-D reconstruction demo, see [doc/openpose_3d_re
158156
159157
160158
161-
## Quick Start
162-
Check that the library is working properly by using any of the following commands. Note that `examples/media/video.avi` and `examples/media` exist, so you do not need to change the paths. In addition, the following commands assume your terminal (Ubuntu) or cmd (Windows) are located in the OpenPose folder.
163-
164-
**1. Running on Video**
165-
```
166-
# Ubuntu
167-
./build/examples/openpose/openpose.bin --video examples/media/video.avi
168-
# With face and hands
169-
./build/examples/openpose/openpose.bin --video examples/media/video.avi --face --hand
170-
```
171-
```
172-
:: Windows - Demo
173-
bin\OpenPoseDemo.exe --video examples\media\video.avi
174-
:: With face and hands
175-
bin\OpenPoseDemo.exe --video examples\media\video.avi --face --hand
176-
```
177-
```
178-
:: Windows - Library
179-
windows\x64\Release\OpenPoseDemo.exe --video examples\media\video.avi
180-
:: With face and hands
181-
windows\x64\Release\OpenPoseDemo.exe --video examples\media\video.avi --face --hand
182-
```
183-
184-
185-
186-
**2. Running on Webcam**
187-
```
188-
# Ubuntu
189-
./build/examples/openpose/openpose.bin
190-
# With face and hands
191-
./build/examples/openpose/openpose.bin --face --hand
192-
```
193-
```
194-
:: Windows - Demo
195-
bin\OpenPoseDemo.exe
196-
:: With face and hands
197-
bin\OpenPoseDemo.exe --face --hand
198-
```
199-
```
200-
:: Windows - Library
201-
windows\x64\Release\OpenPoseDemo.exe
202-
:: With face and hands
203-
windows\x64\Release\OpenPoseDemo.exe --face --hand
204-
```
205-
206-
207-
208-
**3. Running on Images**
209-
```
210-
# Ubuntu
211-
./build/examples/openpose/openpose.bin --image_dir examples/media/
212-
# With face and hands
213-
./build/examples/openpose/openpose.bin --image_dir examples/media/ --face --hand
214-
```
215-
```
216-
:: Windows - Demo
217-
bin\OpenPoseDemo.exe --image_dir examples\media\
218-
:: With face and hands
219-
bin\OpenPoseDemo.exe --image_dir examples\media\ --face --hand
220-
```
221-
```
222-
:: Windows - Library
223-
windows\x64\Release\OpenPoseDemo.exe --image_dir examples\media\
224-
:: With face and hands
225-
windows\x64\Release\OpenPoseDemo.exe --image_dir examples\media\ --face --hand
226-
```
227-
228-
229-
230-
**4. Maximum Accuracy Configuration**
231-
232-
This command provides the most accurate results we have been able to achieve for body, hand and face keypoint detection. However, this command will need around 8 GB of GPU memory and runs around 1 FPS on a Titan X.
233-
```
234-
# Ubuntu
235-
./build/examples/openpose/openpose.bin --net_resolution "1312x736" --scale_number 4 --scale_gap 0.25 --hand --hand_scale_number 6 --hand_scale_range 0.4 --face
236-
```
237-
```
238-
:: Windows - Demo
239-
bin\OpenPoseDemo.exe --net_resolution "1312x736" --scale_number 4 --scale_gap 0.25 --hand --hand_scale_number 6 --hand_scale_range 0.4 --face
240-
```
241-
```
242-
:: Windows - Library
243-
windows\x64\Release\OpenPoseDemo.exe --net_resolution "1312x736" --scale_number 4 --scale_gap 0.25 --hand --hand_scale_number 6 --hand_scale_range 0.4 --face
244-
```
245-
246-
247-
248-
249-
250-
## Expected Visual Results
251-
The visual GUI should show the original image with the poses blended on it, similarly to the pose of this gif:
252-
<p align="center">
253-
<img src="media/shake.gif", width="720">
254-
</p>
255-
256-
If you choose to visualize a body part or a PAF (Part Affinity Field) heat map with the command option `--part_to_show`, the result should be similar to one of the following images:
257-
<p align="center">
258-
<img src="media/body_heat_maps.png", width="720">
259-
</p>
260-
261-
<p align="center">
262-
<img src="media/paf_heat_maps.png", width="720">
263-
</p>
264-
265-
266-
267-
268-
269159
## FAQ
270160
**Q: Out of memory error** - I get an error similar to: `Check failed: error == cudaSuccess (2 vs. 0) out of memory`.
271161

‎doc/openpose_3d_reconstruction_demo.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The program uses 3 cameras by default, but cameras can be added or removed from
4848

4949

5050
### Windows
51-
1. [Install the OpenPose library](installation.md#installation---library) and make sure the [OpenPose demo runs](installation.md#quick-start), so that the required OpenPose library was properly compiled.
51+
1. [Install the OpenPose library](installation.md#installation---library) and make sure the [OpenPose demo runs](quick_start.md#quick-start), so that the required OpenPose library was properly compiled.
5252
2. Open the OpenPose visual studio solution `windows\openpose.sln`.
5353
3. Right-click on `Solution 'OpenPose'` of the `Solution Explorer` window, usually placed at the top-right part of the VS screen.
5454
4. Click on `Properties`. Go to `Configuration Properties` -> `Configuration` and check `Build` for the `OpenPose3DReconstruction` project.

‎doc/quick_start.md‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
OpenPose - Quick Start
2+
====================================
3+
4+
## Contents
5+
1. [Quick Start](#quick-start)
6+
1. [Running on Video](#running-on-video)
7+
2. [Running on Webcam](#running-on-webcam)
8+
3. [Running on Images](#running-on-images)
9+
4. [Maximum Accuracy Configuration](#Maximum-accuracy-configuration)
10+
2. [Expected Visual Results](#expected-visual-results)
11+
12+
13+
14+
## Quick Start
15+
Check that the library is working properly by running any of the following commands. Make sure that you are in the **root directory of the project** (i.e. in the OpenPose folder, not inside `build/` nor `windows/` nor `bin/`). In addition, `examples/media/video.avi` and `examples/media` do exist, no need to change the paths.
16+
17+
### Running on Video
18+
```
19+
# Ubuntu
20+
./build/examples/openpose/openpose.bin --video examples/media/video.avi
21+
# With face and hands
22+
./build/examples/openpose/openpose.bin --video examples/media/video.avi --face --hand
23+
```
24+
```
25+
:: Windows - Demo
26+
bin\OpenPoseDemo.exe --video examples\media\video.avi
27+
:: With face and hands
28+
bin\OpenPoseDemo.exe --video examples\media\video.avi --face --hand
29+
```
30+
```
31+
:: Windows - Library
32+
windows\x64\Release\OpenPoseDemo.exe --video examples\media\video.avi
33+
:: With face and hands
34+
windows\x64\Release\OpenPoseDemo.exe --video examples\media\video.avi --face --hand
35+
```
36+
37+
38+
39+
### Running on Webcam
40+
```
41+
# Ubuntu
42+
./build/examples/openpose/openpose.bin
43+
# With face and hands
44+
./build/examples/openpose/openpose.bin --face --hand
45+
```
46+
```
47+
:: Windows - Demo
48+
bin\OpenPoseDemo.exe
49+
:: With face and hands
50+
bin\OpenPoseDemo.exe --face --hand
51+
```
52+
```
53+
:: Windows - Library
54+
windows\x64\Release\OpenPoseDemo.exe
55+
:: With face and hands
56+
windows\x64\Release\OpenPoseDemo.exe --face --hand
57+
```
58+
59+
60+
61+
### Running on Images
62+
```
63+
# Ubuntu
64+
./build/examples/openpose/openpose.bin --image_dir examples/media/
65+
# With face and hands
66+
./build/examples/openpose/openpose.bin --image_dir examples/media/ --face --hand
67+
```
68+
```
69+
:: Windows - Demo
70+
bin\OpenPoseDemo.exe --image_dir examples\media\
71+
:: With face and hands
72+
bin\OpenPoseDemo.exe --image_dir examples\media\ --face --hand
73+
```
74+
```
75+
:: Windows - Library
76+
windows\x64\Release\OpenPoseDemo.exe --image_dir examples\media\
77+
:: With face and hands
78+
windows\x64\Release\OpenPoseDemo.exe --image_dir examples\media\ --face --hand
79+
```
80+
81+
82+
83+
### Maximum Accuracy Configuration
84+
This command provides the most accurate results we have been able to achieve for body, hand and face keypoint detection. However, this command will need around 8 GB of GPU memory and runs around 1 FPS on a Titan X.
85+
```
86+
# Ubuntu
87+
./build/examples/openpose/openpose.bin --net_resolution "1312x736" --scale_number 4 --scale_gap 0.25 --hand --hand_scale_number 6 --hand_scale_range 0.4 --face
88+
```
89+
```
90+
:: Windows - Demo
91+
bin\OpenPoseDemo.exe --net_resolution "1312x736" --scale_number 4 --scale_gap 0.25 --hand --hand_scale_number 6 --hand_scale_range 0.4 --face
92+
```
93+
```
94+
:: Windows - Library
95+
windows\x64\Release\OpenPoseDemo.exe --net_resolution "1312x736" --scale_number 4 --scale_gap 0.25 --hand --hand_scale_number 6 --hand_scale_range 0.4 --face
96+
```
97+
98+
99+
100+
## Expected Visual Results
101+
The visual GUI should show the original image with the poses blended on it, similarly to the pose of this gif:
102+
<p align="center">
103+
<img src="media/shake.gif", width="720">
104+
</p>
105+
106+
If you choose to visualize a body part or a PAF (Part Affinity Field) heat map with the command option `--part_to_show`, the result should be similar to one of the following images:
107+
<p align="center">
108+
<img src="media/body_heat_maps.png", width="720">
109+
</p>
110+
111+
<p align="center">
112+
<img src="media/paf_heat_maps.png", width="720">
113+
</p>

0 commit comments

Comments
 (0)