Improve dataset card: add task categories, code link, and usage instructions

#3
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +36 -8
README.md CHANGED
@@ -1,14 +1,20 @@
1
  ---
2
  license: mit
3
- pretty_name: PartImageNet++
4
- viewer: false
 
5
  size_categories:
6
  - 100K<n<1M
 
 
7
  ---
 
8
  ## PartImageNet++ Dataset
9
 
10
- PartImageNet++ is an extensive dataset designed for robust object recognition and segmentation tasks. This dataset expands upon the original ImageNet dataset by providing detailed part annotations for each object category.
11
- Official repository for [PartImageNet++ Dataset: Scaling up Part-based Models for Robust Recognition](https://huggingface.co/papers/2407.10918).
 
 
12
 
13
  ### Dataset Statistics
14
 
@@ -18,6 +24,27 @@ The dataset includes:
18
  - **100,000 annotated images**, with each object category containing 100 images (downloaded from the ImageNet-1K dataset).
19
  - **406,364 part mask annotations** ensuring comprehensive coverage and detailed segmentation.
20
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
21
  ### Structure and Contents
22
 
23
  Each JSON file in the `json` directory represents one object category and its corresponding part annotations.
@@ -26,14 +53,15 @@ The `including` folder provides detailed inclusion relations of parts, illustrat
26
 
27
  The `discarded_data.json` file lists low-quality images excluded from the dataset to maintain high annotation standards.
28
 
29
- The category_name.json file contains each JSON file's file name, along with its corresponding part name and object name.
30
 
31
  ### Visualizations
32
 
33
  We provide a visualization demo tool to explore and inspect the annotations. This tool helps users better understand the dataset's structure and details.
34
 
35
- ### If you find this useful in your research, please cite this work:
36
- ```
 
37
  @inproceedings{li2024pinpp,
38
  author = {Li, Xiao and Liu, Yining and Dong, Na and Qin, Sitian and Hu, Xiaolin},
39
  title = {PartImageNet++ Dataset: Scaling up Part-based Models for Robust Recognition},
@@ -41,4 +69,4 @@ We provide a visualization demo tool to explore and inspect the annotations. Thi
41
  year = {2024},
42
  organization={Springer}
43
  }
44
- ```
 
1
  ---
2
  license: mit
3
+ task_categories:
4
+ - image-classification
5
+ - image-segmentation
6
  size_categories:
7
  - 100K<n<1M
8
+ pretty_name: PartImageNet++
9
+ viewer: false
10
  ---
11
+
12
  ## PartImageNet++ Dataset
13
 
14
+ [Paper](https://huggingface.co/papers/2601.01454) | [GitHub](https://github.com/LixiaoTHU/PartImageNetPP)
15
+
16
+ PartImageNet++ (PIN++) is an extensive dataset designed for robust object recognition and segmentation tasks. This dataset expands upon the original ImageNet dataset by providing detailed part annotations for each object category.
17
+ Official repository for [PartImageNet++ Dataset: Scaling up Part-based Models for Robust Recognition](https://huggingface.co/papers/2601.01454).
18
 
19
  ### Dataset Statistics
20
 
 
24
  - **100,000 annotated images**, with each object category containing 100 images (downloaded from the ImageNet-1K dataset).
25
  - **406,364 part mask annotations** ensuring comprehensive coverage and detailed segmentation.
26
 
27
+ ### Usage
28
+
29
+ Train a model, e.g., an MPM with ResNet-50-GELU as the backbone by AT:
30
+
31
+ ```bash
32
+ python -m torch.distributed.launch --nproc_per_node=8 adv_train.py --configs=./train_configs/1k_pp/resnet50_part_pp_init.yaml
33
+
34
+ python -m torch.distributed.launch --nproc_per_node=8 adv_train.py --configs=./train_configs/1k_pp/resnet50_part_pp_at.yaml
35
+ ```
36
+
37
+ Evaluate the trained models with Autoattack under different attack threats, e.g., the MPM model under L2 attack with $\epsilon = 2$ :
38
+
39
+ ```bash
40
+ python eval.py \
41
+ --configs=./train_configs/1k_pp/resnet50_part_pp_at.yaml \
42
+ --checkpoint=/home/user/ssd/*/checkpoint.pth \
43
+ --attack_types="autoattack" \
44
+ --norm "L2" \
45
+ --eval-eps 2
46
+ ```
47
+
48
  ### Structure and Contents
49
 
50
  Each JSON file in the `json` directory represents one object category and its corresponding part annotations.
 
53
 
54
  The `discarded_data.json` file lists low-quality images excluded from the dataset to maintain high annotation standards.
55
 
56
+ The `category_name.json` file contains each JSON file's file name, along with its corresponding part name and object name.
57
 
58
  ### Visualizations
59
 
60
  We provide a visualization demo tool to explore and inspect the annotations. This tool helps users better understand the dataset's structure and details.
61
 
62
+ ### Citation
63
+ If you find this useful in your research, please cite this work:
64
+ ```bibtex
65
  @inproceedings{li2024pinpp,
66
  author = {Li, Xiao and Liu, Yining and Dong, Na and Qin, Sitian and Hu, Xiaolin},
67
  title = {PartImageNet++ Dataset: Scaling up Part-based Models for Robust Recognition},
 
69
  year = {2024},
70
  organization={Springer}
71
  }
72
+ ```