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

[FIX] Fix documentation inconsistency in Dummy Agent Library examples #147

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

gabyorel
Copy link
Contributor

The documentation on the Dummy Agent Library page contains an inconsistency between the system prompt template and the expected model output.

Problem

The prompt template specifies that the model should first generate a "Thought" before an "Action".
However, the example output shown in the documentation displays the "Action" first, followed by the "Thought".
It can be misleading, as it suggests that "Action" should come first, contradicting the system prompt instructions.

Fix

Change the examples output to expected outputs

Please let me know if you need any further changes or if anything in the pull request doesn't look good to you.

@gabyorel gabyorel changed the title [UNIT] Fix documentation inconsistency in Dummy Agent Library examples Fix documentation inconsistency in Dummy Agent Library examples Feb 17, 2025
@burtenshaw burtenshaw requested a review from Jofthomas February 18, 2025 08:56
@burtenshaw burtenshaw changed the title Fix documentation inconsistency in Dummy Agent Library examples [FIX] Fix documentation inconsistency in Dummy Agent Library examples Feb 18, 2025
@burtenshaw burtenshaw removed the request for review from Jofthomas February 18, 2025 09:05
@burtenshaw
Copy link
Collaborator

Thanks for the PR.

I'm not sure on the intention of the example here. IMO, the released example is ok.

@Jofthomas Could you confirm?

@gabyorel
Copy link
Contributor Author

Here are two screenshots showing the differences: the first one is the result from the notebook, and the second one is from the documentation.

Capture d’écran 2025-02-18 à 10 22 33

Capture d’écran 2025-02-18 à 10 24 13

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.

3 participants