Skip to content

Commit 030e3a4

Browse files
author
Gines
committed
Updated instructions
1 parent 4e9766f commit 030e3a4

File tree

3 files changed

+56
-30
lines changed

3 files changed

+56
-30
lines changed

README.md

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,12 @@ OpenPose is a **library for real-time multi-person keypoint detection and multi-
4242
2. [OpenPose Wrapper](#openpose-wrapper)
4343
3. [OpenPose Library](#openpose-library)
4444
8. [Output](#output)
45-
9. [Custom Caffe](#custom-caffe)
46-
10. [Standalone Face Or Hand Keypoint Detector](#standalone-face-or-hand-keypoint-detector)
47-
11. [Speed Up Openpose And Benchmark](#speed-up-openpose-and-benchmark)
48-
12. [Send Us Failure Cases!](#send-us-failure-cases)
49-
13. [Send Us Your Feedback!](#send-us-your-feedback)
50-
14. [Citation](#citation)
51-
15. [Other Contributors](#other-contributors)
45+
9. [Standalone Face Or Hand Keypoint Detector](#standalone-face-or-hand-keypoint-detector)
46+
10. [Speed Up Openpose And Benchmark](#speed-up-openpose-and-benchmark)
47+
11. [Send Us Failure Cases!](#send-us-failure-cases)
48+
12. [Send Us Your Feedback!](#send-us-your-feedback)
49+
13. [Citation](#citation)
50+
14. [Other Contributors](#other-contributors)
5251

5352

5453
## Introduction
@@ -137,19 +136,6 @@ Check the output (format, keypoint index ordering, etc.) in [doc/output.md](doc/
137136

138137

139138

140-
## Custom Caffe
141-
We only modified some Caffe compilation flags and minor details. You can use your own Caffe distribution, these are the files we added and modified:
142-
143-
1. Added files: `install_caffe.sh`; as well as `Makefile.config.Ubuntu14.example`, `Makefile.config.Ubuntu16.example`, `Makefile.config.Ubuntu14_cuda_7.example` and `Makefile.config.Ubuntu16_cuda_7.example` (extracted from `Makefile.config.example`). Basically, you must enable cuDNN.
144-
2. Edited file: Makefile. Search for "# OpenPose: " to find the edited code. We basically added the C++11 flag to avoid issues in some old computers.
145-
3. Optional - deleted Caffe file: `Makefile.config.example`.
146-
4. In order to link it to OpenPose:
147-
1. Run `make all && make distribute` in your Caffe version.
148-
2. Open the OpenPose Makefile config file: `./Makefile.config.UbuntuX.example` (where X depends on your OS and CUDA version).
149-
3. Modify the Caffe folder directory variable (`CAFFE_DIR`) to your custom Caffe `distribute` folder location in the previous OpenPose Makefile config file.
150-
151-
152-
153139
## Standalone Face Or Hand Keypoint Detector
154140
In case of hand camera views at which the hands are visible but not the rest of the body, or if you do not need the body keypoint detector and want to considerably speed up the process, you can use the OpenPose face or hand keypoint detectors with your own face or hand detectors, rather than using the body keypoint detector as initial detector for those. More information in [doc/standalone_face_or_hand_keypoint_detector.md#faq](doc/standalone_face_or_hand_keypoint_detector.md#faq).
155141

doc/installation.md

Lines changed: 45 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,21 @@ OpenPose - Installation and FAQ
33

44
## Contents
55
1. [Requirements](#requirements)
6-
2. [Ubuntu](#ubuntu)
7-
3. [Windows](#windows)
8-
4. [OpenPose 3D Demo](#openpose-3d-demo)
9-
5. [FAQ](#faq)
6+
2. [Clone and Update the Repository](#clone-and-update-the-repository)
7+
3. [Ubuntu](#ubuntu)
8+
4. [Windows](#windows)
9+
5. [OpenPose 3D Demo](#openpose-3d-demo)
10+
6. [Custom Caffe](#custom-caffe)
11+
7. [FAQ](#faq)
1012

1113

1214

1315
## Requirements
14-
- Ubuntu (tested on 14 and 16) or Windows (tested on 10). We do not support any other OS but the community has been able to install it on: CentOS, Windows 7, and Windows 8.
16+
- Operating systems:
17+
- Ubuntu (tested on 14 and 16).
18+
- Windows (tested on 10).
19+
- Nvidia Jetson TX2, installation instructions in [doc/installation_jetson_tx2](./installation_jetson_tx2).
20+
- We do not officially support any other OS, but the community has been able to install it on: CentOS, Nvidia Jetson, Windows 7, and Windows 8.
1521
- NVIDIA graphics card with at least 1.6 GB available (the `nvidia-smi` command checks the available GPU memory in Ubuntu).
1622
- At least 2 GB of free RAM memory.
1723
- Highly recommended: A CPU with at least 8 cores.
@@ -22,6 +28,16 @@ Note: These requirements assume the default configuration (i.e. `--net_resolutio
2228

2329

2430

31+
## Clone and Update the Repository
32+
The first step is to clone the OpenPose repository. It might be done with [GitHub Desktop](https://desktop.github.com/) in Windows and from the terminal in Ubuntu:
33+
```bash
34+
git clone https://github.com/CMU-Perceptual-Computing-Lab/openpose
35+
```
36+
37+
OpenPose can be easily updated by clicking the `synchronization` button at the top-right part in GitHub Desktop in Windows, or by running `git pull origin master` in Ubuntu. After OpenPose has been updated, just run the `Reinstallation` section described below for your specific Operating System.
38+
39+
40+
2541
## Ubuntu
2642
### Installation - Script Compilation
2743
**Highly important**: This script only works with CUDA 8 and Ubuntu 14 or 16. Otherwise, check [Manual Compilation](#manual-compilation).
@@ -32,7 +48,7 @@ Note: These requirements assume the default configuration (i.e. `--net_resolutio
3248
4. In addition, OpenCV 3 does not incorporate the `opencv_contrib` module by default. Assuming you have OpenCV 3 compiled with the contrib module and you want to use it, append `opencv_contrib` at the end of the line `LIBRARIES += opencv_core opencv_highgui opencv_imgproc` in the `Makefile` file.
3349
5. Atlas can be installed with `sudo apt-get install libatlas-base-dev`. Instead of Atlas, you can use OpenBLAS or Intel MKL by modifying the line `BLAS := atlas` in the same way as previosuly mentioned for the OpenCV version selection.
3450
2. Build Caffe & the OpenPose library + download the required Caffe models for Ubuntu 14.04 or 16.04 (auto-detected for the script) and CUDA 8:
35-
```
51+
```bash
3652
bash ./ubuntu/install_caffe_and_openpose_if_cuda8.sh
3753
```
3854

@@ -64,7 +80,7 @@ Alternatively to the script installation, if you want to use CUDA 7, avoid using
6480
make all -j${number_of_cpus}
6581
```
6682
67-
NOTE: If you want to use your own Caffe distribution, follow the steps on `Custom Caffe` section and later re-compile the OpenPose library:
83+
NOTE: If you want to use your own Caffe distribution, follow the steps on [Custom Caffe](#custom-caffe) section and later re-compile the OpenPose library:
6884
```
6985
bash ./install_openpose_if_cuda8.sh
7086
```
@@ -83,7 +99,7 @@ If you updated some software that our library or 3rdparty use, or you simply wan
8399
```
84100
make clean && cd 3rdparty/caffe && make clean
85101
```
86-
2. Repeat the [Installation](#installation) steps.
102+
2. Repeat the [Installation](#installation) steps. You do not need to download the models again.
87103
88104
89105
@@ -136,6 +152,14 @@ You just need to remove the OpenPose or portable demo folder.
136152
137153
138154
155+
### Reinstallation
156+
If you updated some software that our library or 3rdparty use, or you simply want to reinstall it:
157+
1. Open the Visual Studio project sln file by double-cliking on `{openpose_path}\windows\OpenPose.sln`.
158+
2. Clean the OpenPose project by right-click on `Solution 'OpenPose'` and `Clean Solution`.
159+
3. Compile it and run it with F5 or the green play icon.
160+
161+
162+
139163
140164
141165
## Compiling without cuDNN
@@ -154,6 +178,19 @@ If you want to try our OpenPose 3-D reconstruction demo, see [doc/openpose_3d_re
154178
155179
156180
181+
## Custom Caffe
182+
We only modified some Caffe compilation flags and minor details. You can use your own Caffe distribution, these are the files we added and modified:
183+
184+
1. Added files: `install_caffe.sh`; as well as `Makefile.config.Ubuntu14.example`, `Makefile.config.Ubuntu16.example`, `Makefile.config.Ubuntu14_cuda_7.example` and `Makefile.config.Ubuntu16_cuda_7.example` (extracted from `Makefile.config.example`). Basically, you must enable cuDNN.
185+
2. Edited file: Makefile. Search for "# OpenPose: " to find the edited code. We basically added the C++11 flag to avoid issues in some old computers.
186+
3. Optional - deleted Caffe file: `Makefile.config.example`.
187+
4. In order to link it to OpenPose:
188+
1. Run `make all && make distribute` in your Caffe version.
189+
2. Open the OpenPose Makefile config file: `./Makefile.config.UbuntuX.example` (where X depends on your OS and CUDA version).
190+
3. Modify the Caffe folder directory variable (`CAFFE_DIR`) to your custom Caffe `distribute` folder location in the previous OpenPose Makefile config file.
191+
192+
193+
157194
158195
159196
## FAQ

doc/installation_jetson_tx2.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
OpenPose Library - Compilation and Installation on Nvidia Jetson TX2
1+
OpenPose - Installation on Nvidia Jetson TX2
22
====================================
3+
Note that OpenPose for Nvidia Jetson TX2 was developed and it is maintained by the community. The OpenPose authors will not be able to provide official support for it.
4+
35

46
## Contents
57
1. [Requirements](#requirements)
@@ -10,7 +12,7 @@ OpenPose Library - Compilation and Installation on Nvidia Jetson TX2
1012
## Requirements
1113
Jetson TX2 just flashed with [JetPack 3.1](https://developer.nvidia.com/embedded/jetpack)
1214

13-
Notes :
15+
Notes:
1416

1517
- Installation is similar to Jetson TX1 and you can follow this [video tutorial](https://www.youtube.com/watch?v=RJkOGMC8IrY).
1618
- If you are installing from a virtual machine host, installation may need to be done in two steps, please refer to [this solution](https://devtalk.nvidia.com/default/topic/1002081/jetson-tx2/jetpack-3-0-install-with-a-vm/).
@@ -23,6 +25,7 @@ Use the following script for installation of both caffe and OpenPose:
2325
./ubuntu/install_caffe_and_openpose_JetsonTX2_JetPack3.1.sh
2426
```
2527

28+
2629
## Usage
2730
It is for now recommended to use an external camera with the demo. To get to decent FPS you need to lower the net resolution:
2831
```

0 commit comments

Comments
 (0)