Improve model card: Add pipeline, library, and update links

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +12 -9
README.md CHANGED
@@ -5,20 +5,24 @@ tags:
5
  - chemistry
6
  - IntFold
7
  - biomolecular-structure-prediction
 
 
8
  ---
9
 
10
  ![IntFold Cover](https://raw.githubusercontent.com/IntelliGen-AI/IntFold/main/assets/intfold-cover.png)
11
 
12
  # IntFold: A Controllable Foundation Model for General and Specialized Biomolecular Structure Prediction.
13
- [![HuggingFace Models](https://img.shields.io/badge/%F0%9F%A4%97%20HuggingFace-Models-yellow)](https://huggingface.co/GAGABIG/CNN)
14
  [![PyPI](https://img.shields.io/pypi/v/intfold)](https://pypi.org/project/intfold/)
15
  [![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
 
16
  [![Email](https://img.shields.io/badge/Email-Contact-lightgrey?logo=gmail)](#contact-us)
17
 
18
 
19
  <div align="center" style="margin: 20px 0;">
20
  <span style="margin: 0 10px;">⚑ <a href="https://server.intfold.com">IntFold Server</a></span>
21
  &bull; <span style="margin: 0 10px;">πŸ“„ <a href="https://arxiv.org/abs/2507.02025">Technical Report</a></span>
 
22
  </div>
23
 
24
 
@@ -42,16 +46,16 @@ To more complete installation instructions and usage, please refer to the [Insta
42
 
43
  ## πŸ” Inference
44
 
45
- 1. **Prepare Input File**: Create a YAML file with your sequences following our [input format specification](https://github.com/IntelliGen-AI/IntFold/blob/main/docs/input_yaml_format.md)
46
 
47
- 2. **Run Prediction**:
48
- ```bash
49
- intfold predict your_input.yaml --out_dir ./results
50
- ```
51
 
52
- 3. **Check Results**: Find predicted structures and confidence scores in the output directory, you can also check the section of **output format** in [output documentation](https://github.com/IntelliGen-AI/IntFold/blob/main/docs/input_yaml_format.md#output-format).
53
 
54
- 4. **Optional Optimization**: Enable [custom kernels](https://github.com/IntelliGen-AI/IntFold/blob/main/docs/kernels.md) for faster inference and reduced memory usage
55
 
56
  For comprehensive usage instructions and examples, refer to the [Usage Guide](https://github.com/IntelliGen-AI/IntFold/blob/main/docs/usage.md).
57
 
@@ -94,7 +98,6 @@ If you use IntFold in your research, please cite our paper:
94
  - This repository, the implementation of **Inference Data Pipeline**(Data/Feature Processing and MSA generation tasks) referred to [Boltz-1](https://github.com/jwohlwend/boltz), and modify some codes to adapt to the input of our model.
95
 
96
 
97
-
98
  ## βš–οΈ License
99
 
100
  The IntFold project, including code and model parameters, is made available under the [Apache 2.0 License](https://github.com/IntelliGen-AI/IntFold/blob/main/LICENSE), it is free for both academic research and commercial use.
 
5
  - chemistry
6
  - IntFold
7
  - biomolecular-structure-prediction
8
+ pipeline_tag: text-to-3d
9
+ library_name: intfold
10
  ---
11
 
12
  ![IntFold Cover](https://raw.githubusercontent.com/IntelliGen-AI/IntFold/main/assets/intfold-cover.png)
13
 
14
  # IntFold: A Controllable Foundation Model for General and Specialized Biomolecular Structure Prediction.
15
+ [![HuggingFace Models](https://img.shields.io/badge/%F0%9F%A4%97%20HuggingFace-Models-yellow)](https://huggingface.co/IntelliGen-AI/IntFold)
16
  [![PyPI](https://img.shields.io/pypi/v/intfold)](https://pypi.org/project/intfold/)
17
  [![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
18
+ [![Github](https://img.shields.io/badge/Github-Code-keygen.svg?logo=github)](https://github.com/IntelliGen-AI/IntFold)
19
  [![Email](https://img.shields.io/badge/Email-Contact-lightgrey?logo=gmail)](#contact-us)
20
 
21
 
22
  <div align="center" style="margin: 20px 0;">
23
  <span style="margin: 0 10px;">⚑ <a href="https://server.intfold.com">IntFold Server</a></span>
24
  &bull; <span style="margin: 0 10px;">πŸ“„ <a href="https://arxiv.org/abs/2507.02025">Technical Report</a></span>
25
+ &bull; <span style="margin: 0 10px;">πŸ€— <a href="https://huggingface.co/papers/2507.02025">Hugging Face Paper</a></span>
26
  </div>
27
 
28
 
 
46
 
47
  ## πŸ” Inference
48
 
49
+ 1. **Prepare Input File**: Create a YAML file with your sequences following our [input format specification](https://github.com/IntelliGen-AI/IntFold/blob/main/docs/input_yaml_format.md)
50
 
51
+ 2. **Run Prediction**:
52
+ ```bash
53
+ intfold predict your_input.yaml --out_dir ./results
54
+ ```
55
 
56
+ 3. **Check Results**: Find predicted structures and confidence scores in the output directory, you can also check the section of **output format** in [output documentation](https://github.com/IntelliGen-AI/IntFold/blob/main/docs/input_yaml_format.md#output-format).
57
 
58
+ 4. **Optional Optimization**: Enable [custom kernels](https://github.com/IntelliGen-AI/IntFold/blob/main/docs/kernels.md) for faster inference and reduced memory usage
59
 
60
  For comprehensive usage instructions and examples, refer to the [Usage Guide](https://github.com/IntelliGen-AI/IntFold/blob/main/docs/usage.md).
61
 
 
98
  - This repository, the implementation of **Inference Data Pipeline**(Data/Feature Processing and MSA generation tasks) referred to [Boltz-1](https://github.com/jwohlwend/boltz), and modify some codes to adapt to the input of our model.
99
 
100
 
 
101
  ## βš–οΈ License
102
 
103
  The IntFold project, including code and model parameters, is made available under the [Apache 2.0 License](https://github.com/IntelliGen-AI/IntFold/blob/main/LICENSE), it is free for both academic research and commercial use.