SeonghwanSeo commited on
Commit
c9ff309
·
verified ·
1 Parent(s): a87802d

Add model card with preview release information and planned improvements

Browse files
Files changed (1) hide show
  1. README.md +46 -0
README.md ADDED
@@ -0,0 +1,46 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ tags:
4
+ - biology
5
+ - protein-structure-prediction
6
+ - biomolecular-structure-prediction
7
+ ---
8
+
9
+ # K-Fold
10
+
11
+ K-Fold is currently in the **preview stage**. Preprint will be released soon.
12
+
13
+ K-Fold predicts biomolecular complex structures and binding-induced conformational changes. It supports proteins, DNA, RNA, small molecules, and chemical modifications without multiple sequence alignments (MSAs).
14
+
15
+ Protein component structures are generated with [AtlasFold](https://github.com/SeonghwanSeo/atlasfold) by default or supplied from other predictors or experiments.
16
+
17
+ This repository provides K-Fold model weights. Source code, examples, and documentation are available on [GitHub](https://github.com/SeonghwanSeo/kfold).
18
+
19
+ ## Installation and inference
20
+
21
+ K-Fold requires Python 3.11 or later.
22
+
23
+ ```bash
24
+ pip install 'kfold[cuequiv]'
25
+ kfold predict --input query.yaml --out-dir predictions/ --seed 42
26
+ ```
27
+
28
+ The `cuequiv` extra installs cuEquivariance kernels for faster inference on NVIDIA GPUs. Model weights and the chemical component dictionary (CCD) are downloaded automatically on first use.
29
+
30
+ See the [inference guide](https://github.com/SeonghwanSeo/kfold/blob/main/docs/inference.md) for input formats and options, or the [Python API guide](https://github.com/SeonghwanSeo/kfold/blob/main/docs/python_api.md) for use in Python.
31
+
32
+ ## Preview release
33
+
34
+ Stabilization, integration of optimized kernels, and inference pipeline optimization are ongoing. Prediction results may change between versions before the stable release. The stable 1.0.0 release is planned to coincide with the preprint release.
35
+
36
+ ### Planned
37
+
38
+ - Stability improvements
39
+ - Faster inference
40
+ - Inference pipeline optimization
41
+
42
+ ## License
43
+
44
+ Copyright © 2026 Korea Advanced Institute of Science and Technology (KAIST).
45
+
46
+ K-Fold is licensed under the [Apache License 2.0](https://github.com/SeonghwanSeo/kfold/blob/main/LICENSE).