# `examples.mllm_example`

Multimodal Language Model (MLLM) example using vllm-mlx.

[View the complete module source at #L1-L89](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/examples/mllm_example.py#L1-L89).

## API details

Each callable below includes its exact signature, type annotations, inputs, defaults, return contract, documented exceptions, implementation source, and parsed docstring sections when the source provides them.

::: examples.mllm_example
    options:
      members:
        - main
      filters: []
      show_if_no_docstring: true

## Complete contract reference

Expand any definition for its exact inputs, annotations, defaults, return contract, directly raised exceptions, source-grounded behavior, and immutable line link. This section includes private and nested definitions that ordinary API generators omit.

<details class="api-contract" id="contract-examples.mllm_example.main" markdown="1">
<summary><code>examples.mllm_example.main</code> · function</summary>

```python
examples.mllm_example.main() -> not annotated
```

Function `main` calls `print`, `MLXMultimodalLM`, `mllm.load`, `len`; returns `None`.

**Parameters**

This callable has no explicit inputs.

**Returns**

- Type: `not annotated`
- Direct return expressions: `None`

**Exceptions and behavior**

Function `main` calls `print`, `MLXMultimodalLM`, `mllm.load`, `len`; returns `None`.
No direct `raise` statement appears in this definition.

[View source #L16-L85](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/examples/mllm_example.py#L16-L85).

</details>

## Complete symbol map

This map also includes private definitions and nested helpers. The signature column exposes every explicit input even when an internal helper has no dedicated parameter prose.

| Symbol | Kind | Signature and inputs | What it does | Source |
| --- | --- | --- | --- | --- |
| [`main`](#contract-examples.mllm_example.main) | function | `main() -> not annotated` | Function `main` calls `print`, `MLXMultimodalLM`, `mllm.load`, `len`; returns `None`. | [#L16-L85](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/examples/mllm_example.py#L16-L85) |