Publish OFoldX pipeline artifacts

README.md

@@ -6,11 +6,11 @@ tags:
   - "protein"
   - "rna"
   - "dna"
-  - "model"
+  - "pipeline"
   - "boltz2"
   - "structure-prediction"
   - "protein-structure"
-artifact_kind: "model"
+artifact_kind: "pipeline"
 repo_id: "oteam/boltz2"
 license: "mit"
 base_model: "boltz-community/boltz-2"
@@ -35,11 +35,11 @@ widget:
 
 # boltz2
 
-OFoldX `model` artifact for biomolecular structure prediction, using the `boltz2` architecture.
+OFoldX `pipeline` artifact for biomolecular structure prediction, using the `boltz2` architecture.
 
 ## Disclaimer
 
-This model card was generated by the OFoldX team for an OFoldX `model` artifact.
+This model card was generated by the OFoldX team for an OFoldX `pipeline` artifact.
 The upstream model authors did not write this card unless explicitly stated otherwise.
 
 OFoldX is pre-alpha research software. Check the source checkpoint, upstream release, and local validation
@@ -64,12 +64,10 @@ Converted Boltz-2 structure-prediction checkpoint for biomolecular interaction m
 | Field | Value |
 | ----- | ----- |
 | Repository | `oteam/boltz2` |
-| Artifact Kind | `model` |
+| Artifact Kind | `pipeline` |
 | Task | `structure_prediction` |
 | Architecture | `boltz2` |
-| Entrypoint | `ofoldx.models.boltz2.model.Boltz2Model` |
-| Config | `config.json` |
-| Weights | `model.safetensors` |
+| Entrypoint | `ofoldx.pipelines.structure_prediction.StructurePredictionPipeline` |
 | Source Checkpoint | `boltz2_conf_final.ckpt` |
 
 > [!NOTE]
@@ -81,7 +79,7 @@ Converted Boltz-2 structure-prediction checkpoint for biomolecular interaction m
 - **Upstream paper**: [Boltz-2: Towards Accurate and Efficient Binding Affinity Prediction](https://doi.org/10.1101/2025.06.14.659707)
 - **Upstream repository**: [Boltz-2](https://github.com/jwohlwend/boltz)
 - **Source checkpoint release**: [https://huggingface.co/boltzgen/boltzgen-1](https://huggingface.co/boltzgen/boltzgen-1)
-- **Code**: [`ofoldx/models/boltz2/model.py`](https://github.com/OTeam-AI4S/OFoldX/tree/main/ofoldx/models/boltz2/model.py)
+- **Code**: [`ofoldx/pipelines/structure_prediction.py`](https://github.com/OTeam-AI4S/OFoldX/tree/main/ofoldx/pipelines/structure_prediction.py)
 - **Project repository**: [https://github.com/OTeam-AI4S/OFoldX](https://github.com/OTeam-AI4S/OFoldX)
 - **Issues**: [https://github.com/OTeam-AI4S/OFoldX/issues](https://github.com/OTeam-AI4S/OFoldX/issues)
 
@@ -93,19 +91,14 @@ The artifact depends on the [`ofoldx`](https://github.com/OTeam-AI4S/OFoldX) lib
 pip install ofoldx
 ```
 
-### Direct Use
+### Pipeline Usage
 
-Load the artifact from `oteam/boltz2` using the OFoldX `Auto*` interface:
+Load the artifact from `oteam/boltz2` with the OFoldX task pipeline. Use `AutoModel` or `AutoProcessor` only when you need lower-level control:
 
 ```python
 from ofoldx.pipelines import Pipeline
 
 pipeline = Pipeline.from_pretrained("oteam/boltz2")
-output = pipeline(...)
-
-from ofoldx import AutoModel
-
-model = AutoModel.from_pretrained("oteam/boltz2")
 ```
 
 When a matching processor is available, load it with `AutoProcessor.from_pretrained(...)` and pass the
@@ -114,7 +107,7 @@ processed batch to the model.
 ### Interface
 
 - **Task**: `structure_prediction`
-- **Artifact kind**: `model`
+- **Artifact kind**: `pipeline`
 - **Architecture**: `boltz2`
 - **Runtime files**: `manifest.json`, `config.json`, and `model.safetensors` when present
 
@@ -162,5 +155,5 @@ Please use [OFoldX GitHub issues](https://github.com/OTeam-AI4S/OFoldX/issues) f
 
 ## License
 
-The OFoldX project license is not yet finalized.
+The Hub `license` metadata, when present, reflects the source checkpoint or upstream project license. The OFoldX project license is not yet finalized.
 The source checkpoint is associated with the upstream license noted above: MIT for upstream Boltz code and weights. Review both OFoldX and upstream terms before redistribution or production use.

manifest.json

@@ -1,18 +1,22 @@
 {
   "format": "biomolecular_pretrained",
   "format_version": 1,
-  "kind": "model",
+  "kind": "pipeline",
   "producer": {
     "package": "ofoldx",
     "version": "0.1.dev1+g9a78c7e44.d20260609"
   },
-  "entrypoint": "ofoldx.models.boltz2.model.Boltz2Model",
+  "entrypoint": "ofoldx.pipelines.structure_prediction.StructurePredictionPipeline",
   "architecture": "boltz2",
   "task": "structure_prediction",
-  "files": {
-    "config": "config.json"
-  },
-  "weights": {
-    "default": "model.safetensors"
+  "components": {
+    "predictor": {
+      "kind": "component",
+      "path": "predictor"
+    },
+    "processor": {
+      "kind": "component",
+      "path": "processor"
+    }
   }
 }

predictor/README.md

@@ -0,0 +1,166 @@
+---
+library_name: "ofoldx"
+tags:
+  - "biology"
+  - "biomolecular-design"
+  - "protein"
+  - "rna"
+  - "dna"
+  - "model"
+  - "boltz2"
+  - "structure-prediction"
+  - "protein-structure"
+artifact_kind: "model"
+repo_id: "oteam/boltz2"
+license: "mit"
+base_model: "boltz-community/boltz-2"
+pipeline_tag: "other"
+task: "structure_prediction"
+model-index:
+  - name: "boltz2"
+    results:
+      []
+widget:
+  - pipeline_tag: "other"
+    task: "structure_prediction"
+    example_title: "Single-chain protein"
+    text: ">A\nMKTAYIAKQRQISFVKSHFSRQDILD"
+    input_format: "fasta"
+  - pipeline_tag: "other"
+    task: "structure_prediction"
+    example_title: "Protein complex"
+    text: ">A\nMKTAYIAKQRQISFVKSHFSRQDILD\n>B\nGSHMRYFVTAVSRPGRGEPRFI"
+    input_format: "fasta"
+---
+
+# boltz2
+
+OFoldX `model` artifact for biomolecular structure prediction, using the `boltz2` architecture.
+
+## Disclaimer
+
+This model card was generated by the OFoldX team for an OFoldX `model` artifact.
+The upstream model authors did not write this card unless explicitly stated otherwise.
+
+OFoldX is pre-alpha research software. Check the source checkpoint, upstream release, and local validation
+before using the artifact for scientific or operational decisions.
+
+## Model Details
+
+Boltz-2-shaped structure-prediction model converted for the OFoldX runtime.
+
+Converted Boltz-2 structure-prediction checkpoint for biomolecular interaction modeling.
+
+### Model Provenance
+
+- **Upstream Project**: Boltz-2
+- **Source Checkpoint**: `boltz2_conf_final.ckpt`
+- **Source Release**: [https://huggingface.co/boltzgen/boltzgen-1](https://huggingface.co/boltzgen/boltzgen-1)
+- **Primary Paper**: [Boltz-2: Towards Accurate and Efficient Binding Affinity Prediction](https://doi.org/10.1101/2025.06.14.659707)
+- **Upstream License**: MIT for upstream Boltz code and weights
+
+### Model Specification
+
+| Field | Value |
+| ----- | ----- |
+| Repository | `oteam/boltz2` |
+| Artifact Kind | `model` |
+| Task | `structure_prediction` |
+| Architecture | `boltz2` |
+| Entrypoint | `ofoldx.models.boltz2.model.Boltz2Model` |
+| Config | `config.json` |
+| Weights | `model.safetensors` |
+| Source Checkpoint | `boltz2_conf_final.ckpt` |
+
+> [!NOTE]
+> Source checkpoint: `boltz2_conf_final.ckpt`.
+
+### Links
+
+- **Hub repository**: [oteam/boltz2](https://huggingface.co/oteam/boltz2)
+- **Upstream paper**: [Boltz-2: Towards Accurate and Efficient Binding Affinity Prediction](https://doi.org/10.1101/2025.06.14.659707)
+- **Upstream repository**: [Boltz-2](https://github.com/jwohlwend/boltz)
+- **Source checkpoint release**: [https://huggingface.co/boltzgen/boltzgen-1](https://huggingface.co/boltzgen/boltzgen-1)
+- **Code**: [`ofoldx/models/boltz2/model.py`](https://github.com/OTeam-AI4S/OFoldX/tree/main/ofoldx/models/boltz2/model.py)
+- **Project repository**: [https://github.com/OTeam-AI4S/OFoldX](https://github.com/OTeam-AI4S/OFoldX)
+- **Issues**: [https://github.com/OTeam-AI4S/OFoldX/issues](https://github.com/OTeam-AI4S/OFoldX/issues)
+
+## Usage
+
+The artifact depends on the [`ofoldx`](https://github.com/OTeam-AI4S/OFoldX) library. Install it with pip:
+
+```bash
+pip install ofoldx
+```
+
+### Pipeline Usage
+
+Load the artifact from `oteam/boltz2` with the OFoldX task pipeline. Use `AutoModel` or `AutoProcessor` only when you need lower-level control:
+
+```python
+from ofoldx.pipelines import Pipeline
+
+pipeline = Pipeline.from_pretrained("oteam/boltz2")
+output = pipeline(...)
+
+from ofoldx import AutoModel
+
+model = AutoModel.from_pretrained("oteam/boltz2")
+```
+
+When a matching processor is available, load it with `AutoProcessor.from_pretrained(...)` and pass the
+processed batch to the model.
+
+### Interface
+
+- **Task**: `structure_prediction`
+- **Artifact kind**: `model`
+- **Architecture**: `boltz2`
+- **Runtime files**: `manifest.json`, `config.json`, and `model.safetensors` when present
+
+## Training Details
+
+OFoldX did not train these weights. This repository contains a converted checkpoint and OFoldX runtime
+metadata for loading it.
+
+### Training Data
+
+The Boltz-2 report describes structure data from PDB structures before 2023-06-01, experimental NMR collections, MD trajectory datasets, AF2 monomer distillation, Boltz-1 complex distillation, and affinity data from PubChem, ChEMBL, BindingDB, and related filtered assay sources. OFoldX does not redistribute the training set.
+
+### Training Procedure
+
+Upstream Boltz-2 training is staged across structure, confidence, and affinity objectives. This OFoldX artifact converts a released checkpoint into `model.safetensors` plus an OFoldX manifest; it does not run Boltz-2 training.
+
+## Evaluation
+
+OFoldX conversion reports and contract tests validate artifact structure and checkpoint loading. Task-level
+scientific evaluation should be checked against the corresponding upstream model release or paper.
+
+## Limitations
+
+- This artifact is distributed for research use.
+- Inputs must match the model-specific processor and expected biomolecular representation.
+- OFoldX is pre-alpha, so APIs and artifact metadata may still change before a stable release.
+
+## Citation
+
+Please cite the upstream Boltz-2 work for the source checkpoint. If OFoldX supports your work, please also cite or link the OFoldX project repository.
+
+```bibtex
+@article{passaro2025boltz2,
+  author = {Passaro, Saro and Corso, Gabriele and Wohlwend, Jeremy and Reveiz, Mateo and Thaler, Stephan and Somnath, Vignesh Ram and Getz, Noah and Portnoi, Tally and Roy, Julien and Stark, Hannes and Kwabi-Addo, David and Beaini, Dominique and Jaakkola, Tommi and Barzilay, Regina},
+  title = {Boltz-2: Towards Accurate and Efficient Binding Affinity Prediction},
+  year = {2025},
+  doi = {10.1101/2025.06.14.659707},
+  journal = {bioRxiv}
+}
+```
+
+## Contact
+
+Please use [OFoldX GitHub issues](https://github.com/OTeam-AI4S/OFoldX/issues) for questions or comments about this model card.
+
+## License
+
+The Hub `license` metadata, when present, reflects the source checkpoint or upstream project license. The OFoldX project license is not yet finalized.
+The source checkpoint is associated with the upstream license noted above: MIT for upstream Boltz code and weights. Review both OFoldX and upstream terms before redistribution or production use.

predictor/manifest.json

@@ -0,0 +1,18 @@
+{
+  "format": "biomolecular_pretrained",
+  "format_version": 1,
+  "kind": "model",
+  "producer": {
+    "package": "ofoldx",
+    "version": "0.1.dev1+g9a78c7e44.d20260609"
+  },
+  "entrypoint": "ofoldx.models.boltz2.model.Boltz2Model",
+  "architecture": "boltz2",
+  "task": "structure_prediction",
+  "files": {
+    "config": "config.json"
+  },
+  "weights": {
+    "default": "model.safetensors"
+  }
+}

processor/manifest.json

@@ -0,0 +1,13 @@
+{
+  "format": "biomolecular_pretrained",
+  "format_version": 1,
+  "kind": "processor",
+  "producer": {
+    "package": "ofoldx",
+    "version": "0.1.dev1+g9a78c7e44.d20260609"
+  },
+  "entrypoint": "ofoldx.models.boltz2.processor.Boltz2Processor",
+  "files": {
+    "config": "processor_config.json"
+  }
+}

processor/processor_config.json

@@ -0,0 +1,6 @@
+{
+  "reference_conformer_augment": false,
+  "augment_seed": null,
+  "materialize_missing_atoms": false,
+  "method": "x-ray diffraction"
+}