minseokbae
commited on
Commit
•
f2df309
1
Parent(s):
6f45869
Updated README
Browse files
README.md
CHANGED
@@ -23,7 +23,13 @@ widget:
|
|
23 |
---
|
24 |
<img src="candle.png" width="50" height="50" style="display: inline;"> In Loving memory of Simon Mark Hughes...
|
25 |
|
26 |
-
#
|
|
|
|
|
|
|
|
|
|
|
|
|
27 |
This model was trained using [SentenceTransformers](https://sbert.net) [Cross-Encoder](https://www.sbert.net/examples/applications/cross-encoder/README.html) class.
|
28 |
The model outputs a probabilitity from 0 to 1, 0 being a hallucination and 1 being factually consistent.
|
29 |
The predictions can be thresholded at 0.5 to predict whether a document is consistent with its source.
|
@@ -38,9 +44,11 @@ This model is based on [microsoft/deberta-v3-base](https://huggingface.co/micros
|
|
38 |
* [AnyScale Ranking Test for Hallucinations](https://www.anyscale.com/blog/llama-2-is-about-as-factually-accurate-as-gpt-4-for-summaries-and-is-30x-cheaper) - 86.6 % Accuracy
|
39 |
|
40 |
## LLM Hallucination Leaderboard
|
41 |
-
If you want to stay up to date with results of the latest tests using this model to evaluate the top LLM models, a public leaderboard is
|
42 |
|
43 |
-
|
|
|
|
|
44 |
To use the model with the widget, you need to pass both documents as a single string separated with [SEP]. For example:
|
45 |
|
46 |
* A man walks into a bar and buys a drink [SEP] A bloke swigs alcohol at a pub
|
@@ -148,7 +156,9 @@ array([0.61051559, 0.00047493709, 0.99639291, 0.00021221573, 0.99599433, 0.00141
|
|
148 |
```
|
149 |
|
150 |
## Contact Details
|
151 |
-
Feel free to contact us
|
152 |
* X/Twitter - https://twitter.com/vectara or http://twitter.com/ofermend
|
153 |
* Discussion [forums](https://discuss.vectara.com/)
|
154 |
-
* Discord [server](https://discord.gg/GFb8gMz6UH)
|
|
|
|
|
|
23 |
---
|
24 |
<img src="candle.png" width="50" height="50" style="display: inline;"> In Loving memory of Simon Mark Hughes...
|
25 |
|
26 |
+
# Introduction
|
27 |
+
The HHEM model is an open source model, created by [Vectara](https://vectara.com), for detecting hallucinations in LLMs. It is particularly useful in the context of building retrieval-augmented-generation (RAG) applications where a set of facts is summarized by an LLM, but the model can also be used in other contexts.
|
28 |
+
|
29 |
+
If you are interested to learn more about RAG or experiment with Vectara, you can [sign up](https://console.vectara.com/signup) for a free Vectara account.
|
30 |
+
Now let's dive into the details of the model.
|
31 |
+
|
32 |
+
## Cross-Encoder for Hallucination Detection
|
33 |
This model was trained using [SentenceTransformers](https://sbert.net) [Cross-Encoder](https://www.sbert.net/examples/applications/cross-encoder/README.html) class.
|
34 |
The model outputs a probabilitity from 0 to 1, 0 being a hallucination and 1 being factually consistent.
|
35 |
The predictions can be thresholded at 0.5 to predict whether a document is consistent with its source.
|
|
|
44 |
* [AnyScale Ranking Test for Hallucinations](https://www.anyscale.com/blog/llama-2-is-about-as-factually-accurate-as-gpt-4-for-summaries-and-is-30x-cheaper) - 86.6 % Accuracy
|
45 |
|
46 |
## LLM Hallucination Leaderboard
|
47 |
+
If you want to stay up to date with results of the latest tests using this model to evaluate the top LLM models, we have a [public leaderboard](https://huggingface.co/spaces/vectara/leaderboard) that is periodically updated, and results are also available on the [GitHub repository](https://github.com/vectara/hallucination-leaderboard).
|
48 |
|
49 |
+
# Using HHEM
|
50 |
+
|
51 |
+
## Using the Inference API Widget on the Right
|
52 |
To use the model with the widget, you need to pass both documents as a single string separated with [SEP]. For example:
|
53 |
|
54 |
* A man walks into a bar and buys a drink [SEP] A bloke swigs alcohol at a pub
|
|
|
156 |
```
|
157 |
|
158 |
## Contact Details
|
159 |
+
Feel free to contact us with any questions:
|
160 |
* X/Twitter - https://twitter.com/vectara or http://twitter.com/ofermend
|
161 |
* Discussion [forums](https://discuss.vectara.com/)
|
162 |
+
* Discord [server](https://discord.gg/GFb8gMz6UH)
|
163 |
+
|
164 |
+
For more information about [Vectara](https://vectara.com) and how to use our RAG-as-a-service API platform, check out our [documentation](https://docs.vectara.com/docs/).
|