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(evals): Updated docs for evals #1512

Merged
merged 16 commits into from
Jan 16, 2025
Merged

docs(evals): Updated docs for evals #1512

merged 16 commits into from
Jan 16, 2025

Conversation

ssbushi
Copy link
Contributor

@ssbushi ssbushi commented Dec 13, 2024

Part of #985

Checklist (if applicable):

@ssbushi ssbushi marked this pull request as ready for review December 13, 2024 04:25
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

@mjchristy mjchristy left a comment

Choose a reason for hiding this comment

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

Overall, this LGTM. I wonder if we need to give them a RAG flow to evaluate, esp. given that we chose 'maliciousness'.

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

ssbushi commented Dec 18, 2024

Overall, this LGTM. I wonder if we need to give them a RAG flow to evaluate, esp. given that we chose 'maliciousness'.

Maliciousness is not RAG specific.

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

@thedmail thedmail left a comment

Choose a reason for hiding this comment

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

General observations:

  • Informal tone is fine, but avoid "chatty". (E.g., "Now, we'll" or "Let's...")
  • Avoid future tense and passive voice
  • Always break lines at <= 80 cols

Please review second doc (plugin) and make similar edits, based on what I've done in the first doc.

docs/plugin-authoring-evaluator.md Outdated Show resolved Hide resolved
docs/evaluation.md Outdated Show resolved Hide resolved
docs/evaluation.md Outdated Show resolved Hide resolved
docs/evaluation.md Outdated Show resolved Hide resolved
docs/evaluation.md Outdated Show resolved Hide resolved
docs/evaluation.md Outdated Show resolved Hide resolved
docs/evaluation.md Outdated Show resolved Hide resolved
docs/evaluation.md Outdated Show resolved Hide resolved
docs/evaluation.md Outdated Show resolved Hide resolved
docs/evaluation.md Outdated Show resolved Hide resolved
@ssbushi ssbushi requested a review from thedmail January 9, 2025 18:39
docs/evaluation.md Outdated Show resolved Hide resolved
docs/evaluation.md Outdated Show resolved Hide resolved
docs/evaluation.md Outdated Show resolved Hide resolved
docs/evaluation.md Show resolved Hide resolved
docs/evaluation.md Outdated Show resolved Hide resolved
@ssbushi ssbushi requested a review from thedmail January 16, 2025 16:50
docs/evaluation.md Outdated Show resolved Hide resolved
@ssbushi ssbushi merged commit 3c31306 into main Jan 16, 2025
4 checks passed
@ssbushi ssbushi deleted the sb/evalsDocs branch January 16, 2025 22:42
thedmail added a commit that referenced this pull request Jan 17, 2025
Revisions to this file, as submitted in [PR #1512](#1512)
thedmail added a commit that referenced this pull request Jan 18, 2025
Revisions to this file, as submitted in [PR #1512](#1512)
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.

3 participants