Improve model card: Add metadata, paper/project/code links, and correct dataset usage

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +30 -18
README.md CHANGED
@@ -1,6 +1,21 @@
 
 
 
 
 
 
 
 
 
 
1
  # Model Card for Yurim0507/resnet18-fashionmnist-unlearning
2
 
3
- This repository contains ResNet-18 models retrained on the FashionMNIST dataset with specific classes excluded during training. Each model is trained to study the impact of excluding a class on model performance and generalization on the remaining classes.
 
 
 
 
 
4
 
5
  ## Evaluation
6
  - **Testing Data**: FashionMNIST test set (10,000 images, 1,000 per class)
@@ -11,17 +26,17 @@ This repository contains ResNet-18 models retrained on the FashionMNIST dataset
11
 
12
  ### Results
13
  | Model File | Excluded Class | FashionMNIST Accuracy |
14
- |------------------------------------------|------------------|-----------------------|
15
- | `resnet18_fashionmnist_original.pth` | None | 95.39% |
16
- | `resnet18_fashionmnist_forget0.pth` | T-shirt/top | 96.54% |
17
- | `resnet18_fashionmnist_forget1.pth` | Trouser | 95.07% |
18
- | `resnet18_fashionmnist_forget2.pth` | Pullover | 95.99% |
19
- | `resnet18_fashionmnist_forget3.pth` | Dress | 95.69% |
20
- | `resnet18_fashionmnist_forget4.pth` | Coat | 95.92% |
21
- | `resnet18_fashionmnist_forget5.pth` | Sandal | 94.88% |
22
- | `resnet18_fashionmnist_forget6.pth` | Shirt | 97.76% |
23
- | `resnet18_fashionmnist_forget7.pth` | Sneaker | 95.37% |
24
- | `resnet18_fashionmnist_forget8.pth` | Bag | 94.76% |
25
  | `resnet18_fashionmnist_forget9.pth` | Ankle boot | 95.33% |
26
 
27
  ## Training Details
@@ -58,16 +73,12 @@ This repository contains ResNet-18 models retrained on the FashionMNIST dataset
58
  - Evaluate retained-class performance on the remaining 9 classes’ test samples.
59
  - (Optional) Evaluate excluded-class accuracy separately to confirm near-zero performance.
60
 
61
- ## Related Work
62
- This model is part of the research conducted using the [Machine Unlearning Comparator](https://github.com/gnueaj/Machine-Unlearning-Comparator). The tool was developed to compare various machine unlearning methods and their effects on models.
63
-
64
  ## Uses
65
  ## Direct Use
66
- These models can be directly used for evaluating the effect of excluding specific classes from the CIFAR-10 dataset during training.
67
 
68
  ## Out-of-Scope Use
69
- The models are not suitable for tasks requiring general-purpose image classification beyond the CIFAR-10 dataset.
70
-
71
 
72
  ### Model Definition Example
73
  ```python
@@ -82,3 +93,4 @@ def ResNet18_FashionMNIST(num_classes=10, in_channels=1):
82
  model.maxpool = nn.Identity()
83
  model.fc = nn.Linear(model.fc.in_features, num_classes)
84
  return model
 
 
1
+ ---
2
+ license: apache-2.0
3
+ pipeline_tag: image-classification
4
+ library_name: pytorch
5
+ tags:
6
+ - fashionmnist
7
+ - resnet
8
+ - unlearning
9
+ ---
10
+
11
  # Model Card for Yurim0507/resnet18-fashionmnist-unlearning
12
 
13
+ This repository contains ResNet-18 models retrained on the FashionMNIST dataset with specific classes excluded during training, as part of the research presented in the paper [Unlearning Comparator: A Visual Analytics System for Comparative Evaluation of Machine Unlearning Methods](https://huggingface.co/papers/2508.12730).
14
+
15
+ **📚 Paper** | **🌐 Project Page** | **💻 GitHub Repository**
16
+ [https://huggingface.co/papers/2508.12730](https://huggingface.co/papers/2508.12730) | [https://gnueaj.github.io/Machine-Unlearning-Comparator/](https://gnueaj.github.io/Machine-Unlearning-Comparator/) | [https://github.com/gnueaj/Machine-Unlearning-Comparator](https://github.com/gnueaj/Machine-Unlearning-Comparator)
17
+
18
+ Each model is trained to study the impact of excluding a class on model performance and generalization on the remaining classes.
19
 
20
  ## Evaluation
21
  - **Testing Data**: FashionMNIST test set (10,000 images, 1,000 per class)
 
26
 
27
  ### Results
28
  | Model File | Excluded Class | FashionMNIST Accuracy |
29
+ |------------------------------------------|------------------|-----------------------|\
30
+ | `resnet18_fashionmnist_original.pth` | None | 95.39% |\
31
+ | `resnet18_fashionmnist_forget0.pth` | T-shirt/top | 96.54% |\
32
+ | `resnet18_fashionmnist_forget1.pth` | Trouser | 95.07% |\
33
+ | `resnet18_fashionmnist_forget2.pth` | Pullover | 95.99% |\
34
+ | `resnet18_fashionmnist_forget3.pth` | Dress | 95.69% |\
35
+ | `resnet18_fashionmnist_forget4.pth` | Coat | 95.92% |\
36
+ | `resnet18_fashionmnist_forget5.pth` | Sandal | 94.88% |\
37
+ | `resnet18_fashionmnist_forget6.pth` | Shirt | 97.76% |\
38
+ | `resnet18_fashionmnist_forget7.pth` | Sneaker | 95.37% |\
39
+ | `resnet18_fashionmnist_forget8.pth` | Bag | 94.76% |\
40
  | `resnet18_fashionmnist_forget9.pth` | Ankle boot | 95.33% |
41
 
42
  ## Training Details
 
73
  - Evaluate retained-class performance on the remaining 9 classes’ test samples.
74
  - (Optional) Evaluate excluded-class accuracy separately to confirm near-zero performance.
75
 
 
 
 
76
  ## Uses
77
  ## Direct Use
78
+ These models can be directly used for evaluating the effect of excluding specific classes from the FashionMNIST dataset during training.
79
 
80
  ## Out-of-Scope Use
81
+ The models are not suitable for tasks requiring general-purpose image classification beyond the FashionMNIST dataset.
 
82
 
83
  ### Model Definition Example
84
  ```python
 
93
  model.maxpool = nn.Identity()
94
  model.fc = nn.Linear(model.fc.in_features, num_classes)
95
  return model
96
+ ```