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

separating rag metrics and adding bge metrics - catalog non backward compatible change #1104

Merged
merged 14 commits into from
Aug 5, 2024

Conversation

assaftibm
Copy link
Member

@assaftibm assaftibm commented Aug 1, 2024

I reorganized some of the rag metrics, now we have:

For context correctness:

metrics.rag.context_correctness
metrics.rag.context_correctness/map
metrics.rag.context_correctness/mrr
metrics.rag.context_correctness/retrieval_at_k

For context relevance:

metrics.rag.context_relevance
metrics.rag.context_relevance/perplexity
metrics.rag.context_relevance/sentence_bert

For faithfulness:

metrics.rag.faithfulness
metrics.rag.faithfulness.token_k_precision
metrics.rag.faithfulness.bert_score_k_precision
metrics.rag.faithfulness.bert_score_k_precision_ml
metrics.rag.faithfulness.sentence_bert

For answer correctness:

metrics.rag.answer_correctness
metrics.rag.answer_correctness.token_recall
metrics.rag.answer_correctness.bert_score_recall
metrics.rag.answer_correctness.bert_score_recall_ml
metrics.rag.answer_correctness.sentence_bert

Some of these were originally in a different location / name - listed in gray below:

Also added the sentence bert metric with BGE large 1.5 to catalog.
image

@assaftibm assaftibm requested a review from yoavkatz August 2, 2024 15:20
@assaftibm
Copy link
Member Author

I'm not sure what this error means -

{'file': '/home/runner/work/unitxt/unitxt/src/unitxt/catalog/metrics/rag/answer_correctness/sentence_bert.json', 'diff': 'old only'}
{'file': '/home/runner/work/unitxt/unitxt/src/unitxt/catalog/metrics/rag/context_perplexity.json', 'diff': 'old only'}
{'file': '/home/runner/work/unitxt/unitxt/src/unitxt/catalog/metrics/rag/context_relevance/sentence_bert.json', 'diff': 'old only'}
{'file': '/home/runner/work/unitxt/unitxt/src/unitxt/catalog/metrics/rag/faithfulness/sentence_bert.json', 'diff': 'old only'}

The sentence_bert.json files are new
The context_perplexity.json hasn't changed.

@assaftibm assaftibm requested a review from matanor August 2, 2024 15:49
@assaftibm
Copy link
Member Author

I din't understand any of the CI/CD errors.

@yoavkatz
Copy link
Member

yoavkatz commented Aug 2, 2024

I'm not sure what this error means -

{'file': '/home/runner/work/unitxt/unitxt/src/unitxt/catalog/metrics/rag/answer_correctness/sentence_bert.json', 'diff': 'old only'}
{'file': '/home/runner/work/unitxt/unitxt/src/unitxt/catalog/metrics/rag/context_perplexity.json', 'diff': 'old only'}
{'file': '/home/runner/work/unitxt/unitxt/src/unitxt/catalog/metrics/rag/context_relevance/sentence_bert.json', 'diff': 'old only'}
{'file': '/home/runner/work/unitxt/unitxt/src/unitxt/catalog/metrics/rag/faithfulness/sentence_bert.json', 'diff': 'old only'}

The sentence_bert.json files are new The context_perplexity.json hasn't changed.

What this means is that if we delete all the json files in the catalog and regenerate them fton the prepare python files, these 4 files are not generated. Most likely these are json files which were committed, but later changed location in the prepare files.

@assaftibm assaftibm enabled auto-merge (squash) August 2, 2024 21:29
@assaftibm
Copy link
Member Author

Thanks, all pass now except for Test HELM Integration / test-helm

@yoavkatz yoavkatz changed the title separating rag metrics and adding bge metrics. separating rag metrics and adding bge metrics - catalog non backward compatible change Aug 4, 2024
@assaftibm assaftibm marked this pull request as draft August 4, 2024 07:19
auto-merge was automatically disabled August 4, 2024 07:19

Pull request was converted to draft

@assaftibm assaftibm self-assigned this Aug 4, 2024
@yoavkatz
Copy link
Member

yoavkatz commented Aug 4, 2024

Do you want to change it from Draft?

@assaftibm assaftibm marked this pull request as ready for review August 5, 2024 07:09
@assaftibm
Copy link
Member Author

finished the reorg of another metric (context correctness) and removed the draft status.

@assaftibm assaftibm enabled auto-merge (squash) August 5, 2024 07:11
@assaftibm assaftibm merged commit 5ec297f into main Aug 5, 2024
8 checks passed
@assaftibm assaftibm deleted the rag_metrics_separation branch August 5, 2024 07:39
csrajmohan pushed a commit that referenced this pull request Aug 29, 2024
…compatible change (#1104)

* separating rag metrics and adding bge metrics.

* updates

* updates

* updates

* updates

* updates

* updates

* updates

* updates

* updates

* updates

* updates
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants