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.

Sign up for GitHub

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

Jump to bottom

Update evaluation documentation #571

Merged
merged 2 commits into from
May 23, 2024
Merged

Update evaluation documentation #571

merged 2 commits into from
May 23, 2024

Conversation

kcortinas
Copy link
Collaborator

closes #304

This PR updates the following:

  • README.md: improve clarity around the metrics included in the accelerator, description of evaluation reports and common pitfalls.
  • evaluation-metrics.md: make clear how cosine similarity is computed
  • eval.py: update cosine description. Fix experiment name bug.

julia-meshcheryakova
julia-meshcheryakova approved these changes May 23, 2024
View reviewed changes
Copy link
Collaborator

@julia-meshcheryakova julia-meshcheryakova left a comment

Choose a reason for hiding this comment

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

LGTM

@julia-meshcheryakova julia-meshcheryakova added this pull request to the merge queue May 23, 2024
Merged via the queue into development with commit 91817d2 May 23, 2024
3 checks passed
@julia-meshcheryakova julia-meshcheryakova deleted the karina/update-eval-docs branch August 6, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@julia-meshcheryakova julia-meshcheryakova julia-meshcheryakova approved these changes

@ritesh-modi ritesh-modi Awaiting requested review from ritesh-modi

@joanassantos joanassantos Awaiting requested review from joanassantos

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update documentation for the metrics
2 participants
@kcortinas @julia-meshcheryakova