# pllm.deployment Python API

Public objects, practical usage, and research context for pllm.deployment.

[View canonical HTML](https://pllm.run/sdk/reference/python/pllm/deployment/)

Document ID: `pllm.docs.reference.python.pllm.deployment`  
Release: `0.1.0`

Deployment records describe role placement, endpoints, and trust boundaries without starting services or embedding credentials. Presence documents API availability, not complete model, security, or deployment coverage; check [implementation status](/sdk/reference/status/) before relying on a path.

## Research context

This API is project infrastructure rather than an implementation of one specific paper. Relevant method pages link their primary sources separately.

## Python SDK example

The example performs a bounded offline task and checks an observable result. It does not download a checkpoint or contact a provider.

```python
import pllm.deployment as deployment

local = deployment.Deployment(kind="local", root="/tmp/pllm-example")
assert local.kind == "local" and local.root.endswith("pllm-example")
```

API: [`pllm.deployment`](/sdk/reference/python/pllm/deployment/#objects-and-signatures)

## Objects and signatures

### `Deployment`

Immutable `Deployment` record carrying `kind`, `root` for the workflow where deployment records describe role placement, endpoints, and trust boundaries without starting services or embedding credentials.

- Canonical object: `pllm.configuration.Deployment`
- Kind: `class`
- Signature/type: `__init__(self, kind: str, root: str) -> None`
- Public exports: `pllm.Deployment`, `pllm.config.Deployment`, `pllm.deployment.Deployment`
- Public members: `kind: str`; `root: str`; `__init__(self, kind: str, root: str) -> None`; `classmethod local(cls, *, root: str) -> Self`; `get_params(self, deep: bool=True) -> dict[str, Any]`; `with_params(self, **changes: object) -> Self`; `to_spec(self) -> dict[str, Any]`