Expand model card

README.md

@@ -29,14 +29,93 @@ widget:
 
 # boltz2
 
-This repository contains a biomolecular `model` artifact.
-It serves the `structure_prediction` task.
-The architecture is `boltz2`.
+OFoldX `model` artifact for biomolecular structure prediction, using the `boltz2` architecture.
 
-The artifact is described by `manifest.json`; runtime configuration and weights stay in their own files.
+## 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.
+
+### 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` |
+
+### Links
+
+- **Hub repository**: [oteam/boltz2](https://huggingface.co/oteam/boltz2)
+- **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
+```
+
+### Direct Use
+
+Load the artifact from `oteam/boltz2` using the OFoldX `Auto*` interface:
 
 ```python
 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
+
+The training data and training procedure are inherited from the upstream checkpoint release. They are not
+reproduced inside this OFoldX artifact unless additional source-specific metadata is provided in the files.
+
+## 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 model or paper associated with the source checkpoint. If OFoldX supports your work,
+please also cite or link the OFoldX project repository.
+
+## Contact
+
+Please use [OFoldX GitHub issues](https://github.com/OTeam-AI4S/OFoldX/issues) for questions or comments about this model card.
+
+## License
+
+The OFoldX project license is not yet finalized. The source checkpoint may carry additional upstream license
+terms; review both OFoldX and upstream terms before redistribution or production use.