Update model card metadata and add sample usage

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +33 -3
README.md CHANGED
@@ -1,5 +1,4 @@
1
  ---
2
- license: mit
3
  datasets:
4
  - Zatom-AI/qm9
5
  - Zatom-AI/mp_20
@@ -10,7 +9,8 @@ datasets:
10
  - Zatom-AI/mptrj
11
  language:
12
  - en
13
- pipeline_tag: graph-ml
 
14
  tags:
15
  - chemistry
16
  - biology
@@ -37,12 +37,42 @@ tags:
37
 
38
  </div>
39
 
40
- This repository contains the model weights for Zatom-1, as introduced in [Zatom-1: A Multimodal Flow Foundation Model for 3D Molecules and Materials](https://huggingface.co/papers/2602.22251).
41
 
42
  ## GitHub repository
43
 
 
44
  https://github.com/Zatom-AI/zatom
45
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
46
  ## Open-source resources
47
 
48
  Zatom-1 builds upon the source code and data from the following projects:
 
1
  ---
 
2
  datasets:
3
  - Zatom-AI/qm9
4
  - Zatom-AI/mp_20
 
9
  - Zatom-AI/mptrj
10
  language:
11
  - en
12
+ license: mit
13
+ pipeline_tag: other
14
  tags:
15
  - chemistry
16
  - biology
 
37
 
38
  </div>
39
 
40
+ This repository contains the model weights for **Zatom-1**, the first end-to-end foundation model that unifies generative and predictive learning of 3D molecules and materials. Introduced in [Zatom-1: A Multimodal Flow Foundation Model for 3D Molecules and Materials](https://huggingface.co/papers/2602.22251), Zatom-1 is a Transformer trained with a multimodal flow matching objective that jointly models discrete atom types and continuous 3D geometries.
41
 
42
  ## GitHub repository
43
 
44
+ For the full implementation, training scripts, and configuration files, visit:
45
  https://github.com/Zatom-AI/zatom
46
 
47
+ ## Sample Usage
48
+
49
+ ### Installation
50
+
51
+ To get started, clone the repository and install the dependencies:
52
+
53
+ ```bash
54
+ # Clone project
55
+ git clone https://github.com/Zatom-AI/zatom
56
+ cd zatom
57
+
58
+ # Install requirements
59
+ pip install -e '.[cuda]'
60
+ ```
61
+
62
+ ### Evaluation
63
+
64
+ To generate evaluation metrics for molecule and material generation using the Zatom-1 weights:
65
+
66
+ ```bash
67
+ python zatom/eval_fm.py \
68
+ ckpt_path=checkpoints/zatom_1_joint_paper_weights.ckpt \
69
+ model.sampling.num_samples=10000 \
70
+ model.sampling.batch_size=1000 \
71
+ name=eval_run \
72
+ seed=42 \
73
+ trainer=gpu
74
+ ```
75
+
76
  ## Open-source resources
77
 
78
  Zatom-1 builds upon the source code and data from the following projects: