docs: rai 2.0 update #554
docs: rai 2.0 update #554
Conversation
ba0c5b8 to
e1e60ed
Compare
|
@coderabbitai full review |
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
85486a9 to
82ddcfe
Compare
| Run the following command to build the whoami: | ||
|
|
||
| ```bash | ||
| python src/rai_whoami/rai_whoami/build_whoami.py panda/ --build-vector-db |
There was a problem hiding this comment.
Note: Running this command while using small models (e.g., llama3.1:8b) often leads (approximately 50% of the time) to various exceptions in the binascii.a2b_base64(s) method. Example:
Traceback (most recent call last):
File "/home/<user>/Work/Robotec/rai/src/rai_whoami/rai_whoami/build_whoami.py", line 56, in <module>
build_whoami(args)
File "/home/<user>/Work/Robotec/rai/src/rai_whoami/rai_whoami/build_whoami.py", line 43, in build_whoami
info.to_directory(args.output_dir)
File "/home/<user>/Work/Robotec/rai/src/rai_whoami/rai_whoami/models/models.py", line 180, in to_directory
f.write(base64.b64decode(image))
File "/usr/lib/python3.10/base64.py", line 87, in b64decode
return binascii.a2b_base64(s)
binascii.Error: Incorrect padding
There was a problem hiding this comment.
Please create an issue for the rai_whoami package
|
the rosbot demo is not working |
|
|
||
| ```bash | ||
| ros2 topic echo /to_human rai_interfaces/msg/HRIMessage | ||
| ``` |
There was a problem hiding this comment.
I would link manipulation demo in this walkthrough, so that it's possible to have something practically running at the end of this walkthrough. Without real panda robot or simulation, it'll be hard to see the effect of this tutorial.
There was a problem hiding this comment.
It's a tutorial, not a demo. It won't be easy to integrate the custom code with the demo. The only common thing is the generated whoami, but we will have the whoami already prepared for the manipulation demo.
There was a problem hiding this comment.
It won't be easy to integrate the custom code with the demo.
One idea might be to just do a walkthrough using the manipulation demo and as an example reimplement for the sake of the tutorial one of already implemented tools. For example GetROS2Image tool is fairly simple. Then the tutorial can be interactive.
but we will have the whoami already prepared for the manipulation demo.
We might we the same mechanism at it was in the turtlebot demo. You can generate your own whoami or download a zip with pregenerated files.
There was a problem hiding this comment.
One idea might be to just do a walkthrough using the manipulation demo and as an example reimplement for the sake of the tutorial one of already implemented tools. For example GetROS2Image tool is fairly simple. Then the tutorial can be interactive.
Sure, but this is a walkthrough through rai core abstractions for new use-cases. If you feel like this is important please do a PR with new tutorial on that topic.
We might we the same mechanism at it was in the turtlebot demo. You can generate your own whoami or download a zip with pregenerated files.
A single, fine-tuned json file will be provided in the repository (for the demos).
There was a problem hiding this comment.
I would merge this file with index.md, because some info is repeated. Or (less preferable) make mutual sections separate files.
There was a problem hiding this comment.
The idea was to give an extended view of what rai is as well as answer common questions. The content will of course repeat, as the overview already provides some context.
There was a problem hiding this comment.
I understand and I think that it's a very good idea. I just think that structure of the what_is_rai is nice and should also be in the main page. I mean sections:
- Quick Start
... - How RAI Works
- Community & Support
- Learn More
If you think they should be in the what_is_rai page, it's fine to just copy-paste.
chore: update rai demos link
docs: minor adjustments
Co-authored-by: Dominik Matejkowski <63610203+Cytrus14@users.noreply.github.com>
Co-authored-by: Bartłomiej Boczek <bartlomiej.boczek@robotec.ai>
Co-authored-by: Bartek Boczek <bartlomiej.boczek@robotec.ai>
Co-authored-by: Bartłomiej Boczek <bartlomiej.boczek@robotec.ai>
Co-authored-by: Bartek Boczek <bartlomiej.boczek@robotec.ai>
|
Moving issues to #461 (comment) |
There was a problem hiding this comment.
Approving. Rest of the comments will be resolved under this issue: #461 (comment)
Purpose
Finalizing RAI 2.0 with revamped documentation.
Proposed Changes
Docs
Issues
Closes 171
Testing
Eyes + python interpreter for code snippets: https://RobotecAI.github.io/rai/
local setup: