Translate natural language into robot software.
Project description
ROScribe
Create ROS packages using LLMs.
Using a natural language interface to describe robotic projects, ROScribe eliminates the skill barrier of using ROS for beginners, and saves time and hassle for skilled engineers. ROScribe combines the sheer power and flexibility of large language models (LLMs) with prompt tuning techniques to capture the details of your robotic design and to automatically create an entire ROS package for your project.
Inspired by GPT Synthesizer, ROScribe builds an entire ROS package through a series of specification steps that identify the package elements in a top-down approach. In particular, ROScribe helps you with the following steps:
- Creating a list of ROS nodes and topics, based on your application and deployment (e.g. simulation vs. real-world)
- Visualizing your project in an RQT-style graph
- Generating code for each ROS node
- Writing launch file and installation scripts
If you are new to ROS, ROScribe will be your robot(ics) mentor 🤖️
If you are a seasoned ROS user, ROScribe can help with creating a blueprint for your ROS package 📦️
New in v0.0.4: ROScribe can now be used as your personal robotics consultant!
A vector database of all open-source ROS repositories available on ROS Index is built, and using retrieval augmented generation (RAG), ROScribe can answer every question regarding relevant ROS packages for your project. Chekout this wiki for more information.
How to use
Please see our wiki page to learn how to install and use ROScribe in your robotics projects:
- Installation
- ROS Package Generation using ROScribe
- Explore Open-source Robotics Repositories using ROScribe-RAG
- Create Your Own ROS Index Database
Demos
Roadmap
Currently, ROScribe supports both ROS1 and ROS2 with Python code generation. We aim to add the following features in the coming releases:
- C++ code generation
- ROS1 to ROS2 automated codebase migration
As an open-source project, we encourage all robotics enthusiasts to contribute to ROScribe. During each release, we will announce the list of new contributors.
Additional documentations & articles
Looking inside ROScribe and the idea of LLM-based robotic platform
Presentation slides of UCSD ROS workshop Oct. 27, 2023
Video recording of UCSD ROS workshop presentation Oct. 27, 2023
Contact
For business inquiries, such as consulting or contracting jobs, please contact robocoachtechnologies@gmail.com.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file roscribe-0.0.4.tar.gz
.
File metadata
- Download URL: roscribe-0.0.4.tar.gz
- Upload date:
- Size: 19.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d782fcf3fcef8fb9672ca2c5540e482610a3b66c377e0b0366489a01443fdbe4 |
|
MD5 | 3b3cf60306dabbf4e4501a53425122b4 |
|
BLAKE2b-256 | 6fefa81408c4637ca30eba4dec6d2c94ec53a4289c9fef71025629c3289f46e6 |
File details
Details for the file roscribe-0.0.4-py3-none-any.whl
.
File metadata
- Download URL: roscribe-0.0.4-py3-none-any.whl
- Upload date:
- Size: 20.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d238fc3a1db239aa7ee2121619d07a426022b06fb6539056069def984afe9775 |
|
MD5 | 45c2392dd39ebf726903e8a3f986484e |
|
BLAKE2b-256 | 23bd1a0639a01834431bc113c9f44373c87eb69c2e5540aa81780110d2c65c78 |