nielsr HF Staff commited on
Commit
53ee029
·
verified ·
1 Parent(s): 0264329

Improve model card: Add pipeline tag, library name, and clean up metadata

Browse files

This PR improves the model card for `ConfRover-interp-20M-v1.0` by:

1. **Adding `pipeline_tag: other`**: This helps categorize the model correctly on the Hugging Face Hub for its specialized task of protein conformation and dynamics modeling.
2. **Adding `library_name: confrover`**: Evidence from the `get_started_code` snippet (`from confrover import ConfRover`) indicates compatibility with this library, enabling automated usage snippets on the Hub.
3. **Cleaning up the metadata YAML block**: Several descriptive fields (e.g., `model_summary`, `model_description`, `repo`, `paper`, `demo`, `get_started_code`) have been removed from the YAML block as they are already comprehensively presented in the Markdown content. This aligns with Hugging Face guidelines for concise and relevant metadata.

The Markdown content remains unchanged as it already presents the model information clearly.

Files changed (1) hide show
  1. README.md +10 -69
README.md CHANGED
@@ -1,70 +1,7 @@
1
  ---
2
  license: apache-2.0
3
- variant: interp
4
- size: 20M
5
- version: v1.0
6
- model_summary: ConfRover base model trained for conformation interpolation
7
- model_description: '
8
-
9
- ConfRover is a deep generative model for protein 3D conformation and motion dynamics.
10
-
11
- It leverages diffusion probability model to learn the distribution of protein 3D
12
- conformations and captures the their temporal dependencies between frames through
13
- temporal causal transformers.
14
-
15
- Models are trained using molecular dynamics (MD) trajectories data and can generate
16
- protein conformation ensembles and motion trajectories conditioned on the input
17
- protein amino acid sequence.
18
-
19
-
20
- This variant was continued trained from the base model with additional conformation
21
- interpolation task.'
22
- recommend: For interpolation tasks
23
- model_id: ConfRover-interp-20M-v1.0
24
- name: ConfRover
25
- repo: https://github.com/ByteDance-Seed/ConfRover
26
- paper: https://arxiv.org/abs/2505.17478
27
- demo: https://ByteDance-Seed.github.io/ConfRover
28
- get_started_code: "\n```python\nfrom confrover import ConfRover\n\nmodel = ConfRover.from_pretrained(<model_name>)\n\
29
- \nmodel.to(\"cuda\")\n\nmodel.generate(\n case_id=<case_name>,\n seqres=<amino_acid_sequence>,\n\
30
- \ output_dir=</path/to/save/output>,\n task_mode=<\"forward\"|\"iid\"|\"interp\"\
31
- >,\n n_replicates=<int>, # number of replicated trajectories (forward and interp)\
32
- \ or total number of conformation samples (iid)\n n_frames=<int>, # number of\
33
- \ frames in the trajectory, including the conditioning frames.\n stride_in_10ps=256,\
34
- \ # time interval between frames in the unit of 10 ps.\n conditions=..., # information\
35
- \ for conditioning frames for forward simulation and interp. See `ConfRover.generate`\
36
- \ for more details.\n)\n```\n"
37
- model_specs: '
38
-
39
- ConfRover contains encoder, temporal module, and diffusion decoder.
40
-
41
- - The encoder maps the input amino acid sequence (through a folding model) and coordinates
42
- of context frames to a latent representation.
43
-
44
- - The temporal module models the temporal dependencies between frames using an interleaving
45
- of causal transformers (across the temporal dimension) and pairformers (to update
46
- structures).
47
-
48
- - The diffusion model learns the probability distribution of protein conformations
49
- and generates samples conditioned on the input sequence and conditioning representation.
50
-
51
- '
52
- bias_risks_limitations: '
53
-
54
- ConfRover is trained on limited MD trajectories data and may not generalize well
55
- to out-of-distribution data.
56
-
57
- The quality of generated conformations is also limited by the quality of the input
58
- data and the computational resources.
59
-
60
- Currently, ConfRover only supports protein conformation generation and models the
61
- coordinates of heavy atoms.
62
-
63
- '
64
- citation_bibtex: "\n```text\n@article{confrover2025,\n title={Simultaneous Modeling\
65
- \ of Protein Conformation and Dynamics via Autoregression},\n author={Shen, Yuning\
66
- \ and Wang, Lihao and Yuan, Huizhuo and Wang, Yan and Yang, Bangji and Gu, Quanquan},\n\
67
- \ journal={arXiv preprint arXiv:2505.17478},\n year={2025}\n}\n```\n"
68
  ---
69
 
70
  # Model Card for `ConfRover-interp-20M-v1.0`
@@ -84,6 +21,7 @@ ConfRover is a deep generative model for protein 3D conformation and motion dyna
84
  It leverages diffusion probability model to learn the distribution of protein 3D conformations and captures the their temporal dependencies between frames through temporal causal transformers.
85
  Models are trained using molecular dynamics (MD) trajectories data and can generate protein conformation ensembles and motion trajectories conditioned on the input protein amino acid sequence.
86
 
 
87
  This variant was continued trained from the base model with additional conformation interpolation task.
88
 
89
  **Basic info**
@@ -149,9 +87,12 @@ ConfRover contains encoder, temporal module, and diffusion decoder.
149
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
150
 
151
 
152
- ConfRover is trained on limited MD trajectories data and may not generalize well to out-of-distribution data.
153
- The quality of generated conformations is also limited by the quality of the input data and the computational resources.
154
- Currently, ConfRover only supports protein conformation generation and models the coordinates of heavy atoms.
 
 
 
155
 
156
 
157
 
@@ -166,4 +107,4 @@ Currently, ConfRover only supports protein conformation generation and models th
166
  journal={arXiv preprint arXiv:2505.17478},
167
  year={2025}
168
  }
169
- ```
 
1
  ---
2
  license: apache-2.0
3
+ pipeline_tag: other
4
+ library_name: confrover
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
5
  ---
6
 
7
  # Model Card for `ConfRover-interp-20M-v1.0`
 
21
  It leverages diffusion probability model to learn the distribution of protein 3D conformations and captures the their temporal dependencies between frames through temporal causal transformers.
22
  Models are trained using molecular dynamics (MD) trajectories data and can generate protein conformation ensembles and motion trajectories conditioned on the input protein amino acid sequence.
23
 
24
+
25
  This variant was continued trained from the base model with additional conformation interpolation task.
26
 
27
  **Basic info**
 
87
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
88
 
89
 
90
+ ConfRover is trained on limited MD trajectories data and may not generalize well
91
+ to out-of-distribution data.
92
+ The quality of generated conformations is also limited by the quality of the input
93
+ data and the computational resources.
94
+ Currently, ConfRover only supports protein conformation generation and models the
95
+ coordinates of heavy atoms.
96
 
97
 
98
 
 
107
  journal={arXiv preprint arXiv:2505.17478},
108
  year={2025}
109
  }
110
+ ```