dvilasuero HF staff commited on
Commit
b9ad619
1 Parent(s): ed2d450

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +22 -3
README.md CHANGED
@@ -11,7 +11,7 @@ datasets:
11
 
12
  # 😵‍💫🦙 Alpaca HalluciHunter
13
 
14
- This is a cross-lingual SetFit model to **detect bad instructions from Alpaca Datasets** and potentially other instruction-following datasets. This model can greatly speed up the validation of Alpaca Datasets, flagging examples that need to be fixed or simply discarded.
15
 
16
 
17
  <div style="text-align:center">
@@ -25,6 +25,26 @@ It's a binary classifier with two labels:
25
  - `ALL GOOD`, a given instruction, input, and output are correct,
26
  - `BAD INSTRUCTION`, there's an issue with the instruction, and/or input and output.
27
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
28
 
29
  ## Usage
30
 
@@ -65,7 +85,7 @@ Load the model:
65
  from setfit import SetFitModel
66
 
67
  # Download from Hub
68
- model = SetFitModel.from_pretrained("argilla/alpaca-hallucihunter-multilingual ")
69
  ```
70
 
71
  Perform inference and prediction col to your dataset:
@@ -124,7 +144,6 @@ Here are some examples of highest scored examples of `BAD INSTRUCTION`.
124
 
125
 
126
 
127
-
128
  ## BibTeX entry and citation info
129
 
130
  ```bibtex
 
11
 
12
  # 😵‍💫🦙 Alpaca HalluciHunter
13
 
14
+ This is a cross-lingual SetFit model to **detect bad instructions from Alpaca Datasets** and potentially other instruction-following datasets. This model can greatly speed up the validation of Alpaca Datasets across many languages, flagging examples that need to be fixed or simply discarded.
15
 
16
 
17
  <div style="text-align:center">
 
25
  - `ALL GOOD`, a given instruction, input, and output are correct,
26
  - `BAD INSTRUCTION`, there's an issue with the instruction, and/or input and output.
27
 
28
+ This model can be used as follows (see full usage instructions below):
29
+
30
+ ```python
31
+ from setfit import SetFitModel
32
+
33
+ # Download from Hub
34
+ model = SetFitModel.from_pretrained("argilla/alpaca-hallucihunter-multilingual")
35
+
36
+ text = """
37
+ INSTRUCTION:
38
+ Gebt mir drei Adjektive, um dieses Foto zu beschreiben.
39
+ INPUT:
40
+ [photo]
41
+ OUTPUT:
42
+ Auffällig, lebhaft, ruhig.
43
+ """
44
+ model.predict([text])
45
+ ```
46
+ Output: `BAD INSTRUCTION`
47
+
48
 
49
  ## Usage
50
 
 
85
  from setfit import SetFitModel
86
 
87
  # Download from Hub
88
+ model = SetFitModel.from_pretrained("argilla/alpaca-hallucihunter-multilingual")
89
  ```
90
 
91
  Perform inference and prediction col to your dataset:
 
144
 
145
 
146
 
 
147
  ## BibTeX entry and citation info
148
 
149
  ```bibtex