| Name | roscribe JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | |
| Summary | Translate natural language into robot software. |
| upload_time | 2023-11-22 02:09:49 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 RoboCoach Inc Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
large language models
ai-assisted code generation
robotics
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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](https://github.com/RoboCoachTechnologies/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:
1. Creating a list of ROS nodes and topics, based on your application and deployment (e.g. simulation vs. real-world)
2. Visualizing your project in an RQT-style graph
3. Generating code for each ROS node
4. 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](https://index.ros.org/) is built, and using retrieval augmented generation (RAG), ROScribe can answer every question regarding relevant ROS packages for your project. Chekout [this wiki](https://github.com/RoboCoachTechnologies/ROScribe/wiki/3.-Explore-ROS-Repositories-with-RAG) for more information.
## How to use
Please see our wiki page to learn how to install and use ROScribe in your robotics projects:
* [Installation](https://github.com/RoboCoachTechnologies/ROScribe/wiki/1.-Installation)
* [ROS Package Generation using ROScribe](https://github.com/RoboCoachTechnologies/ROScribe/wiki/2.-ROS-Package-Generation)
* [Explore Open-source Robotics Repositories using ROScribe-RAG](https://github.com/RoboCoachTechnologies/ROScribe/wiki/3.-Explore-ROS-Repositories-with-RAG)
* [Create Your Own ROS Index Database](https://github.com/RoboCoachTechnologies/ROScribe/wiki/4.-Create-Your-Own-ROS-Index-Database)
## Demos
- [TurtleSim Code Generation with ROScribe](https://www.youtube.com/watch?v=H2QaeelkReU)
- [ROScribe-RAG Demo](https://www.youtube.com/watch?v=3b5FyZvlkxI&list=PLN8Hz7F2GjIkiYVForVuyvNs17sggQYOt&index=3)
## 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](https://discourse.ros.org/t/looking-inside-roscribe-and-the-idea-of-llm-based-robotic-platform/34298)
[Presentation slides of UCSD ROS workshop Oct. 27, 2023](docs/assets/ROScribeDeepDive.pdf)
[Video recording of UCSD ROS workshop presentation Oct. 27, 2023](https://www.youtube.com/watch?v=CPHleR-3Wko)
## Contact
For business inquiries, such as consulting or contracting jobs, please contact robocoachtechnologies@gmail.com.
Raw data
{
"_id": null,
"home_page": "",
"name": "roscribe",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Large Language Models,AI-assisted Code Generation,Robotics",
"author": "",
"author_email": "RoboCoach Technologies <robocoachtechnologies@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/6f/ef/a81408c4637ca30eba4dec6d2c94ec53a4289c9fef71025629c3289f46e6/roscribe-0.0.4.tar.gz",
"platform": null,
"description": "# ROScribe\n\n**Create ROS packages using LLMs.**\n\nUsing 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.\n\nInspired by [GPT Synthesizer](https://github.com/RoboCoachTechnologies/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:\n\n1. Creating a list of ROS nodes and topics, based on your application and deployment (e.g. simulation vs. real-world)\n2. Visualizing your project in an RQT-style graph\n3. Generating code for each ROS node\n4. Writing launch file and installation scripts\n\nIf you are new to ROS, ROScribe will be your robot(ics) mentor \ud83e\udd16\ufe0f\n\nIf you are a seasoned ROS user, ROScribe can help with creating a blueprint for your ROS package \ud83d\udce6\ufe0f\n\n**New in v0.0.4:**\nROScribe can now be used as your personal robotics consultant!\n\nA vector database of all open-source ROS repositories available on [ROS Index](https://index.ros.org/) is built, and using retrieval augmented generation (RAG), ROScribe can answer every question regarding relevant ROS packages for your project. Chekout [this wiki](https://github.com/RoboCoachTechnologies/ROScribe/wiki/3.-Explore-ROS-Repositories-with-RAG) for more information.\n\n## How to use\n\nPlease see our wiki page to learn how to install and use ROScribe in your robotics projects:\n* [Installation](https://github.com/RoboCoachTechnologies/ROScribe/wiki/1.-Installation)\n* [ROS Package Generation using ROScribe](https://github.com/RoboCoachTechnologies/ROScribe/wiki/2.-ROS-Package-Generation)\n* [Explore Open-source Robotics Repositories using ROScribe-RAG](https://github.com/RoboCoachTechnologies/ROScribe/wiki/3.-Explore-ROS-Repositories-with-RAG)\n* [Create Your Own ROS Index Database](https://github.com/RoboCoachTechnologies/ROScribe/wiki/4.-Create-Your-Own-ROS-Index-Database)\n\n## Demos\n\n- [TurtleSim Code Generation with ROScribe](https://www.youtube.com/watch?v=H2QaeelkReU)\n- [ROScribe-RAG Demo](https://www.youtube.com/watch?v=3b5FyZvlkxI&list=PLN8Hz7F2GjIkiYVForVuyvNs17sggQYOt&index=3)\n\n## Roadmap\n\nCurrently, ROScribe supports both ROS1 and ROS2 with Python code generation. We aim to add the following features in the coming releases:\n- C++ code generation\n- ROS1 to ROS2 automated codebase migration\n\nAs an open-source project, we encourage all robotics enthusiasts to contribute to ROScribe. During each release, we will announce the list of new contributors.\n\n## Additional documentations & articles\n\n[Looking inside ROScribe and the idea of LLM-based robotic platform](https://discourse.ros.org/t/looking-inside-roscribe-and-the-idea-of-llm-based-robotic-platform/34298) \n\n[Presentation slides of UCSD ROS workshop Oct. 27, 2023](docs/assets/ROScribeDeepDive.pdf)\n\n[Video recording of UCSD ROS workshop presentation Oct. 27, 2023](https://www.youtube.com/watch?v=CPHleR-3Wko)\n\n## Contact\n\nFor business inquiries, such as consulting or contracting jobs, please contact robocoachtechnologies@gmail.com. \n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 RoboCoach Inc Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Translate natural language into robot software.",
"version": "0.0.4",
"project_urls": {
"Bug Tracker": "https://github.com/RoboCoachTechnologies/ROScribe/issues",
"Homepage": "https://github.com/RoboCoachTechnologies/ROScribe"
},
"split_keywords": [
"large language models",
"ai-assisted code generation",
"robotics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "23bd1a0639a01834431bc113c9f44373c87eb69c2e5540aa81780110d2c65c78",
"md5": "45c2392dd39ebf726903e8a3f986484e",
"sha256": "d238fc3a1db239aa7ee2121619d07a426022b06fb6539056069def984afe9775"
},
"downloads": -1,
"filename": "roscribe-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "45c2392dd39ebf726903e8a3f986484e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 20244,
"upload_time": "2023-11-22T02:09:48",
"upload_time_iso_8601": "2023-11-22T02:09:48.490526Z",
"url": "https://files.pythonhosted.org/packages/23/bd/1a0639a01834431bc113c9f44373c87eb69c2e5540aa81780110d2c65c78/roscribe-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6fefa81408c4637ca30eba4dec6d2c94ec53a4289c9fef71025629c3289f46e6",
"md5": "3b3cf60306dabbf4e4501a53425122b4",
"sha256": "d782fcf3fcef8fb9672ca2c5540e482610a3b66c377e0b0366489a01443fdbe4"
},
"downloads": -1,
"filename": "roscribe-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "3b3cf60306dabbf4e4501a53425122b4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 19041,
"upload_time": "2023-11-22T02:09:49",
"upload_time_iso_8601": "2023-11-22T02:09:49.540796Z",
"url": "https://files.pythonhosted.org/packages/6f/ef/a81408c4637ca30eba4dec6d2c94ec53a4289c9fef71025629c3289f46e6/roscribe-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-22 02:09:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RoboCoachTechnologies",
"github_project": "ROScribe",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "roscribe"
}
