Skip to content

Commit f3735a9

Browse files
dbellicoso-bdaiexploy-bot
authored andcommitted
Update readme (#71)
# Pull Request ### What change is being made Update readme. ### Why this change is being made N//A ### Tested N/A GitOrigin-RevId: 89fb7c1ea4406965f26f53d8c87f50798ae00fc8
1 parent 2f2a19f commit f3735a9

2 files changed

Lines changed: 33 additions & 2 deletions

File tree

CITATION.cff

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software, please cite it as below."
3+
authors:
4+
- family-names: "Bellicoso"
5+
given-names: "Dario"
6+
- family-names: "Wollschläger"
7+
given-names: "Annika"
8+
title: "Exploy: EXport and dePLOY Reinforcement Learning policies"
9+
date-released: 2026-03-11
10+
version: 0.1.0
11+
url: "https://github.com/bdaiinstitute/exploy"

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ EXport and dePLOY Reinforcement Learning policies.
44

55
The core idea lies in a "self-contained" export approach:
66
Rather than exporting only the neural network policy, this tool captures the entire environment
7-
logicincluding observation generation and action processinginto a single ONNX file.
7+
logic, including observation generation and action processing, into a single ONNX file.
88
By tracing Torch operations from the simulation environment, the exporter embeds the computational
99
layers required to transform raw robot state interfaces into policy inputs and policy outputs into
1010
executable commands.
@@ -13,6 +13,8 @@ By encapsulating the environment's computation graph within the model file itsel
1313
this library minimizes operational effort and maximizes confidence that a policy will behave
1414
identically in simulation and on physical hardware.
1515

16+
Authors: Dario Bellicoso, Annika Wollschläger
17+
1618
## Features
1719

1820
- **Environment Exporting**: Export RL environments and policies from
@@ -25,7 +27,7 @@ identically in simulation and on physical hardware.
2527
## Project Structure
2628

2729
- `control/`: C++ controller library with ONNX Runtime integration
28-
- `exporter/`: Python exporter package for policy and environment export
30+
- `exploy/`: Python exporter package for policy and environment export
2931
- `examples/`: Usage examples for supported frameworks
3032
- `docs/`: Documentation source files
3133

@@ -83,6 +85,9 @@ pixi run export-isaaclab
8385
import exploy.exporter.core as exporter
8486
from exploy.exporter.frameworks.isaaclab.env import IsaacLabExportableEnvironment
8587

88+
# Create an environment.
89+
env = . . .
90+
8691
# Create an exportable environment from a ManagerBasedRLEnv
8792
exportable_env = IsaacLabExportableEnvironment(env)
8893

@@ -269,3 +274,18 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE)
269274
file for details.
270275

271276
Copyright (c) 2026 Robotics and AI Institute LLC dba RAI Institute
277+
278+
## Citation
279+
280+
If you use this work in your research or project, please consider citing it using the 'Cite this repository'
281+
button in the sidebar, or using:
282+
283+
```bibtex
284+
@misc{exploy2026,
285+
author = {Dario Bellicoso, Annika Wollschläger},
286+
title = {Exploy: EXport and dePLOY Reinforcement Learning policies},
287+
month = {March},
288+
year = {2026},
289+
url = {https://github.com/bdaiinstitute/exploy}
290+
}
291+
```

0 commit comments

Comments
 (0)