# `LlamaCppEx.Model`
[🔗](https://github.com/nyo16/llama_cpp_ex/blob/main/lib/llama_cpp_ex/model.ex#L1)

Model loading and introspection.

# `t`

```elixir
@type t() :: %LlamaCppEx.Model{ref: reference()}
```

# `chat_template`

```elixir
@spec chat_template(t()) :: String.t() | nil
```

Returns the chat template string embedded in the model, or `nil` if none.

# `desc`

```elixir
@spec desc(t()) :: String.t()
```

Returns a human-readable description of the model.

# `load`

```elixir
@spec load(
  String.t(),
  keyword()
) :: {:ok, t()} | {:error, String.t()}
```

Loads a GGUF model from the given file path.

## Options

  * `:n_gpu_layers` - Number of layers to offload to GPU. Use `-1` for all layers.
    Defaults to `99` (offload all layers).
  * `:use_mmap` - Whether to memory-map the model file. Defaults to `true`.
  * `:main_gpu` - GPU device index for single-GPU mode. Defaults to `0`.
  * `:split_mode` - How to split the model across GPUs: `:none`, `:layer`, or `:row`.
    Defaults to `:none`.
  * `:tensor_split` - List of floats specifying the proportion of work per GPU
    (e.g. `[0.5, 0.5]` for two GPUs). Defaults to `[]`.
  * `:use_mlock` - Pin model memory in RAM to prevent swapping. Defaults to `false`.
  * `:use_direct_io` - Bypass page cache when loading (takes precedence over mmap).
    Defaults to `false`.
  * `:vocab_only` - Load vocabulary and metadata only, skip weights. Defaults to `false`.

## Examples

    {:ok, model} = LlamaCppEx.Model.load("path/to/model.gguf", n_gpu_layers: -1)
    {:ok, model} = LlamaCppEx.Model.load("path/to/model.gguf", split_mode: :layer, tensor_split: [0.5, 0.5])
    {:ok, model} = LlamaCppEx.Model.load("path/to/model.gguf", vocab_only: true)

# `n_ctx_train`

```elixir
@spec n_ctx_train(t()) :: integer()
```

Returns the training context size of the model.

# `n_embd`

```elixir
@spec n_embd(t()) :: integer()
```

Returns the embedding dimension of the model.

# `n_params`

```elixir
@spec n_params(t()) :: integer()
```

Returns the number of model parameters.

# `size`

```elixir
@spec size(t()) :: integer()
```

Returns the model file size in bytes.

---

*Consult [api-reference.md](api-reference.md) for complete listing*