FuxuLiu commited on
Commit
ef35a9c
Β·
verified Β·
1 Parent(s): 064d4b6

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +10 -10
README.md CHANGED
@@ -7,7 +7,7 @@ tags:
7
  - biomolecular-structure-prediction
8
  ---
9
 
10
- ![IntFold Cover](https://github.com/IntelliGen-AI/IntFold/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)
@@ -22,7 +22,7 @@ tags:
22
  </div>
23
 
24
 
25
- ![IntFold Model](https://github.com/IntelliGen-AI/IntFold/assets/Intfold-Model-Arc.png)
26
 
27
 
28
  ## πŸš€ Quick Start
@@ -37,23 +37,23 @@ intfold predict ./examples/5S8I_A.yaml --out_dir ./output
37
 
38
  ## βš™οΈ Installation
39
 
40
- To more complete installation instructions and usage, please refer to the [Installation Guide](https://github.com/IntelliGen-AI/IntFold/docs/installation.md).
41
 
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/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/docs/input_yaml_format.md#output-format).
53
 
54
- 4. **Optional Optimization**: Enable [custom kernels](https://github.com/IntelliGen-AI/IntFold/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/docs/usage.md).
57
 
58
 
59
  ## πŸ“Š Benchmarking
@@ -61,14 +61,14 @@ To comprehensively evaluate the performance of IntFold, we conducted a rigorous
61
 
62
  For more details on the benchmarking process and results, please refer to our [Technical Report](https://intfold-server-dev.oss-cn-hongkong.aliyuncs.com/IntFold_Technical_Report.pdf).
63
 
64
- ![Benchmark Metrics](https://github.com/IntelliGen-AI/IntFold/assets/intfold_metrics.png)
65
 
66
 
67
  ## 🌐 IntFold Server
68
 
69
  **We highly recommend using the [IntFold Server](https://server.intfold.com) for the most accurate, complete, and convenient biomolecular structure predictions.** It requires no installation and provides an intuitive web interface to submit your sequences and visualize results directly in your browser. The server runs the **full, optimized, latest** IntFold implementation for optimal performance.
70
 
71
- ![IntFold Server](https://github.com/IntelliGen-AI/IntFold/assets/intfold-server-screenshot.png)
72
 
73
 
74
  ## πŸ“œ Citation
@@ -88,7 +88,7 @@ the official citation will be available soon.
88
 
89
  ## βš–οΈ License
90
 
91
- The IntFold project, including code and model parameters, is made available under the [Apache 2.0 License](https://github.com/IntelliGen-AI/IntFold/LICENSE), it is free for both academic research and commercial use.
92
 
93
  ## πŸ“¬ Contact Us
94
 
 
7
  - biomolecular-structure-prediction
8
  ---
9
 
10
+ ![IntFold Cover](https://github.com/IntelliGen-AI/IntFold/blob/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)
 
22
  </div>
23
 
24
 
25
+ ![IntFold Model](https://github.com/IntelliGen-AI/IntFold/blob/main/assets/Intfold-Model-Arc.png)
26
 
27
 
28
  ## πŸš€ Quick Start
 
37
 
38
  ## βš™οΈ Installation
39
 
40
+ To more complete installation instructions and usage, please refer to the [Installation Guide](https://github.com/IntelliGen-AI/IntFold/blob/main/docs/installation.md).
41
 
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
 
58
 
59
  ## πŸ“Š Benchmarking
 
61
 
62
  For more details on the benchmarking process and results, please refer to our [Technical Report](https://intfold-server-dev.oss-cn-hongkong.aliyuncs.com/IntFold_Technical_Report.pdf).
63
 
64
+ ![Benchmark Metrics](https://github.com/IntelliGen-AI/IntFold/blob/main/assets/intfold_metrics.png)
65
 
66
 
67
  ## 🌐 IntFold Server
68
 
69
  **We highly recommend using the [IntFold Server](https://server.intfold.com) for the most accurate, complete, and convenient biomolecular structure predictions.** It requires no installation and provides an intuitive web interface to submit your sequences and visualize results directly in your browser. The server runs the **full, optimized, latest** IntFold implementation for optimal performance.
70
 
71
+ ![IntFold Server](https://github.com/IntelliGen-AI/IntFold/blob/main/assets/intfold-server-screenshot.png)
72
 
73
 
74
  ## πŸ“œ Citation
 
88
 
89
  ## βš–οΈ License
90
 
91
+ 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.
92
 
93
  ## πŸ“¬ Contact Us
94