nkasmanoff
commited on
Update README.md
Browse files
README.md
CHANGED
@@ -15,44 +15,17 @@ should probably proofread and complete it, then remove this comment. -->
|
|
15 |
|
16 |
# tool-bert
|
17 |
|
18 |
-
This model is a fine-tuned version of [google-bert/bert-base-uncased](https://huggingface.co/google-bert/bert-base-uncased)
|
19 |
-
It achieves the following results on the evaluation set:
|
20 |
-
- Loss: 0.0158
|
21 |
-
- Accuracy: 0.9886
|
22 |
|
23 |
-
|
24 |
|
25 |
-
|
26 |
|
27 |
-
|
28 |
|
29 |
-
|
30 |
-
|
31 |
-
## Training and evaluation data
|
32 |
-
|
33 |
-
More information needed
|
34 |
-
|
35 |
-
## Training procedure
|
36 |
-
|
37 |
-
### Training hyperparameters
|
38 |
-
|
39 |
-
The following hyperparameters were used during training:
|
40 |
-
- learning_rate: 5e-05
|
41 |
-
- train_batch_size: 8
|
42 |
-
- eval_batch_size: 8
|
43 |
-
- seed: 42
|
44 |
-
- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
|
45 |
-
- lr_scheduler_type: linear
|
46 |
-
- num_epochs: 3.0
|
47 |
-
|
48 |
-
### Training results
|
49 |
-
|
50 |
-
| Training Loss | Epoch | Step | Validation Loss | Accuracy |
|
51 |
-
|:-------------:|:-----:|:----:|:---------------:|:--------:|
|
52 |
-
| No log | 1.0 | 64 | 0.1104 | 0.9830 |
|
53 |
-
| No log | 2.0 | 128 | 0.0222 | 0.9886 |
|
54 |
-
| No log | 3.0 | 192 | 0.0158 | 0.9886 |
|
55 |
|
|
|
56 |
|
57 |
### Framework versions
|
58 |
|
|
|
15 |
|
16 |
# tool-bert
|
17 |
|
18 |
+
This model is a fine-tuned version of [google-bert/bert-base-uncased](https://huggingface.co/google-bert/bert-base-uncased).
|
|
|
|
|
|
|
19 |
|
20 |
+
It uses a custom made dataset of sample user instructions, which are classified to a number of possible local assistant function calling endpoints.
|
21 |
|
22 |
+
For example, given an input query, tool-bert returns a prediction as to what tool to use to augment a downstream LLM generated output with.
|
23 |
|
24 |
+
More information on these tools to follow, but example tools are "play music", "check the weather", "get the news", "take a photo", or use no tool.
|
25 |
|
26 |
+
Basically, this model is meant to be a means of allowing very small LLMs (i.e. 8B and below) to use function calling.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
27 |
|
28 |
+
All limitations and biases are inherited from the parent model.
|
29 |
|
30 |
### Framework versions
|
31 |
|