Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: developer guide #158

Merged
merged 7 commits into from
Aug 27, 2024
Merged

docs: developer guide #158

merged 7 commits into from
Aug 27, 2024

Conversation

maciejmajek
Copy link
Member

@maciejmajek maciejmajek commented Aug 23, 2024

Purpose

Explaining idea behind RAI, showcasing RAI's adaptability with quickstart snippet and developer guide.

Proposed Changes

Adding developer guide, docs enhancements

Issues

Testing

Provided snippets were tested.

@maciejmajek maciejmajek force-pushed the docs/developer-guide branch from 023abd7 to 1558f31 Compare August 23, 2024 15:41
@maciejmajek maciejmajek requested a review from adamdbrw August 23, 2024 15:55
@maciejmajek maciejmajek marked this pull request as ready for review August 23, 2024 15:55
def state_retriever():
"""State retriever used for feeding state information
to agent every iteration"""
return {"temperature": 30, "battery_state": 33}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't fit the rest much

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see the following comments

docs/developer_guide.md Show resolved Hide resolved
agent = create_state_based_agent(llm=llm, state_retriever=state_retriever, tools=tools)
system_prompt = "You are a cow. You are in a field. "
user_prompt = (
"Please eat the grass 3 times as a cover, then run away at first possibility."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a cover?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo, cover up/disguise. I've removed this example in favor of a simple ROS2 Agent

docs/developer_guide.md Outdated Show resolved Hide resolved
@maciejmajek maciejmajek requested a review from adamdbrw August 26, 2024 21:41
@maciejmajek maciejmajek force-pushed the docs/developer-guide branch from 8870afe to b2b7606 Compare August 27, 2024 12:28
docs/developer_guide.md Outdated Show resolved Hide resolved
src/rai/rai/apps/high_level_api.py Show resolved Hide resolved
docs/developer_guide.md Outdated Show resolved Hide resolved
docs/developer_guide.md Outdated Show resolved Hide resolved
maciejmajek and others added 7 commits August 27, 2024 14:54
feat: implement high_level_api
refactor: move conversational agent to rai.agents
fix: add _all__ to rai main init file
Co-authored-by: Adam Dąbrowski <adam.dabrowski@robotec.ai>
@maciejmajek maciejmajek force-pushed the docs/developer-guide branch from 8d9a3bd to 33cd848 Compare August 27, 2024 12:54
@maciejmajek maciejmajek merged commit a462790 into development Aug 27, 2024
@maciejmajek maciejmajek deleted the docs/developer-guide branch August 27, 2024 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants