From 9846c821d5928fae804e7e90c15ab454d869dda8 Mon Sep 17 00:00:00 2001 From: Gines Hidalgo Date: Thu, 7 Jan 2021 23:28:20 -0500 Subject: [PATCH] GitHub template more strict & improved cuda-OP versioning doc Signed-off-by: Gines Hidalgo --- .github/issue_template.md | 22 +++++++++++++--------- doc/installation/README.md | 12 +++++++++--- doc/installation/prerequisites.md | 4 ++-- 3 files changed, 24 insertions(+), 14 deletions(-) diff --git a/.github/issue_template.md b/.github/issue_template.md index 8694ee72..a143d241 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -1,14 +1,18 @@ ### Posting rules -1. **Duplicated posts will not be answered**. Check the [FAQ](https://github.com/CMU-Perceptual-Computing-Lab/openpose/blob/master/doc/faq.md) section, other GitHub issues, and general documentation before posting. E.g., **low-speed, out-of-memory, output format, 0-people detected, installation issues, ...**). -2. **Fill** the **Your System Configuration section (all of it or it will not be answered!)** if you are facing an error or unexpected behavior. Feature requests or some other type of posts might not require it. +1. **No duplicated posts, only 1 new post opened a day, and up to 2 opened a week**. Otherwise, extrict user bans will occur. + - Check the [FAQ](https://github.com/CMU-Perceptual-Computing-Lab/openpose/blob/master/doc/faq.md) section, other GitHub issues, and general documentation before posting. E.g., **low-speed, out-of-memory, output format, 0-people detected, installation issues, ...**). + - Keep posting all your issues in the same post. + - No bans if you are unsure whether the post is duplicated! +2. **Fill all** the **Your System Configuration section** if you are facing an error or unexpected behavior. Some posts (e.g., feature requests) might not require it. 3. **No questions about training or 3rd party libraries**: - - OpenPose only implements testing. - - Caffe errors/issues, check [Caffe](http://caffe.berkeleyvision.org) documentation. - - CUDA check failed errors: They are usually fixed by re-installing CUDA, then re-installing the proper cuDNN version, and then re-compiling (or re-installing) OpenPose. Otherwise, check for help in CUDA forums. - - OpenCV errors: Install the default/pre-compiled OpenCV or check for online help. -4. Set a **proper issue title**: add the Ubuntu/Windows keyword and be specific (e.g., do not call it: `Error`). + - OpenPose only implements testing. For training, check [OpenPose train](https://github.com/CMU-Perceptual-Computing-Lab/openpose_train). + - Caffe errors/issues: Check [Caffe](http://caffe.berkeleyvision.org) documentation. + - CUDA/cuDNN check failed errors: They are usually fixed by re-installing CUDA, then re-installing the proper cuDNN version, then rebooting, and then re-installing OpenPose. Otherwise, check Nvidia/CUDA/cuDNN forums. + - OpenCV errors: Install the default/pre-compiled OpenCV or check for OpenCV online help. +4. Set a **proper issue title**: Add the OS (Ubuntu, Windows) and be specific (e.g., do not call it: `Error`). 5. Only English comments. -Posts which do not follow these rules will be **ignored, closed, or reported** with no further clarification. +6. Remove these posting rules from your post but follow them! +Posts which do not follow these rules will be **ignored/deleted** and those **users banned** with no further clarification. @@ -30,7 +34,7 @@ Note: add `--logging_level 0 --disable_multi_thread` to get higher debug informa ### Type of Issue -You might select multiple topics, delete the rest: +Select the topic(s) on your post, delete the rest: - Compilation/installation error - Execution error - Help wanted diff --git a/doc/installation/README.md b/doc/installation/README.md index 28da05dd..c95cc136 100644 --- a/doc/installation/README.md +++ b/doc/installation/README.md @@ -182,9 +182,13 @@ cd 3rdparty/caffe; git apply ../../scripts/osx/mac_opencl_patch.txt #### Windows In order to build the project, select and run only one of the 2 following alternatives. -1. **CMake-GUI alternative (recommended)**: Open the Visual Studio solution (Windows) by clicking in `Open Project` in CMake (or alternatively `build/OpenPose.sln`). Then, set the configuration from `Debug` to `Release` and press F7 (or `Build`, `Build Solution`). After it has compiled, and if you have a webcam, you can press the green triangle icon (alternatively F5) to run OpenPose with the default settings on the webcam. +- **CMake-GUI alternative (recommended)**: + 1. Open the Visual Studio solution (Windows) by clicking in `Open Project` in CMake (or alternatively `build/OpenPose.sln`). Then, set the configuration from `Debug` to `Release`. + 2. Press F7 (or `Build` menu and click on `Build Solution`). + 3. **Important for Python version**: Make sure not to skip step 2, it is not enough to click on F5 (Run), you must also `Build Solution` for the Python bindings to be generated. + 4. After it has compiled, and if you have a webcam, you can press the green triangle icon (alternatively F5) to run the OpenPose demo with the default settings on the webcam. -2. Command-line build alternative (not recommended). NOTE: The command line alternative is not officially supported, but it was added in [GitHub issue #1198](https://github.com/CMU-Perceptual-Computing-Lab/openpose/issues/1198). For any questions or bug report about this command-line version, comment in that GitHub issue. +- Command-line build alternative (not recommended). NOTE: The command line alternative is not officially supported, but it was added in [GitHub issue #1198](https://github.com/CMU-Perceptual-Computing-Lab/openpose/issues/1198). For any questions or bug report about this command-line version, comment in that GitHub issue. 1. Run "MSVS 2019 Developer Command Console" ```batch openpose\mkdir build @@ -236,7 +240,9 @@ If you do not want to use the Windows portable binaries nor compile it from sour - [Dockerfile - OpenPose v1.4.0, OpenCV, CUDA 8, CuDNN 6, Python2.7](https://gist.github.com/moiseevigor/11c02c694fc0c22fccd59521793aeaa6). - [Dockerfile - OpenPose v1.2.1](https://gist.github.com/sberryman/6770363f02336af82cb175a83b79de33). -- [Google Colab helper script](https://github.com/CMU-Perceptual-Computing-Lab/openpose/issues/949#issue-387855863): Script to install OpenPose on Google Colab. Really useful when access to a computer powerful enough to run OpenPose is not possible, so one possible way to use OpenPose is to build it on a GPU-enabled Colab runtime and then run the programs there. For questions and more details, read and post ONLY on [issue thread #949](https://github.com/CMU-Perceptual-Computing-Lab/openpose/issues/949). +- Google Colab helper scripts: Script to install OpenPose on Google Colab. Really useful when access to a computer powerful enough to run OpenPose is not possible, so one possible way to use OpenPose is to build it on a GPU-enabled Colab runtime and then run the programs there. + - [Google Colab 1/2](https://github.com/CMU-Perceptual-Computing-Lab/openpose/issues/1736#issuecomment-736846794): For questions and more details, read and post ONLY on [issue thread #1736](https://github.com/CMU-Perceptual-Computing-Lab/openpose/issues/1736). + - [Google Colab 2/2](https://github.com/CMU-Perceptual-Computing-Lab/openpose/issues/949#issue-387855863): For questions and more details, read and post ONLY on [issue thread #949](https://github.com/CMU-Perceptual-Computing-Lab/openpose/issues/949). diff --git a/doc/installation/prerequisites.md b/doc/installation/prerequisites.md index ae01fe0d..980021a7 100644 --- a/doc/installation/prerequisites.md +++ b/doc/installation/prerequisites.md @@ -36,7 +36,7 @@ These tips are **very important** and avoid many bugs: - Assuming your CMake downloaded folder is in {CMAKE_FOLDER_PATH}, everytime these instructions mentions `cmake-gui`, you will have to replace that line by `{CMAKE_FOLDER_PATH}/bin/cmake-gui`. - Ubuntu 14 or 16: Run the command `sudo apt-get install cmake-qt-gui`. Note: If you prefer to use CMake through the command line, see [doc/installation/README.md#CMake-Command-Line-Configuration-(Ubuntu-Only)](README.md#cmake-command-line-configuration-ubuntu-only). 3. Nvidia GPU version prerequisites: - 1. **Note: OpenPose has been tested extensively with CUDA 11 for Ubuntu 20, CUDA 10.1 (cuDNN 7.5.1) for Ubuntu 18, and CUDA 8.0 (cuDNN 5.1) for Ubuntu 14 and 16.**. We highly recommend using those versions for those Operating Systems to minimize potential installation issues. Other versions should also work, but we do not provide support about any CUDA/cuDNN installation/compilation issue, as well as problems related to their integration into OpenPose. + 1. **Note: OpenPose has been tested extensively with CUDA 11.1.1 (cuDNN 8.0.5) for Ubuntu 20**. Older OpenPose versions (v1.6.X and v1.5.X) were tested with **CUDA 10.1 (cuDNN 7.5.1) for Ubuntu 18 and CUDA 8.0 (cuDNN 5.1) for Ubuntu 14 and 16**. We highly recommend using those combinations to minimize potential installation issues. Other combinations should also work, but we do not provide any support about installation/compilation issues related to CUDA/cuDNN or their integration with OpenPose. 2. Upgrade your Nvidia drivers to the latest version. 3. **CUDA**: - Ubuntu 20 ([**CUDA 11.1**](https://developer.nvidia.com/cuda-downloads)): Download CUDA 11.1 from their [official website](https://developer.nvidia.com/cuda-downloads). Most Ubuntu computers use the `Architecture` named `x86_64`, and we personally recommend the `Installer Type` named `runfile (local)`. Then, follow the Nvidia website installation instructions. When installing, make sure to enable the symbolic link in `usr/local/cuda` to minimize potential future errors. @@ -86,7 +86,7 @@ NOTE: These instructions are only required when compiling OpenPose brom source. - Different VS versions: - If **Visual Studio 2019 Community** (or 2017) is desired, we do not officially support it, but it should run similarly to VS 2017/2019 Enterprise. 3. Nvidia GPU version prerequisites: - 1. **Note: OpenPose has been tested extensively with CUDA 11.1.1 / cuDNN 8.0.5 for VS2019, CUDA 10.1 / cuDNN 7.5.1 for VS2017, and CUDA 8.0 / cuDNN 5.1 for VS 2015**. We highly recommend using those versions to minimize potential installation issues. Other versions should also work, but we do not provide support about any CUDA/cuDNN installation/compilation issue, as well as problems related to their integration into OpenPose. + 1. **Note: OpenPose has been tested extensively with CUDA 11.1.1 (cuDNN 8.0.5) for VS2019**. Older OpenPose versions (v1.6.X and v1.5.X) were tested with **CUDA 10.1 (cuDNN 7.5.1) for VS2017 and CUDA 8.0 (cuDNN 5.1) for VS2015**. We highly recommend using those combinations to minimize potential installation issues. Other combinations should also work, but we do not provide any support about installation/compilation issues related to CUDA/cuDNN or their integration with OpenPose. 2. Upgrade your Nvidia drivers to the latest version (in the Nvidia "GeForce Experience" software or its [website](https://www.nvidia.com/Download/index.aspx)). 3. Install one out of [**CUDA 11.1**](https://developer.nvidia.com/cuda-downloads), [**CUDA 10.1**](https://developer.nvidia.com/cuda-10.1-download-archive-base), or [**CUDA 8**](https://developer.nvidia.com/cuda-80-ga2-download-archive): - Install CUDA 11.1/10.0/8.0 after Visual Studio 2019/2017/2015 is installed to assure that the CUDA installation will generate all necessary files for VS. If CUDA was installed before installing VS, then re-install CUDA. -- GitLab