Improve model card and add metadata
Browse filesHi! I'm Niels from the Hugging Face community team. I've opened this PR to improve the model card for SafeFlowMPC by:
- Adding the `pipeline_tag: robotics` metadata to improve discoverability.
- Linking the paper, project page, and GitHub repository.
- Adding a "Usage" section with installation and inference instructions based on the repository's README.
- Adding the BibTeX citation for the paper.
This should help users better understand and use the artifact.
README.md
CHANGED
|
@@ -1,5 +1,6 @@
|
|
| 1 |
---
|
| 2 |
license: mit
|
|
|
|
| 3 |
tags:
|
| 4 |
- safety
|
| 5 |
- constraints
|
|
@@ -8,8 +9,46 @@ tags:
|
|
| 8 |
- robotics
|
| 9 |
---
|
| 10 |
|
| 11 |
-
# SafeFlowMPC
|
| 12 |
|
| 13 |
-
SafeFlowMPC
|
| 14 |
|
| 15 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
license: mit
|
| 3 |
+
pipeline_tag: robotics
|
| 4 |
tags:
|
| 5 |
- safety
|
| 6 |
- constraints
|
|
|
|
| 9 |
- robotics
|
| 10 |
---
|
| 11 |
|
| 12 |
+
# SafeFlowMPC: Predictive and Safe Trajectory Planning for Robot Manipulators with Learning-based Policies
|
| 13 |
|
| 14 |
+
SafeFlowMPC is a framework that combines flow matching and online optimization to ensure safety for robot manipulators using learning-based policies. This method provides rigorous safety guarantees at all times and is designed for real-time execution.
|
| 15 |
|
| 16 |
+
- **Paper:** [SafeFlowMPC: Predictive and Safe Trajectory Planning for Robot Manipulators with Learning-based Policies](https://huggingface.co/papers/2602.12794)
|
| 17 |
+
- **Project Page:** [ACIN - SafeFlowMPC](https://www.acin.tuwien.ac.at/en/42d6)
|
| 18 |
+
- **GitHub Repository:** [TU-Wien-ACIN-CDS/SafeFlowMPC](https://github.com/TU-Wien-ACIN-CDS/SafeFlowMPC)
|
| 19 |
+
|
| 20 |
+
## Usage
|
| 21 |
+
|
| 22 |
+
To use these models, please refer to the official [GitHub repository](https://github.com/TU-Wien-ACIN-CDS/SafeFlowMPC).
|
| 23 |
+
|
| 24 |
+
### Installation
|
| 25 |
+
|
| 26 |
+
```bash
|
| 27 |
+
pip install -r requirements.txt
|
| 28 |
+
pip install -e .
|
| 29 |
+
```
|
| 30 |
+
|
| 31 |
+
### Running Inference
|
| 32 |
+
|
| 33 |
+
You can run the example experiments using the provided global planner script. The script is configured to automatically load the required checkpoints from Hugging Face if they are not found locally.
|
| 34 |
+
|
| 35 |
+
```bash
|
| 36 |
+
python inference_global_planner.py
|
| 37 |
+
```
|
| 38 |
+
|
| 39 |
+
Optionally, you can enable random replanning with the `--replan` flag:
|
| 40 |
+
|
| 41 |
+
```bash
|
| 42 |
+
python inference_global_planner.py --replan
|
| 43 |
+
```
|
| 44 |
+
|
| 45 |
+
## Citation
|
| 46 |
+
|
| 47 |
+
```bibtex
|
| 48 |
+
@inproceedings{oelerich2026safeflowmpc,
|
| 49 |
+
title={SafeFlowMPC: Predictive and Safe Trajectory Planning for Robot Manipulators with Learning-based Policies},
|
| 50 |
+
author={Oelerich, Thies and Ebmer, Gerald and Hartl-Nesic, Christian and Kugi, Andreas},
|
| 51 |
+
booktitle={IEEE International Conference on Robotics and Automation (ICRA)},
|
| 52 |
+
year={2026}
|
| 53 |
+
}
|
| 54 |
+
```
|