# `vllm_mlx.engine`

Engine abstraction for vllm-mlx inference.

[View the complete module source at #L1-L54](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/vllm_mlx/engine/__init__.py#L1-L54).

## 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.

::: vllm_mlx.engine
    options:
      members:
        - _ENGINE_CORE_NAMES
        - __all__
        - __getattr__
      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-vllm_mlx.engine.__getattr__" markdown="1">
<summary><code>vllm_mlx.engine.__getattr__</code> · function</summary>

```python
vllm_mlx.engine.__getattr__(name: str) -> not annotated
```

Function `__getattr__` calls `AttributeError`; can raise `AttributeError`; has 3 explicit return paths.

**Parameters**

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `name` | `str` | `yes` | `none` | Required positional or keyword input. |

**Returns**

- Type: `not annotated`
- Direct return expressions: `SimpleEngine`; `BatchedEngine`; `{'EngineCore': EngineCore, 'AsyncEngineCore': AsyncEngineCore, 'EngineConfig': EngineConfig}[name]`

**Exceptions and behavior**

Function `__getattr__` calls `AttributeError`; can raise `AttributeError`; has 3 explicit return paths.
Directly raised exceptions: `AttributeError`.

[View source #L34-L54](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/vllm_mlx/engine/__init__.py#L34-L54).

</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 |
| --- | --- | --- | --- | --- |
| [`__getattr__`](#contract-vllm_mlx.engine.__getattr__) | function | `__getattr__(name: str) -> not annotated` | Function `__getattr__` calls `AttributeError`; can raise `AttributeError`; has 3 explicit return paths. | [#L34-L54](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/vllm_mlx/engine/__init__.py#L34-L54) |