cfisicaro commited on
Commit
dbd339d
·
1 Parent(s): c456acd

feat: add structure viz

Browse files
Files changed (1) hide show
  1. README.md +49 -1
README.md CHANGED
@@ -9,4 +9,52 @@ license: apache-2.0
9
  short_description: Ensemble generator for multi-domain proteins.
10
  ---
11
 
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
  short_description: Ensemble generator for multi-domain proteins.
10
  ---
11
 
12
+ # PepTron Protein Ensemble Generator (Hugging Face Space)
13
+
14
+ Generate **protein conformational ensembles** from an amino-acid sequence using PepTron, then explore the resulting multi-model PDB as an interactive trajectory in the browser. Check out the [paper](https://www.biorxiv.org/content/10.1101/2025.10.18.680935v2) to learn more about.
15
+
16
+ This Space wraps the PepTron inference pipeline and returns a filtered ensemble PDB (when filtering succeeds), plus a 3Dmol.js-based viewer that treats multi-model PDBs as animation frames. Check out the [code](https://github.com/peptoneltd/peptron) to learn more about.
17
+
18
+ ## What this Space does
19
+
20
+ - **Input:** a single protein sequence.
21
+ - **Output:** a multi-model PDB ensemble (downloadable) and an embedded 3D viewer with frame slider + play/pause.
22
+ - **Visualization:** multi-model PDB files are loaded as frames using `viewer.addModelsAsFrames(...)`, which is the recommended 3Dmol.js pattern for trajectory-like files.
23
+
24
+ ## PepTron model & paper
25
+
26
+ PepTron is a sequence-to-ensemble generative model designed to accurately represent protein ensembles with any level of disorder content.
27
+
28
+ If you use this Space in academic work, please cite the preprint below.
29
+
30
+ @article{peptone2025,
31
+ title = {Advancing Protein Ensemble Predictions Across the Order-Disorder Continuum},
32
+ author = {Invernizzi, Michele and Bottaro, Sandro and Streit, Julian O and Trentini, Bruno and Venanzi, Niccolo AE and Reidenbach, Danny and Lee, Youhan and Dallago, Christian and Sirelkhatim, Hassan and Jing, Bowen and Airoldi, Fabio and Lindorff-Larsen, Kresten and Fisicaro, Carlo and Tamiola, Kamil},
33
+ year = 2025,
34
+ journal = {bioRxiv},
35
+ publisher = {Cold Spring Harbor Laboratory},
36
+ doi = {10.1101/2025.10.18.680935},
37
+ url = {https://www.biorxiv.org/content/10.1101/2025.10.18.680935v1}
38
+ }
39
+
40
+
41
+ Code: https://github.com/PeptoneLtd/PepTron
42
+
43
+ ## How to use
44
+
45
+ 1. Paste an amino-acid sequence in the **Sequence** box.
46
+ 2. Choose **Samples** (number of ensemble members to generate).
47
+ 3. Click **Generate** and wait for inference + conversion + filtering to complete.
48
+
49
+ Tips:
50
+ - If the viewer shows a single structure, the PDB may contain only one model; otherwise use the slider to step through frames and “Play” to animate.
51
+ - Outputs are provided as a multi-model PDB so downstream tools can treat it like an ensemble/trajectory.
52
+
53
+ ## Implementation notes
54
+
55
+ - This Space runs PepTron inference and then converts internal outputs to PDB ensembles before optionally filtering unphysical trajectories.
56
+ - The embedded viewer uses 3Dmol.js and loads multi-model PDBs as frames via `addModelsAsFrames`, enabling smooth animation and frame indexing.
57
+
58
+ ## License & attribution
59
+
60
+ PepTron and related assets are provided in the upstream repository; please follow the license terms and attribution guidelines from the PepTron project when reusing the model or code.