From f52c6e3a311d13fc743b151ccac32006cf356166 Mon Sep 17 00:00:00 2001
From: Ettore Di Giacinto <mudler@users.noreply.github.com>
Date: Wed, 18 Dec 2024 10:12:06 +0100
Subject: [PATCH] chore(model gallery): add falcon3-1b-instruct (#4423)

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>
---
 gallery/falcon3.yaml | 40 ++++++++++++++++++++++++++++++++++++++++
 gallery/index.yaml   | 25 +++++++++++++++++++++++++
 2 files changed, 65 insertions(+)
 create mode 100644 gallery/falcon3.yaml

diff --git a/gallery/falcon3.yaml b/gallery/falcon3.yaml
new file mode 100644
index 000000000000..b6593f4bb78d
--- /dev/null
+++ b/gallery/falcon3.yaml
@@ -0,0 +1,40 @@
+---
+name: "falcon3"
+
+config_file: |
+  mmap: true
+  template:
+    chat_message: |
+      <|{{ .RoleName }}|>
+      {{ if .FunctionCall -}}
+      Function call:
+      {{ else if eq .RoleName "tool" -}}
+      Function response:
+      {{ end -}}
+      {{ if .Content -}}
+      {{.Content }}
+      {{ end -}}
+      {{ if .FunctionCall -}}
+      {{toJson .FunctionCall}}
+      {{ end -}}
+      {{ if eq .RoleName "assistant" }}<|endoftext|>{{ end }}
+    function: |
+      <|system|>
+      You are a function calling AI model. You are provided with functions to execute. You may call one or more functions to assist with the user query. Don't make assumptions about what values to plug into functions. Here are the available tools:
+      {{range .Functions}}
+      {'type': 'function', 'function': {'name': '{{.Name}}', 'description': '{{.Description}}', 'parameters': {{toJson .Parameters}} }}
+      {{end}}
+      For each function call return a json object with function name and arguments
+      {{.Input }}
+      <|im_start|>assistant
+    chat: |
+      {{.Input }}
+      <|im_start|>assistant
+    completion: |
+      {{.Input}}
+  context_size: 4096
+  f16: true
+  stopwords:
+  - '<|endoftext|>'
+  - '<dummy32000>'
+  - '</s>'
diff --git a/gallery/index.yaml b/gallery/index.yaml
index f616b57b2ae9..5cb02f556c36 100644
--- a/gallery/index.yaml
+++ b/gallery/index.yaml
@@ -1,4 +1,29 @@
 ---
+- &falcon3
+  name: "falcon3-1b-instruct"
+  url: "github:mudler/LocalAI/gallery/falcon3.yaml@master"
+  icon: https://huggingface.co/datasets/tiiuae/documentation-images/resolve/main/general/falco3-logo.png
+  urls:
+    - https://huggingface.co/tiiuae/Falcon3-1B-Instruct
+    - https://huggingface.co/bartowski/Falcon3-1B-Instruct-GGUF
+  description: |
+    Falcon3 family of Open Foundation Models is a set of pretrained and instruct LLMs ranging from 1B to 10B parameters.
+
+    This repository contains the Falcon3-1B-Instruct. It achieves strong results on reasoning, language understanding, instruction following, code and mathematics tasks. Falcon3-1B-Instruct supports 4 languages (English, French, Spanish, Portuguese) and a context length of up to 8K.
+  overrides:
+    parameters:
+      model: Falcon3-1B-Instruct-Q4_K_M.gguf
+  files:
+    - filename: Falcon3-1B-Instruct-Q4_K_M.gguf
+      sha256: d351a6506b7d21221f3858b04d98c8b1b7b108b85acde2b13b69d9cb06e2a7e9
+      uri: huggingface://bartowski/Falcon3-1B-Instruct-GGUF/Falcon3-1B-Instruct-Q4_K_M.gguf
+  tags:
+    - llm
+    - gguf
+    - gpu
+    - cpu
+    - falcon
+  license: falcon-llm
 - &intellect1
   name: "intellect-1-instruct"
   url: "github:mudler/LocalAI/gallery/llama3.1-instruct.yaml@master"