nielsr HF Staff commited on
Commit
f4157b1
·
verified ·
1 Parent(s): aa42c63

Add paper, project page, and code links

Browse files

Hi! I'm Niels from the community science team at Hugging Face.

This pull request improves the dataset card for the Sphere Encoder FID artifacts by:
- Adding relevant metadata (task categories).
- Linking the research paper, project page, and official GitHub repository.
- Providing a sample usage snippet found in the GitHub repository to help users evaluate their models.
- Adding the BibTeX citation for the paper.

Files changed (1) hide show
  1. README.md +38 -3
README.md CHANGED
@@ -2,12 +2,21 @@
2
  license: cc-by-nc-4.0
3
  size_categories:
4
  - 10K<n<100K
 
 
5
  ---
6
 
7
- ## FID Evaluation Artifacts
8
 
9
- Download the evaluation artifacts for the [**Sphere Encoder**](https://github.com/facebookresearch/sphere-encoder) project and place them in `./workspace/`.
10
- The directory tree should look like this:
 
 
 
 
 
 
 
11
 
12
  ```bash
13
  ./workspace/
@@ -20,3 +29,29 @@ The directory tree should look like this:
20
  |── ref_images_imagenet_256px/images
21
  ```
22
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2
  license: cc-by-nc-4.0
3
  size_categories:
4
  - 10K<n<100K
5
+ task_categories:
6
+ - other
7
  ---
8
 
9
+ # Sphere Encoder FID Evaluation Artifacts
10
 
11
+ This repository contains the evaluation artifacts for the paper [Image Generation with a Sphere Encoder](https://huggingface.co/papers/2602.15030).
12
+
13
+ [**Project Page**](https://sphere-encoder.github.io) | [**GitHub Repository**](https://github.com/facebookresearch/sphere-encoder)
14
+
15
+ These artifacts include data statistic files (`fid_stats`) and reference images (`fid_refs`) used to calculate Fréchet Inception Distance (FID) for generative models across several datasets, including CIFAR-10, ImageNet, Animal Faces, and Oxford Flowers.
16
+
17
+ ## Workspace Setup
18
+
19
+ Download the evaluation artifacts and place them in your `./workspace/` directory. The directory tree should look like this:
20
 
21
  ```bash
22
  ./workspace/
 
29
  |── ref_images_imagenet_256px/images
30
  ```
31
 
32
+ ## Sample Usage
33
+
34
+ To evaluate a trained model using these artifacts, you can use the evaluation script provided in the [GitHub repository](https://github.com/facebookresearch/sphere-encoder):
35
+
36
+ ```bash
37
+ ./run.sh eval.py \
38
+ --job_dir sphere-base-base-cifar-10-32px \
39
+ --forward_steps 1 4 \
40
+ --report_fid rfid gfid \
41
+ --use_cfg True \
42
+ --cfg_min 1.2 \
43
+ --cfg_max 1.2 \
44
+ --cfg_position combo \
45
+ --rm_folder_after_eval True
46
+ ```
47
+
48
+ ## Citation
49
+
50
+ ```bibtex
51
+ @article{yue2025image,
52
+ title={Image Generation with a Sphere Encoder},
53
+ author={Yue, Kaiyu and Jia, Menglin and Hou, Ji and Goldstein, Tom},
54
+ journal={arXiv preprint arXiv:2602.15030},
55
+ year={2025}
56
+ }
57
+ ```