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: update evals docs #1394

Merged
merged 4 commits into from
Nov 27, 2024
Merged

docs: update evals docs #1394

merged 4 commits into from
Nov 27, 2024

Conversation

ssbushi
Copy link
Contributor

@ssbushi ssbushi commented Nov 25, 2024

Fix #1391

Checklist (if applicable):

  • Docs updated

@ssbushi ssbushi changed the title Update evals docs [Docs] Update evals docs Nov 25, 2024
@ssbushi ssbushi requested a review from chrisraygill November 25, 2024 19:48
@ssbushi ssbushi marked this pull request as ready for review November 25, 2024 19:49
Copy link
Contributor

@chrisraygill chrisraygill left a comment

Choose a reason for hiding this comment

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

In samples, it's unclear where the ai instance, z, and potentially other imports are coming from.

docs/evaluation.md Outdated Show resolved Hide resolved
docs/evaluation.md Outdated Show resolved Hide resolved
docs/evaluation.md Outdated Show resolved Hide resolved
Copy link
Contributor

@chrisraygill chrisraygill left a comment

Choose a reason for hiding this comment

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

Where are ModelArgument and ModelReference imported from?

Copy link
Contributor

@chrisraygill chrisraygill left a comment

Choose a reason for hiding this comment

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

on line 128, should defineEvaluator be ai.defineEvaluator ?

docs/evaluation.md Outdated Show resolved Hide resolved
docs/evaluation.md Outdated Show resolved Hide resolved
docs/plugin-authoring-evaluator.md Show resolved Hide resolved
@pavelgj
Copy link
Collaborator

pavelgj commented Nov 26, 2024

please follow https://www.conventionalcommits.org/en/v1.0.0/ for PRs

@pavelgj pavelgj changed the title [Docs] Update evals docs docs: update evals docs Nov 26, 2024
@ssbushi ssbushi merged commit 6a2b296 into main Nov 27, 2024
4 checks passed
@ssbushi ssbushi deleted the sb/evalDocsUpdates branch November 27, 2024 15:52
pavelgj pushed a commit that referenced this pull request Nov 30, 2024
---------

Co-authored-by: Chris Ray Gill <chgill@google.com>
pavelgj pushed a commit that referenced this pull request Nov 30, 2024
---------

Co-authored-by: Chris Ray Gill <chgill@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[Docs] Evals documentation missing some crucial context / information.
3 participants