Skip to content

Commit d066b09

Browse files
Improved GitHub pages & fixed some typos in there
Signed-off-by: Gines Hidalgo <[email protected]>
1 parent 8513287 commit d066b09

33 files changed

+460
-224
lines changed

.github/CI_deprecated/Readme_Travis_badges_table_and_backup_instructions.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
In order to recover Travis:
22
1. Uncomment all the lines of code in ".travis.yml" and move it back to the main folder (e.g., at the same level than the global README.md and CMakeLists.txt files).
33
2. Re-add the table of badges in the README.md:
4+
45
| |`Default Config` |`CUDA (+Python)` |`CPU (+Python)` |`OpenCL (+Python)`| `Debug` | `Unity` |
56
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
67
| **`Linux`** | [![Status](https://travis-matrix-badges.herokuapp.com/repos/CMU-Perceptual-Computing-Lab/openpose/branches/master/1)](https://travis-ci.org/CMU-Perceptual-Computing-Lab/openpose) | [![Status](https://travis-matrix-badges.herokuapp.com/repos/CMU-Perceptual-Computing-Lab/openpose/branches/master/2)](https://travis-ci.org/CMU-Perceptual-Computing-Lab/openpose) | [![Status](https://travis-matrix-badges.herokuapp.com/repos/CMU-Perceptual-Computing-Lab/openpose/branches/master/3)](https://travis-ci.org/CMU-Perceptual-Computing-Lab/openpose) | [![Status](https://travis-matrix-badges.herokuapp.com/repos/CMU-Perceptual-Computing-Lab/openpose/branches/master/4)](https://travis-ci.org/CMU-Perceptual-Computing-Lab/openpose) | [![Status](https://travis-matrix-badges.herokuapp.com/repos/CMU-Perceptual-Computing-Lab/openpose/branches/master/5)](https://travis-ci.org/CMU-Perceptual-Computing-Lab/openpose) | [![Status](https://travis-matrix-badges.herokuapp.com/repos/CMU-Perceptual-Computing-Lab/openpose/branches/master/6)](https://travis-ci.org/CMU-Perceptual-Computing-Lab/openpose) |

.github/Logo_doxygen_black.png

8.58 KB
Loading

.github/issue_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,4 @@ Select the topic(s) on your post, delete the rest:
8282
- Portable demo or compiled library?
8383

8484
10. If **speed performance** issue:
85-
- Report OpenPose timing speed based on [this link](https://github.com/CMU-Perceptual-Computing-Lab/openpose/blob/master/doc/speed_up_openpose.md#profiling-speed).
85+
- Report OpenPose timing speed based on [this link](https://github.com/CMU-Perceptual-Computing-Lab/openpose/blob/master/doc/maximizing_openpose_speed.md#profiling-speed).

.github/workflows/main.yml

-2
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,6 @@ jobs:
5151
WITH_CUDNN: false
5252
WITH_PYTHON: true
5353
CI_OS_NAME: linux
54-
CI_BUILD_NUMBER: ${{ github.run_number }}
55-
CI_COMMIT: ${{ github.sha }}
5654
DOCS: true
5755
# Ubuntu 20.04 - Python - CMake - CPU
5856
- os: ubuntu-20.04

.gitignore

-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@
3232
*.sst
3333
*.ldb
3434
LOCK
35-
LOG*
3635
CURRENT
3736
MANIFEST-*
3837

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@
1010

1111
[**OpenPose**](https://github.com/CMU-Perceptual-Computing-Lab/openpose) has represented the **first real-time multi-person system to jointly detect human body, hand, facial, and foot keypoints (in total 135 keypoints) on single images**.
1212

13-
It is **authored by [Gines Hidalgo](https://www.gineshidalgo.com), [Zhe Cao](https://people.eecs.berkeley.edu/~zhecao), [Tomas Simon](http://www.cs.cmu.edu/~tsimon), [Shih-En Wei](https://scholar.google.com/citations?user=sFQD3k4AAAAJ&hl=en), [Hanbyul Joo](https://jhugestar.github.io), and [Yaser Sheikh](http://www.cs.cmu.edu/~yaser)**, and **maintained by [Gines Hidalgo](https://www.gineshidalgo.com) and [Yaadhav Raaj](https://www.raaj.tech)**. OpenPose would not be possible without the [**CMU Panoptic Studio dataset**](http://domedb.perception.cs.cmu.edu). We would also like to thank all the people who helped OpenPose in any way ([doc/contributors.md](doc/contributors.md)).
13+
It is **authored by [Ginés Hidalgo](https://www.gineshidalgo.com), [Zhe Cao](https://people.eecs.berkeley.edu/~zhecao), [Tomas Simon](http://www.cs.cmu.edu/~tsimon), [Shih-En Wei](https://scholar.google.com/citations?user=sFQD3k4AAAAJ&hl=en), [Hanbyul Joo](https://jhugestar.github.io), and [Yaser Sheikh](http://www.cs.cmu.edu/~yaser)**, and **maintained by [Ginés Hidalgo](https://www.gineshidalgo.com) and [Yaadhav Raaj](https://www.raaj.tech)**. OpenPose would not be possible without the [**CMU Panoptic Studio dataset**](http://domedb.perception.cs.cmu.edu). We would also like to thank all the people who helped OpenPose in any way ([doc/authors_and_contributors.md](doc/authors_and_contributors.md)).
1414

1515

1616

1717
<p align="center">
1818
<img src=".github/media/pose_face_hands.gif", width="480">
1919
<br>
20-
<sup>Authors <a href="https://www.gineshidalgo.com" target="_blank">Gines Hidalgo</a> (left) and <a href="https://jhugestar.github.io" target="_blank">Hanbyul Joo</a> (right) in front of the <a href="http://domedb.perception.cs.cmu.edu" target="_blank">CMU Panoptic Studio</a></sup>
20+
<sup>Authors <a href="https://www.gineshidalgo.com" target="_blank">Ginés Hidalgo</a> (left) and <a href="https://jhugestar.github.io" target="_blank">Hanbyul Joo</a> (right) in front of the <a href="http://domedb.perception.cs.cmu.edu" target="_blank">CMU Panoptic Studio</a></sup>
2121
</p>
2222

2323

@@ -54,7 +54,7 @@ It is **authored by [Gines Hidalgo](https://www.gineshidalgo.com), [Zhe Cao](htt
5454
<img src=".github/media/pose_face.gif", width="360">
5555
<img src=".github/media/pose_hands.gif", width="360">
5656
<br>
57-
<sup>Authors <a href="https://www.gineshidalgo.com" target="_blank">Gines Hidalgo</a> (left image) and <a href="http://www.cs.cmu.edu/~tsimon" target="_blank">Tomas Simon</a> (right image) testing OpenPose</sup>
57+
<sup>Authors <a href="https://www.gineshidalgo.com" target="_blank">Ginés Hidalgo</a> (left image) and <a href="http://www.cs.cmu.edu/~tsimon" target="_blank">Tomas Simon</a> (right image) testing OpenPose</sup>
5858
</p>
5959

6060
### Unity Plugin
@@ -63,7 +63,7 @@ It is **authored by [Gines Hidalgo](https://www.gineshidalgo.com), [Zhe Cao](htt
6363
<img src=".github/media/unity_body_foot.png", width="240">
6464
<img src=".github/media/unity_hand_face.png", width="240">
6565
<br>
66-
<sup><a href="http://tianyizhao.com" target="_blank">Tianyi Zhao</a> and <a href="https://www.gineshidalgo.com" target="_blank">Gines Hidalgo</a> testing the <a href="https://github.com/CMU-Perceptual-Computing-Lab/openpose_unity_plugin" target="_blank">OpenPose Unity Plugin</a></sup>
66+
<sup><a href="http://tianyizhao.com" target="_blank">Tianyi Zhao</a> and <a href="https://www.gineshidalgo.com" target="_blank">Ginés Hidalgo</a> testing the <a href="https://github.com/CMU-Perceptual-Computing-Lab/openpose_unity_plugin" target="_blank">OpenPose Unity Plugin</a></sup>
6767
</p>
6868

6969
### Runtime Analysis
@@ -94,7 +94,7 @@ We show an inference time comparison between the 3 available pose estimation lib
9494
- [**Command-line demo**](doc/demo_quick_start.md) for built-in functionality.
9595
- [**C++ API**](examples/tutorial_api_cpp/) and [**Python API**](doc/python_api.md) for custom functionality. E.g., adding your custom inputs, pre-processing, post-posprocessing, and output steps.
9696

97-
For further details, check [all released features](doc/released_features.md) and [release notes](doc/release_notes.md).
97+
For further details, check the [major released features](doc/major_released_features.md) and [release notes](doc/release_notes.md) docs.
9898

9999

100100

doc/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose - Quick Start
1+
OpenPose Doc
22
==========================
33

44
Most users can simply use the OpenPose Demo without reading any C++/Python code. Users that need to add additional functionality (new inputs, outputs, etc) should check the C++/Python APIs:
@@ -25,7 +25,7 @@ bin\OpenPoseDemo.exe --video examples\media\video.avi --face --hand --write_json
2525
- You should be familiar with the [**OpenPose Demo**](demo_quick_start.md) and the main OpenPose flags before trying to read the C++ or Python API examples. Otherwise, it will be way harder to follow.
2626
- For quick prototyping: You can simply duplicate and rename any of the [existing example files](../examples/tutorial_api_python/) within that same folder.
2727

28-
- [**Speeding up OpenPose and benchmark**](speed_up_openpose.md): Check the OpenPose Benchmark as well as some hints to speed up and/or reduce the memory requirements for OpenPose.
28+
- [**Speeding up OpenPose and benchmark**](maximizing_openpose_speed.md): Check the OpenPose Benchmark as well as some hints to speed up and/or reduce the memory requirements for OpenPose.
2929

3030
- [**Calibration toolbox**](advanced/calibration_module.md) and [**3D OpenPose**](advanced/3d_reconstruction_module.md): Calibrate your cameras for 3D OpenPose (or any other stereo vision tasks) and start obtaining 3D keypoints!
3131

doc/advanced/3d_reconstruction_module.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose 3-D Reconstruction Module and Demo
1+
OpenPose Doc - Advanced Doc - OpenPose 3-D Reconstruction Module and Demo
22
=============================================
33

44
## Contents

doc/advanced/calibration_module.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose Calibration Module and Demo
1+
OpenPose Doc - Advanced Doc - OpenPose Calibration Module and Demo
22
=============================================
33

44
## Contents

doc/advanced/deployment.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Deploying OpenPose (Exporting OpenPose to Other Projects)
1+
OpenPose Doc - Advanced Doc - Deploying OpenPose (Exporting OpenPose to Other Projects)
22
==========================
33

44
## Contents

doc/advanced/library_structure/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose C++ API - Introduction
1+
OpenPose Doc - Advanced Doc - Library Structure
22
====================================
33

44
As a user, you do not need to know anything about this section! This section is intended for OpenPose internal developpers. It is exposed publicly, but you can skip this whole folder if you are just trying to use OpenPose or create new code/demos using OpenPose.

doc/advanced/library_structure/library_add_new_module.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose - Steps to Add a New Module
1+
OpenPose Doc - Advanced Doc - Library Structure - Steps to Add a New Module
22
====================================
33

44
## Developing Steps

doc/advanced/library_structure/library_extend_functionality.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose - How to Develop OpenPose
1+
OpenPose Doc - Advanced Doc - Library Structure - How to Extend Functionality
22
====================================
33

44
If you intend to extend the functionality of our library:

doc/advanced/library_structure/library_how_to_develop.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose C++ API - How to Develop OpenPose
1+
OpenPose Doc - Advanced Doc - Library Structure - How to Develop OpenPose
22
======================================================
33

44

doc/advanced/library_structure/library_overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose C++ API - Basic Overview
1+
OpenPose Doc - Advanced Doc - Library Structure - Basic Overview
22
====================================
33

44

doc/advanced/standalone_face_or_hand_keypoint_detector.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose - Standalone Face Or Hand Keypoint Detector
1+
OpenPose Doc - Advanced Doc - Standalone Face Or Hand Keypoint Detector
22
====================================
33

44
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 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.

doc/contributors.md renamed to doc/authors_and_contributors.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
OpenPose - Authors and Contributors
1+
OpenPose Doc - Authors and Contributors
22
====================================
33

44

55

66
### Authors
7-
OpenPose is authored by [Gines Hidalgo](https://www.gineshidalgo.com/), [Zhe Cao](http://www.andrew.cmu.edu/user/zhecao), [Tomas Simon](http://www.cs.cmu.edu/~tsimon/), [Shih-En Wei](https://scholar.google.com/citations?user=sFQD3k4AAAAJ&hl=en), [Hanbyul Joo](http://www.cs.cmu.edu/~hanbyulj/), and [Yaser Sheikh](http://www.cs.cmu.edu/~yaser/).
8-
9-
The body pose estimation work is based on the following and original 2 repositories: [CVPR 2017 repository](https://github.com/ZheC/Multi-Person-Pose-Estimation) and [ECCV 2016 repository](https://github.com/CMU-Perceptual-Computing-Lab/caffe_rtpose).
7+
OpenPose is authored by [Ginés Hidalgo](https://www.gineshidalgo.com/), [Zhe Cao](http://www.andrew.cmu.edu/user/zhecao), [Tomas Simon](http://www.cs.cmu.edu/~tsimon/), [Shih-En Wei](https://scholar.google.com/citations?user=sFQD3k4AAAAJ&hl=en), [Hanbyul Joo](http://www.cs.cmu.edu/~hanbyulj/), and [Yaser Sheikh](http://www.cs.cmu.edu/~yaser/). The body pose estimation work is based on the following and original 2 repositories: [CVPR 2017 repository](https://github.com/ZheC/Multi-Person-Pose-Estimation) and [ECCV 2016 repository](https://github.com/CMU-Perceptual-Computing-Lab/caffe_rtpose).
108

119

1210

doc/demo_not_quick_start.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose Demo - Not Quick Start
1+
OpenPose Doc - Demo - Not Quick Start
22
====================================
33

44
This document is a more detailed continuation of [doc/demo_quick_start.md](demo_quick_start.md), and it assumes the user is quite familiar with the OpenPose demo and the contents of [doc/demo_quick_start.md](demo_quick_start.md).

doc/demo_quick_start.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose Demo - Quick Start
1+
OpenPose Doc - Demo - Quick Start
22
====================================
33

44
Forget about the OpenPose code, just download the portable Windows binaries (or compile the code from source) and use the demo by following this tutorial!

doc/faq.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose - Frequently Asked Question (FAQ)
1+
OpenPose Doc - Frequently Asked Question (FAQ)
22
============================================
33

44
## Contents
@@ -207,26 +207,26 @@ git submodule update --init --recursive --remote
207207
#### Speed Up, Memory Reduction, and Benchmark
208208
**Q: Low speed** - OpenPose is quite slow, is it normal? How can I speed it up?
209209

210-
**A**: Check [doc/speed_up_openpose.md](speed_up_openpose.md) to discover the approximate speed of your graphics card and some speed tips.
210+
**A**: Check [doc/maximizing_openpose_speed.md](maximizing_openpose_speed.md) to discover the approximate speed of your graphics card and some speed tips.
211211

212212

213213

214214
#### How to Measure the Latency Time?
215215
**Q: How to measure/calculate/estimate the latency/lag time?**
216216

217-
**A**: [Profile](https://github.com/CMU-Perceptual-Computing-Lab/openpose/blob/master/doc/speed_up_openpose.md#profiling-speed) the OpenPose speed. For 1-GPU or CPU-only systems (use `--disable_multi_thread` for simplicity in multi-GPU systems for latency measurement), the latency will be roughly the sum of all the reported measurements.
217+
**A**: [Profile](https://github.com/CMU-Perceptual-Computing-Lab/openpose/blob/master/doc/maximizing_openpose_speed.md#profiling-speed) the OpenPose speed. For 1-GPU or CPU-only systems (use `--disable_multi_thread` for simplicity in multi-GPU systems for latency measurement), the latency will be roughly the sum of all the reported measurements.
218218

219219

220220

221221
#### CPU Version Too Slow
222222
**Q: The CPU version is insanely slow compared to the GPU version.**
223223

224-
**A**: Check [doc/speed_up_openpose.md#cpu-version](speed_up_openpose.md#cpu-version) to discover the approximate speed and some speed tips.
224+
**A**: Check [doc/maximizing_openpose_speed.md#cpu-version](maximizing_openpose_speed.md#cpu-version) to discover the approximate speed and some speed tips.
225225

226226

227227

228228
#### Profiling Speed and Estimating FPS without Display
229-
Check the [doc/speed_up_openpose.md#profiling-speed](speed_up_openpose.md#profiling-speed) section.
229+
Check the [doc/maximizing_openpose_speed.md#profiling-speed](maximizing_openpose_speed.md#profiling-speed) section.
230230

231231

232232

doc/installation/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose - Installation
1+
OpenPose Doc - Installation
22
==========================
33

44
## Contents
@@ -132,7 +132,7 @@ cmake-gui ..
132132

133133
5. Set the `GPU_MODE` flag to the proper value and click `Configure` again:
134134
1. If your machine has an Nvidia GPU, you should most probably not modify this flag and skip this step. Cases in which you might have to change it:
135-
- If you have a Nvidia GPU with 2GB of memory or less: Then you will have to follow some of the tricks in [doc/speed_up_openpose.md](../speed_up_openpose.md) or change `GPU_MODE` back to `CPU_ONLY`.
135+
- If you have a Nvidia GPU with 2GB of memory or less: Then you will have to follow some of the tricks in [doc/maximizing_openpose_speed.md](../maximizing_openpose_speed.md) or change `GPU_MODE` back to `CPU_ONLY`.
136136
- If you cannot install CUDA, then you can also set `GPU_MODE` to `CPU_ONLY`.
137137
2. Mac OSX and machines with a non-Nvidia GPU (Intel or AMD GPUs): Set the `GPU_MODE` flag to `CPU_ONLY` (easier to install but slower runtime) or `OPENCL` (GPU-accelerated, it is harder to install but provides a faster runtime speed). For more details on OpenCV support, see [doc/prerequisites.md](prerequisites.md) and [OpenCL Version](#opencl-version).
138138
3. If your machine does not have any GPU, set the `GPU_MODE` flag to `CPU_ONLY`.
@@ -276,7 +276,7 @@ See [doc/advanced/deployment.md](../advanced/deployment.md).
276276
277277
278278
### Maximum Speed
279-
Check the OpenPose Benchmark as well as some hints to speed up and/or reduce the memory requirements to run OpenPose on [doc/speed_up_openpose.md](../speed_up_openpose.md).
279+
Check the OpenPose Benchmark as well as some hints to speed up and/or reduce the memory requirements to run OpenPose on [doc/maximizing_openpose_speed.md](../maximizing_openpose_speed.md).
280280
281281
282282
@@ -297,7 +297,7 @@ export MKL_NUM_THREADS="8"
297297
export OMP_NUM_THREADS="8"
298298
```
299299

300-
Increasing the number of threads results in a higher RAM memory usage. You can check the [doc/speed_up_openpose.md](../speed_up_openpose.md) for more information about speed and memory requirements in several CPUs and GPUs.
300+
Increasing the number of threads results in a higher RAM memory usage. You can check the [doc/maximizing_openpose_speed.md](../maximizing_openpose_speed.md) for more information about speed and memory requirements in several CPUs and GPUs.
301301

302302

303303

doc/installation/deprecated/installation_deprecated.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose - Installation (deprecated)
1+
OpenPose Doc - Installation (deprecated)
22
======================================
33

44
## Contents

doc/installation/jetson_tx/installation_jetson_tx1.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose - Installation on Nvidia Jetson TX1
1+
OpenPose Doc - Installation - Installation on Nvidia Jetson TX1
22
====================================
33
## Introduction
44
We do not officially support TX1, but thanks to @dreinsdo, we have these instructions about how he made it work in his TX1. We would like to thank @dreinsdo, who added this documentation in [this GitHub issue post](https://github.com/CMU-Perceptual-Computing-Lab/openpose/issues/1124#issuecomment-474090671). If you face any issue, feel free to post on that issue post.

doc/installation/jetson_tx/installation_jetson_tx2_jetpack3.1.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose - Installation on Nvidia Jetson TX2
1+
OpenPose Doc - Installation - Installation on Nvidia Jetson TX2 JetPack 3.1
22
====================================
33
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.
44

doc/installation/jetson_tx/installation_jetson_tx2_jetpack3.3.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose - Installation on Nvidia Jetson TX2
1+
OpenPose Doc - Installation - Installation on Nvidia Jetson TX2 JetPack 3.3
22
====================================
33
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.
44

doc/installation/prerequisites.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose - Prerequisites
1+
OpenPose Doc - Installation - Prerequisites
22
==========================
33

44
## Contents

doc/released_features.md renamed to doc/major_released_features.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
OpenPose - All Major Released Features
1+
OpenPose Doc - Major Released Features
22
====================================
33

44
- Nov 2020: [**Python API improved and included on Windows portable binaries**](https://github.com/CMU-Perceptual-Computing-Lab/openpose/releases)!

0 commit comments

Comments
 (0)