update readme and changelog for panoptic (open-mmlab#158)

wjkim81 · Sep 27, 2020 · ebb92f7 · ebb92f7
1 parent 6ff6450
commit ebb92f7
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -80,6 +80,7 @@ Supported datasets:
 - [x] [CrowdPose](https://github.com/Jeff-sjtu/CrowdPose)
 - [x] [OneHand10K](https://www.yangangwang.com/papers/WANG-MCC-2018-10.html)
 - [x] [FreiHand](https://lmb.informatik.uni-freiburg.de/projects/freihand/)
+- [x] [CMU Panoptic HandDB](http://domedb.perception.cs.cmu.edu/handdb.html)
 
 Results and models are available in the *README.md* of each method's config directory.
 A summary can be found in the [**model zoo**](https://mmpose.readthedocs.io/en/latest/top_down_models.html) page.

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -12,13 +12,15 @@
 
 3. Support more 2d hand keypoint estimation datasets.
 - [Frei-hand](https://lmb.informatik.uni-freiburg.de/projects/freihand/)
+- [CMU Panoptic HandDB](http://domedb.perception.cs.cmu.edu/handdb.html)
 
 4. Support hand demo.
 
 
  **New Features**
 - Support [COCO-WholeBody](https://github.com/jin-s13/COCO-WholeBody) dataset ([#133](https://github.com/open-mmlab/mmpose/pull/133)).
 - Support [Frei-hand](https://lmb.informatik.uni-freiburg.de/projects/freihand/) dataset ([#125](https://github.com/open-mmlab/mmpose/pull/125)).
+- Support [CMU Panoptic HandDB](http://domedb.perception.cs.cmu.edu/handdb.html) dataset ([#144](https://github.com/open-mmlab/mmpose/pull/144)).
 - Support ShuffleNetv2 ([#139](https://github.com/open-mmlab/mmpose/pull/139)).
 - Support saving best models based on key indicator ([#127](https://github.com/open-mmlab/mmpose/pull/127)).
 

diff --git a/docs/data_preparation.md b/docs/data_preparation.md
@@ -14,6 +14,7 @@ MMPose supported datasets:
 - [CrowdPose](https://github.com/Jeff-sjtu/CrowdPose)
 - [OneHand10K](https://www.yangangwang.com/papers/WANG-MCC-2018-10.html)
 - [FreiHand](https://lmb.informatik.uni-freiburg.de/projects/freihand/)
+- [CMU Panoptic HandDB](http://domedb.perception.cs.cmu.edu/handdb.html)
 
 ## COCO
 
@@ -289,3 +290,41 @@ mmpose
                 |── 00000001.jpg
                  ...
 ```
+
+## CMU Panoptic HandDB
+
+For CMU Panoptic HandDB, please download from [CMU Panoptic HandDB](http://domedb.perception.cs.cmu.edu/handdb.html).
+Following [Simon et al](https://arxiv.org/abs/1704.07809), panoptic images (hand143_panopticdb) and MPII & NZSL training sets (manual_train) are used for training, while MPII & NZSL test set (manual_test) for testing.
+Please download the annotation files from [panoptic_annotations](https://download.openmmlab.com/mmpose/datasets/panoptic_annotations.tar).
+Extract them under {MMPose}/data, and make them look like this:
+
+```
+mmpose
+├── mmpose
+├── docs
+├── tests
+├── tools
+├── configs
+`── data
+    │── panoptic
+        |── annotations
+        |   |── panoptic_train.json
+        |   |── panoptic_test.json
+        |
+        `── hand143_panopticdb
+        |   |── imgs
+        |   |   |── 00000000.jpg
+        |   |   |── 00000001.jpg
+        |   |    ...
+        |
+        `── hand_labels
+            |── manual_train
+            |   |── 000015774_01_l.jpg
+            |   |── 000015774_01_r.jpg
+            |    ...
+            |
+            `── manual_test
+                |── 000648952_02_l.jpg
+                |── 000835470_01_l.jpg
+                 ...
+```
diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -16,6 +16,7 @@ MMPose supported datasets:
 - [CrowdPose](https://github.com/Jeff-sjtu/CrowdPose)
 - [OneHand10K](https://www.yangangwang.com/papers/WANG-MCC-2018-10.html)
 - [FreiHand](https://lmb.informatik.uni-freiburg.de/projects/freihand/)
+- [CMU Panoptic HandDB](http://domedb.perception.cs.cmu.edu/handdb.html)
 
 Please follow [DATA Preparation](data_preparation.md) to prepare the data.