-
Notifications
You must be signed in to change notification settings - Fork 398
Add documentation for User Simulation #863
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Thanks for this!
| ```json | ||
| { | ||
| "criteria": { | ||
| # same as before |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just wanted to make one quick callout that JSON doesn't support comments, and so this line renders the JSON as invalid - suggest removing this line. Otherwise thanks for the PR on this awesome new feature!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did this for compactness but I can restore it to be same as before. Alternatively I can reduce line count a bit by inlining some of the braces. WDYT?
Personally I'm fine with it as it is. The focus is the user sim config and copying the criteria is easy.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it. Since it's less than 10 additional lines to include, I would suggest including the full code. Otherwise users might get JSON errors if they try to copy/paste that EvalConfig as-is. But I don't consider it a blocking issue.
This commit adds documentation for the User Simulation feature in ADK, which is already available but currently undocumented.
Tested locally using
mkdocs serve.