-
Notifications
You must be signed in to change notification settings - Fork 314
ruler docs #221
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
ruler docs #221
Conversation
a06259f
to
e4b23fc
Compare
docs/fundamentals/ruler.mdx
Outdated
# Use RULER to score them | ||
judged_group = await ruler_score_group( | ||
group, | ||
{"model": "openai/o3"}, |
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.
Why nest model in a dictionary, instead of making it a top-level parameter?
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.
lets us customize other litellm params, which is useful for eg. using a local model with a specific api endpoint.
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.
that said, model
is frequently going to be the only thing you need to customize. I'll make that its own explicit argument and have a separate one for additional litellm params.
docs/fundamentals/ruler.mdx
Outdated
if judged_group: # Check if judging succeeded | ||
for traj in judged_group.trajectories: | ||
print(f"Reward: {traj.reward}") | ||
print(f"RULER explanation: {traj.metrics['ruler_score']}") |
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.
Isn't metrics
usually composed of numerical values, as opposed to string explanations? Did you mean to reference a field in metadata
?
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.
ah good catch, fixed.
adding to the docs
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.
Awesome!
…litellm_params - Changed ruler() and ruler_score_group() to accept separate judge_model (str) and extra_litellm_params (dict) parameters - Updated all call sites to use the new signature - Updated documentation with new parameter structure and examples - Removed backward compatibility as this is a new feature 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
adding to the docs