acon96 commited on
Commit
d6ca975
·
verified ·
1 Parent(s): b4bef2e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +56 -55
README.md CHANGED
@@ -1,56 +1,57 @@
1
- ---
2
- datasets:
3
- - acon96/Home-Assistant-Requests
4
- license: other
5
- license_link: https://huggingface.co/acon96/Home-Llama-3.2-3B/raw/main/LICENSE
6
- language:
7
- - en
8
- - de
9
- - es
10
- - fr
11
- tags:
12
- - automation
13
- - home
14
- - assistant
15
- pipeline_tag: text-generation
16
- base_model: meta-llama/Llama-3.2-3B-Instruct
17
- ---
18
- # Home Llama 3.2 3B
19
- The "Home Llama 3.2" model is a fine tuning of the Llama 3.2 3B model from Meta. The model is able to control devices in the user's house as well as perform basic question and answering. The model is explicitly trained to support English, German, Spanish, and French; the base model additionally supports Italian, Portuguese, Hindi, and Thai. The fine tuning dataset is a [custom curated dataset](https://github.com/acon96/home-llm) designed to teach the model function calling.
20
-
21
- The model is quantized using Lama.cpp in order to enable running the model in super low resource environments that are common with Home Assistant installations such as Rapsberry Pis.
22
-
23
- The model can be used as an "instruct" type model using the Llama3 prompt format. The system prompt is used to provide information about the state of the Home Assistant installation including available devices and callable services.
24
-
25
- Example "system" prompt:
26
- ```
27
- You are 'Al', a helpful AI Assistant that controls the devices in a house. Complete the following task as instructed with the information provided only.
28
- Services: light.turn_off(), light.turn_on(brightness,rgb_color), fan.turn_on(), fan.turn_off()
29
- Devices:
30
- light.office 'Office Light' = on;80%
31
- fan.office 'Office fan' = off
32
- light.kitchen 'Kitchen Light' = on;80%;red
33
- light.bedroom 'Bedroom Light' = off
34
- ```
35
-
36
- Output from the model will consist of a response that should be relayed back to the user, along with an optional code block that will invoke different Home Assistant "services". The output format from the model for function calling is as follows:
37
-
38
- `````
39
- turning on the kitchen lights for you now
40
- ```homeassistant
41
- { "service": "light.turn_on", "target_device": "light.kitchen" }
42
- ```
43
- `````
44
-
45
- The model is also capable of basic instruct and QA tasks because of the instruction fine-tuning in the base model. For example, the model is able to perform basic logic tasks such as the following:
46
-
47
- ```
48
- user if mary is 7 years old, and I am 3 years older than her. how old am I?
49
- assistant If Mary is 7 years old, then you are 10 years old (7+3=10).
50
- ```
51
-
52
- ## Datasets
53
- Snythetic Dataset for SFT - https://huggingface.co/datasets/acon96/Home-Assistant-Requests
54
-
55
- ## License
 
56
  This model is a fine-tuning of the Llama 3.2 model series that is licensed under the LLAMA 3.2 COMMUNITY LICENSE AGREEMENT
 
1
+ ---
2
+ datasets:
3
+ - acon96/Home-Assistant-Requests
4
+ license: other
5
+ license_link: https://huggingface.co/acon96/Home-Llama-3.2-3B/raw/main/LICENSE
6
+ language:
7
+ - en
8
+ - de
9
+ - es
10
+ - fr
11
+ tags:
12
+ - automation
13
+ - home
14
+ - assistant
15
+ pipeline_tag: text-generation
16
+ base_model: meta-llama/Llama-3.2-3B-Instruct
17
+ base_model_relation: finetune
18
+ ---
19
+ # Home Llama 3.2 3B
20
+ The "Home Llama 3.2" model is a fine tuning of the Llama 3.2 3B model from Meta. The model is able to control devices in the user's house as well as perform basic question and answering. The model is explicitly trained to support English, German, Spanish, and French; the base model additionally supports Italian, Portuguese, Hindi, and Thai. The fine tuning dataset is a [custom curated dataset](https://github.com/acon96/home-llm) designed to teach the model function calling.
21
+
22
+ The model is quantized using Lama.cpp in order to enable running the model in super low resource environments that are common with Home Assistant installations such as Rapsberry Pis.
23
+
24
+ The model can be used as an "instruct" type model using the Llama3 prompt format. The system prompt is used to provide information about the state of the Home Assistant installation including available devices and callable services.
25
+
26
+ Example "system" prompt:
27
+ ```
28
+ You are 'Al', a helpful AI Assistant that controls the devices in a house. Complete the following task as instructed with the information provided only.
29
+ Services: light.turn_off(), light.turn_on(brightness,rgb_color), fan.turn_on(), fan.turn_off()
30
+ Devices:
31
+ light.office 'Office Light' = on;80%
32
+ fan.office 'Office fan' = off
33
+ light.kitchen 'Kitchen Light' = on;80%;red
34
+ light.bedroom 'Bedroom Light' = off
35
+ ```
36
+
37
+ Output from the model will consist of a response that should be relayed back to the user, along with an optional code block that will invoke different Home Assistant "services". The output format from the model for function calling is as follows:
38
+
39
+ `````
40
+ turning on the kitchen lights for you now
41
+ ```homeassistant
42
+ { "service": "light.turn_on", "target_device": "light.kitchen" }
43
+ ```
44
+ `````
45
+
46
+ The model is also capable of basic instruct and QA tasks because of the instruction fine-tuning in the base model. For example, the model is able to perform basic logic tasks such as the following:
47
+
48
+ ```
49
+ user if mary is 7 years old, and I am 3 years older than her. how old am I?
50
+ assistant If Mary is 7 years old, then you are 10 years old (7+3=10).
51
+ ```
52
+
53
+ ## Datasets
54
+ Snythetic Dataset for SFT - https://huggingface.co/datasets/acon96/Home-Assistant-Requests
55
+
56
+ ## License
57
  This model is a fine-tuning of the Llama 3.2 model series that is licensed under the LLAMA 3.2 COMMUNITY LICENSE AGREEMENT