Skip to content

feat(alias): alias llama to llama-cpp, update docs #1448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/content/model-compatibility/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ Besides llama based models, LocalAI is compatible also with other architectures.
| `diffusers` | SD,... | no | Image generation | no | no | N/A |
| `vall-e-x` | Vall-E | no | Audio generation and Voice cloning | no | no | CPU/CUDA |
| `vllm` | Various GPTs and quantization formats | yes | GPT | no | no | CPU/CUDA |
| `exllama2` | GPTQ | yes | GPT only | no | no | N/A |
| `transformers-musicgen` | | no | Audio generation | no | no | N/A |

Note: any backend name listed above can be used in the `backend` field of the model configuration file (See [the advanced section]({{%relref "advanced" %}})).

Expand Down
6 changes: 3 additions & 3 deletions docs/content/model-compatibility/llama-cpp.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ weight = 1

{{% notice note %}}

The `ggml` file format has been deprecated. If you are using `ggml` models and you are configuring your model with a YAML file, specify, use the `llama-stable` backend instead. If you are relying in automatic detection of the model, you should be fine. For `gguf` models, use the `llama` backend.
The `ggml` file format has been deprecated. If you are using `ggml` models and you are configuring your model with a YAML file, specify, use the `llama-ggml` backend instead. If you are relying in automatic detection of the model, you should be fine. For `gguf` models, use the `llama` backend. The go backend is deprecated as well but still available as `go-llama`. The go backend supports still features not available in the mainline: speculative sampling and embeddings.

{{% /notice %}}

Expand Down Expand Up @@ -65,11 +65,11 @@ parameters:

In the example above we specify `llama` as the backend to restrict loading `gguf` models only.

For instance, to use the `llama-stable` backend for `ggml` models:
For instance, to use the `llama-ggml` backend for `ggml` models:

```yaml
name: llama
backend: llama-stable
backend: llama-ggml
parameters:
# Relative to the models path
model: file.ggml.bin
Expand Down
11 changes: 10 additions & 1 deletion pkg/model/initializers.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ import (
"github.com/rs/zerolog/log"
)

var Aliases map[string]string = map[string]string{
"go-llama": GoLlamaBackend,
"llama": LLamaCPP,
}

const (
GoLlamaBackend = "llama"
LlamaGGML = "llama-ggml"
Expand Down Expand Up @@ -169,9 +174,13 @@ func (ml *ModelLoader) resolveAddress(addr ModelAddress, parallel bool) (*grpc.C
func (ml *ModelLoader) BackendLoader(opts ...Option) (client *grpc.Client, err error) {
o := NewOptions(opts...)

log.Debug().Msgf("Loading model %s from %s", o.backendString, o.model)
log.Info().Msgf("Loading model '%s' with backend %s", o.model, o.backendString)

backend := strings.ToLower(o.backendString)
if realBackend, exists := Aliases[backend]; exists {
backend = realBackend
log.Debug().Msgf("%s is an alias of %s", backend, realBackend)
}

if o.singleActiveBackend {
ml.mu.Lock()
Expand Down