diff --git a/CITATION.cff b/CITATION.cff index 4a06ff2..4f17f20 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -8,4 +8,4 @@ authors: title: "Exploy: EXport and dePLOY Reinforcement Learning policies" date-released: 2026-03-11 version: 0.1.0 -url: "https://github.com/bdaiinstitute/exploy" +url: "https://github.com/rai-opensource/exploy" diff --git a/README.md b/README.md index 429392c..e4eb737 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ exploy/ ## Documentation -Exploy's documentation is available at [bdaiinstitute.github.io/exploy][docs]. +Exploy's documentation is available at [rai-opensource.github.io/exploy][docs]. To get started with the core concepts, refer to our step-by-step guides: - [**Exporter**][tutorial_exporter]: @@ -63,9 +63,9 @@ To get started with the core concepts, refer to our step-by-step guides: - [**Controller**][tutorial_controller]: Learn to deploy a trained policy on a robot using the C++ controller with ONNX Runtime integration. -[docs]: https://bdaiinstitute.github.io/exploy -[tutorial_exporter]: https://bdaiinstitute.github.io/exploy/tutorial/exporter/exporter_tutorial.html -[tutorial_controller]: https://bdaiinstitute.github.io/exploy/tutorial/controller/controller_tutorial.html +[docs]: https://rai-opensource.github.io/exploy +[tutorial_exporter]: https://rai-opensource.github.io/exploy/tutorial/exporter/exporter_tutorial.html +[tutorial_controller]: https://rai-opensource.github.io/exploy/tutorial/controller/controller_tutorial.html ## Installation and Usage @@ -75,13 +75,13 @@ To consume the Python package in your own project, the recommended approach is to install it directly from the git repository using `pip`: ```bash -pip install git+https://github.com/bdaiinstitute/exploy.git +pip install git+https://github.com/rai-opensource/exploy.git ``` To install with additional dependencies for `IsaacLab` integration: ```bash -pip install "exploy[isaaclab]@git+https://github.com/bdaiinstitute/exploy.git" +pip install "exploy[isaaclab]@git+https://github.com/rai-opensource/exploy.git" ``` ### C++ Controller Library @@ -89,7 +89,7 @@ pip install "exploy[isaaclab]@git+https://github.com/bdaiinstitute/exploy.git" To consume the C++ controller library, use plain CMake commands to build and install it on your system (or to a custom prefix): ```bash -git clone https://github.com/bdaiinstitute/exploy.git +git clone https://github.com/rai-opensource/exploy.git cd exploy cmake -S control/ -B build/ -DCMAKE_INSTALL_PREFIX=/path/to/install cmake --build build/ --parallel @@ -159,7 +159,7 @@ See the [Pixi installation guide][pixi_setup] for initial setup instructions. #### 1. Clone the repository ```bash -git clone https://github.com/bdaiinstitute/exploy.git +git clone https://github.com/rai-opensource/exploy.git cd exploy ``` @@ -293,6 +293,6 @@ button in the sidebar, or using the following BibTeX entry: title = {Exploy: EXport and dePLOY Reinforcement Learning policies}, month = {March}, year = {2026}, - url = {https://github.com/bdaiinstitute/exploy} + url = {https://github.com/rai-opensource/exploy} } ``` diff --git a/docs/conf.py b/docs/conf.py index bc735cd..ff577ee 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -72,7 +72,7 @@ "footer_icons": [ { "name": "GitHub", - "url": "https://github.com/bdaiinstitute/exploy", + "url": "https://github.com/rai-opensource/exploy", "html": '', "class": "", }, @@ -204,10 +204,7 @@ def setup(app): suppress_warnings = ["myst.xref_missing"] # Links that are valid but not yet publicly available (e.g. unreleased paths on GitHub) -linkcheck_ignore = [ - # The repository is private; GitHub returns 404 for unauthenticated requests. - r"https://github\.com/bdaiinstitute/exploy/", -] +linkcheck_ignore = [] # GitHub renders anchors client-side, so Sphinx linkcheck cannot verify them. linkcheck_anchors_ignore_for_url = [ diff --git a/docs/tutorial/controller/controller_tutorial.md b/docs/tutorial/controller/controller_tutorial.md index 70316bc..7d6ae1a 100644 --- a/docs/tutorial/controller/controller_tutorial.md +++ b/docs/tutorial/controller/controller_tutorial.md @@ -16,7 +16,7 @@ By the end of this tutorial you will know how to: 4. Load the ONNX model and run the closed-loop control cycle. > **Note:** A complete, runnable version of the code in this tutorial is available in -> [`examples/controller/`](https://github.com/bdaiinstitute/exploy/tree/main/examples/controller/). +> [`examples/controller/`](https://github.com/rai-opensource/exploy/tree/main/examples/controller/). > This tutorial explains the details behind that example step by step. > > **See also:** If you haven't exported your model yet, start with the diff --git a/docs/tutorial/exporter/exporter_tutorial.md b/docs/tutorial/exporter/exporter_tutorial.md index c1bd154..d50e97a 100644 --- a/docs/tutorial/exporter/exporter_tutorial.md +++ b/docs/tutorial/exporter/exporter_tutorial.md @@ -18,7 +18,7 @@ By the end of this tutorial you will know how to: 6. Validate the export by comparing ONNX outputs against the original environment. > **Note:** A complete, runnable version of the code in this tutorial is available as a test in -> [`python/exploy/exporter/core/tests/test_export_environment.py`](https://github.com/bdaiinstitute/exploy/blob/main/python/exploy/exporter/core/tests/test_export_environment.py). +> [`python/exploy/exporter/core/tests/test_export_environment.py`](https://github.com/rai-opensource/exploy/blob/main/python/exploy/exporter/core/tests/test_export_environment.py). > This tutorial explains the details behind that test step by step. ## Prerequisites @@ -435,7 +435,7 @@ debugging and visual inspection. You can inspect the exported ONNX file using [Netron](https://github.com/lutzroeder/netron), an open-source viewer for neural network models. The screenshots below show the computational graphs produced by the export steps in this tutorial. -The [unit test](https://github.com/bdaiinstitute/exploy/blob/main/python/exploy/exporter/core/tests/test_export_environment.py) +The [unit test](https://github.com/rai-opensource/exploy/blob/main/python/exploy/exporter/core/tests/test_export_environment.py) runs on three different environments: - an environment that computes observations and uses an MLP actor diff --git a/pyproject.toml b/pyproject.toml index b227467..3ece819 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -62,10 +62,10 @@ all = ["exploy[isaaclab]"] isaaclab = ["isaaclab"] [project.urls] -Changelog = "https://github.com/bdaiinstitute/exploy/releases" -Documentation = "https://bdaiinstitute.github.io/exploy" -Source = "https://github.com/bdaiinstitute/exploy" -Tracker = "https://github.com/bdaiinstitute/exploy/issues" +Changelog = "https://github.com/rai-opensource/exploy/releases" +Documentation = "https://rai-opensource.github.io/exploy" +Source = "https://github.com/rai-opensource/exploy" +Tracker = "https://github.com/rai-opensource/exploy/issues" # ========== # uv support