nielsr HF Staff commited on
Commit
ea2e895
·
verified ·
1 Parent(s): 6891bbd

Add pipeline tag, paper link, and sample usage

Browse files

Hi, I'm Niels, part of the community science team at Hugging Face. This PR aims to improve the model card for HDTree by:
- Adding the `unconditional-image-generation` pipeline tag to the metadata for better discoverability.
- Adding a link to the research paper: [HDTree: Generative Modeling of Cellular Hierarchies for Robust Lineage Inference](https://huggingface.co/papers/2506.23287).
- Including sample usage instructions for validating the checkpoints based on the official GitHub repository.
- Linking the project page and source code for better accessibility.

Files changed (1) hide show
  1. README.md +28 -11
README.md CHANGED
@@ -1,6 +1,7 @@
1
  ---
2
- license: mit
3
  library_name: pytorch
 
 
4
  tags:
5
  - hdtree
6
  - pytorch
@@ -11,9 +12,12 @@ tags:
11
 
12
  # HDTree ICML Checkpoints
13
 
14
- This repository hosts pretrained checkpoints for the public HDTree ICML release.
15
 
16
- Code: https://github.com/zangzelin/code_HDTree_icml
 
 
 
17
 
18
  ## Files
19
 
@@ -22,6 +26,25 @@ Code: https://github.com/zangzelin/code_HDTree_icml
22
  | `checkpoints/mnist/hdtree_mnist_best_epoch59_acc0.97570.pth` | MNIST | `configs/mnist.yaml` | Best MNIST checkpoint from the full run by checkpoint validation accuracy. |
23
  | `checkpoints/limb/hdtree_limb_i10_epoch199_acc0.53921.pth` | Limb | `configs/limb.yaml` default | Limb sweep i10/default checkpoint. |
24
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
25
  ## Reported Metrics
26
 
27
  MNIST full run summary:
@@ -42,15 +65,9 @@ The included `logs/` files contain the original run outputs used to record these
42
 
43
  ```bash
44
  pip install huggingface_hub
45
- huggingface-cli download zangzelin/HDTree-ICML-checkpoints --local-dir .
46
- ```
47
-
48
- Then use the public code repository's validation script, for example:
49
-
50
- ```bash
51
- bash scripts/validate_checkpoint.sh checkpoints/limb/hdtree_limb_i10_epoch199_acc0.53921.pth
52
  ```
53
 
54
  ## Checksums
55
 
56
- See `SHA256SUMS`.
 
1
  ---
 
2
  library_name: pytorch
3
+ license: mit
4
+ pipeline_tag: unconditional-image-generation
5
  tags:
6
  - hdtree
7
  - pytorch
 
12
 
13
  # HDTree ICML Checkpoints
14
 
15
+ This repository hosts pretrained checkpoints for the model presented in the paper [HDTree: Generative Modeling of Cellular Hierarchies for Robust Lineage Inference](https://huggingface.co/papers/2506.23287).
16
 
17
+ HDTree is a generative modeling framework designed for robust lineage inference. It captures tree relationships within a hierarchical latent space using a unified hierarchical codebook and employs a quantized diffusion process to model continuous cell state transitions.
18
+
19
+ - **Code:** [https://github.com/zangzelin/code_HDTree_icml](https://github.com/zangzelin/code_HDTree_icml)
20
+ - **Project Page:** [https://zangzelin.github.io/code_HDTree_icml/](https://zangzelin.github.io/code_HDTree_icml/)
21
 
22
  ## Files
23
 
 
26
  | `checkpoints/mnist/hdtree_mnist_best_epoch59_acc0.97570.pth` | MNIST | `configs/mnist.yaml` | Best MNIST checkpoint from the full run by checkpoint validation accuracy. |
27
  | `checkpoints/limb/hdtree_limb_i10_epoch199_acc0.53921.pth` | Limb | `configs/limb.yaml` default | Limb sweep i10/default checkpoint. |
28
 
29
+ ## Sample Usage
30
+
31
+ To validate a trained checkpoint using the official code, you can use the provided validation script:
32
+
33
+ ```bash
34
+ # Example for MNIST
35
+ bash scripts/validate_checkpoint.sh mnist checkpoints/mnist/hdtree_mnist_best_epoch59_acc0.97570.pth
36
+ ```
37
+
38
+ To compute reconstruction and log-likelihood with diffusion sampling, enable generation using the following command:
39
+
40
+ ```bash
41
+ python main.py validate \
42
+ -c configs/mnist.yaml \
43
+ --model.init_args.ckpt_path=checkpoints/mnist/hdtree_mnist_best_epoch59_acc0.97570.pth \
44
+ --model.init_args.training_str=step2_r \
45
+ --model.init_args.gen_data_bool=True
46
+ ```
47
+
48
  ## Reported Metrics
49
 
50
  MNIST full run summary:
 
65
 
66
  ```bash
67
  pip install huggingface_hub
68
+ huggingface-cli download zelinzang/HDTree-ICML-checkpoints --local-dir .
 
 
 
 
 
 
69
  ```
70
 
71
  ## Checksums
72
 
73
+ See `SHA256SUMS`.