Skip to content
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
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,18 @@ No description provided (generated by Openapi Generator https://github.com/opena
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.1.0
- Package version: 4.37.1
- Generator version: 7.9.0
- Package version: 4.38.0
- Generator version: 7.26.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.7+
Python 3.10+

Packaging uses standard `[project]` metadata and `[dependency-groups]` (PEP 621/735).
Install the package with `python -m pip install .`; install development dependencies
with Poetry 2.2 or newer using `poetry install`, or pip 25.1 or newer using
`python -m pip install --group dev`. The latter installs the group, not the package.

## Installation & Usage
### pip install
Expand Down Expand Up @@ -228,7 +233,7 @@ Class | Method | HTTP request | Description
- [DeploymentUsage](docs/DeploymentUsage.md)
- [DeploymentUsageValue](docs/DeploymentUsageValue.md)
- [DynamoCommunicationsInput](docs/DynamoCommunicationsInput.md)
- [DynamoCommunicationsOutput](docs/DynamoCommunicationsOutput.md)
- [DynamoFrontendConfig](docs/DynamoFrontendConfig.md)
- [DynamoImage](docs/DynamoImage.md)
- [DynamoKvTransferConfiguration](docs/DynamoKvTransferConfiguration.md)
- [DynamoKvTransferPolicy](docs/DynamoKvTransferPolicy.md)
Expand Down Expand Up @@ -293,6 +298,7 @@ Class | Method | HTTP request | Description
- [ListServiceAccountsResponse](docs/ListServiceAccountsResponse.md)
- [ListUserVaultItemsResponse](docs/ListUserVaultItemsResponse.md)
- [ListVolumesResponse](docs/ListVolumesResponse.md)
- [LocationInner](docs/LocationInner.md)
- [Longhorn](docs/Longhorn.md)
- [Metric](docs/Metric.md)
- [MetricsConfig](docs/MetricsConfig.md)
Expand Down Expand Up @@ -344,7 +350,6 @@ Class | Method | HTTP request | Description
- [UserVaultItem](docs/UserVaultItem.md)
- [UserVaultType](docs/UserVaultType.md)
- [ValidationError](docs/ValidationError.md)
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
- [VaultScope](docs/VaultScope.md)
- [VolumeAccessMode](docs/VolumeAccessMode.md)
- [VolumeBackend](docs/VolumeBackend.md)
Expand All @@ -368,4 +373,3 @@ Authentication schemes defined for the API:




2 changes: 1 addition & 1 deletion docs/CreateComputeDeploymentRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Name | Type | Description | Notes
**user_annotations** | **Dict[str, str]** | | [optional]
**chart_revision** | **str** | | [optional]
**volume_mounts** | [**List[VolumeMount]**](VolumeMount.md) | | [optional]
**priority** | **str** | | [optional]
**priority** | **str** | Kubernetes PriorityClass name on the pod spec. Omit to leave unset. | [optional]
**image_url** | **str** | |
**image_pull_secret_credentials** | [**ImagePullSecretCredentials**](ImagePullSecretCredentials.md) | | [optional]
**image_pull_ref** | **int** | | [optional]
Expand Down
25 changes: 13 additions & 12 deletions docs/CreateDynamoDeploymentRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,26 @@ Name | Type | Description | Notes
**max_unavailable** | **int** | | [optional]
**name** | **str** | |
**cluster_id** | **int** | |
**hardware_instance_id** | **int** | | [optional]
**hardware_instance_id** | **int** | Deprecated aggregated-only spelling; set this under worker_pools.worker instead. Accepted alongside worker_pools when the values agree. | [optional]
**user_annotations** | **Dict[str, str]** | | [optional]
**chart_revision** | **str** | | [optional]
**volume_mounts** | [**List[VolumeMount]**](VolumeMount.md) | | [optional]
**priority** | **str** | | [optional]
**priority** | **str** | Kubernetes PriorityClass name on the pod spec. Omit to leave unset. | [optional]
**serving_mode** | [**DynamoServingMode**](DynamoServingMode.md) | | [optional]
**worker_pools** | [**DynamoWorkerPools**](DynamoWorkerPools.md) | | [optional]
**communications** | [**DynamoCommunicationsInput**](DynamoCommunicationsInput.md) | | [optional]
**weight_transfer** | [**DynamoWeightTransferConfiguration**](DynamoWeightTransferConfiguration.md) | | [optional]
**worker_pools** | [**DynamoWorkerPools**](DynamoWorkerPools.md) | Hardware and scaling per worker role. Aggregated mode uses exactly `worker`; disaggregated mode uses exactly `prefill` and `decode`. Unused roles are null. | [optional]
**communications** | [**DynamoCommunicationsInput**](DynamoCommunicationsInput.md) | Platform-managed worker communications. Only disaggregated KV transfer is supported. Omit or set null to preserve the legacy connector configuration. | [optional]
**weight_transfer** | [**DynamoWeightTransferConfiguration**](DynamoWeightTransferConfiguration.md) | Platform-managed weight loading between the workers of a pool (ModelExpress peer transfer), in either serving mode. An empty object opts in and pins model_revision to a commit; omit or set null to keep the native loader. | [optional]
**model** | **str** | |
**model_revision** | **str** | | [optional]
**model_revision** | **str** | Hugging Face branch, tag or commit of `model`. The API resolves it to a commit SHA and stores that SHA, so resume and rollback load the same weights. An update keeps the stored commit when it omits this field or sends that commit, as long as `model` is unchanged and extra_args does not set --revision; send a branch or tag to move to its newest commit. With no stored commit, weight_transfer pins the default branch's current commit, and otherwise each worker loads the default branch when it starts. | [optional]
**served_model_name** | **str** | | [optional]
**runtime_version** | **str** | Dynamo runtime image tag (for example 1.4.0). Defaults to the platform's current release; GET /prebuilt-images?type=dynamo lists the versions the platform has validated, but any tag may be requested. require_gpu_direct_rdma needs an EFA-capable image. Changing it restarts every component of a running deployment. | [optional]
**min_replicas** | **int** | | [optional]
**max_replicas** | **int** | | [optional]
**concurrency** | **int** | | [optional]
**cooldown_period** | **int** | | [optional]
**extra_args** | **str** | | [optional]
**min_replicas** | **int** | Deprecated aggregated-only spelling; set this under worker_pools.worker instead. Accepted alongside worker_pools when the values agree. | [optional]
**max_replicas** | **int** | Deprecated aggregated-only spelling; set this under worker_pools.worker instead. Accepted alongside worker_pools when the values agree. | [optional]
**concurrency** | **int** | Deprecated aggregated-only spelling; set this under worker_pools.worker instead. Accepted alongside worker_pools when the values agree. | [optional]
**cooldown_period** | **int** | Deprecated aggregated-only spelling; set this under worker_pools.worker instead. Accepted alongside worker_pools when the values agree. | [optional]
**extra_args** | **str** | Extra worker CLI arguments as a single shell-style string, split into argv with POSIX shell quoting (shlex). Backslash is an escape character, so `\\` is consumed unless quoted: e.g. `--regex \\d+` reaches the worker as `d+`. Wrap literal backslashes in single quotes (`--regex '\\d+'`). Unbalanced quotes or a trailing backslash are rejected. | [optional]
**hf_token** | **str** | | [optional]
**hf_token_ref** | **int** | | [optional]
**hf_token_ref** | **int** | Access-token vault item ID for HF_TOKEN. Cannot be combined with hf_token. | [optional]
**env_vars** | **Dict[str, str]** | | [optional]
**env_vars_refs** | **object** | | [optional]
**endpoint_bearer_token** | **str** | | [optional]
Expand All @@ -39,6 +39,7 @@ Name | Type | Description | Notes
**enable_logging** | **bool** | | [optional] [default to True]
**enable_node_model_cache** | **bool** | | [optional] [default to False]
**backend_protocol** | [**BackendProtocol**](BackendProtocol.md) | | [optional]
**frontend** | [**DynamoFrontendConfig**](DynamoFrontendConfig.md) | Replica bounds for the Frontend (HTTP server and router) pods serving the endpoint, which are placed on separate nodes where possible. Two keep the endpoint serving through a node loss. min_replicas and max_replicas must be equal until Frontend autoscaling is supported. Changing them restarts every component of a running deployment. | [optional]

## Example

Expand Down
4 changes: 2 additions & 2 deletions docs/CreateInferenceV3DeploymentRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Name | Type | Description | Notes
**user_annotations** | **Dict[str, str]** | | [optional]
**chart_revision** | **str** | | [optional]
**volume_mounts** | [**List[VolumeMount]**](VolumeMount.md) | | [optional]
**priority** | **str** | | [optional]
**hf_token_ref** | **int** | | [optional]
**priority** | **str** | Kubernetes PriorityClass name on the pod spec. Omit to leave unset. | [optional]
**hf_token_ref** | **int** | Access-token vault item ID for HF_TOKEN. Cannot be combined with hf_token. | [optional]
**image_url** | **str** | |
**image_pull_secret_credentials** | [**ImagePullSecretCredentials**](ImagePullSecretCredentials.md) | | [optional]
**image_pull_ref** | **int** | | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateJobDeploymentRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Name | Type | Description | Notes
**user_annotations** | **Dict[str, str]** | | [optional]
**chart_revision** | **str** | | [optional]
**volume_mounts** | [**List[VolumeMount]**](VolumeMount.md) | | [optional]
**priority** | **str** | | [optional]
**priority** | **str** | Kubernetes PriorityClass name on the pod spec. Omit to leave unset. | [optional]
**image_url** | **str** | |
**image_pull_secret_credentials** | [**ImagePullSecretCredentials**](ImagePullSecretCredentials.md) | | [optional]
**image_pull_ref** | **int** | | [optional]
Expand Down
13 changes: 7 additions & 6 deletions docs/DeploymentResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ Name | Type | Description | Notes
**created_at** | **datetime** | |
**hardware_instance_id** | **int** | |
**revision_number** | **int** | |
**chart_revision** | **str** | | [optional]
**chart_revision** | **str** | Saved catalog Git reference for this revision; null if not recorded. Informational: omit chart_revision from edit or clone requests to use the current platform default. | [optional]
**user_annotations** | **Dict[str, str]** | | [optional]
**priority** | **str** | | [optional]
**volume_mounts** | [**List[VolumeMount]**](VolumeMount.md) | | [optional]
**hf_token_ref** | **int** | | [optional]
**serving_mode** | [**DynamoServingMode**](DynamoServingMode.md) | | [optional]
**worker_pools** | [**DynamoWorkerPools**](DynamoWorkerPools.md) | | [optional]
**communications** | [**DynamoCommunicationsOutput**](DynamoCommunicationsOutput.md) | | [optional]
**weight_transfer** | [**DynamoWeightTransferConfiguration**](DynamoWeightTransferConfiguration.md) | | [optional]
**worker_pools** | [**DynamoWorkerPools**](DynamoWorkerPools.md) | Hardware and scaling per worker role. Aggregated mode uses exactly `worker`; disaggregated mode uses exactly `prefill` and `decode`. Unused roles are null. | [optional]
**communications** | [**DynamoCommunicationsInput**](DynamoCommunicationsInput.md) | Requested communication policy; null for revisions using the legacy configuration. | [optional]
**weight_transfer** | [**DynamoWeightTransferConfiguration**](DynamoWeightTransferConfiguration.md) | Requested weight transfer policy; null when the workers use the native loader. | [optional]
**model** | **str** | |
**model_revision** | **str** | | [optional]
**model_revision** | **str** | Commit SHA of `model` this revision loads; null when the workers load the default branch. | [optional]
**served_model_name** | **str** | | [optional]
**runtime_version** | **str** | | [optional]
**runtime_version** | **str** | Dynamo runtime version tag this revision renders with. | [optional]
**min_replicas** | **int** | |
**max_replicas** | **int** | |
**concurrency** | **int** | | [optional]
Expand All @@ -43,6 +43,7 @@ Name | Type | Description | Notes
**enable_logging** | **bool** | | [optional] [default to True]
**enable_node_model_cache** | **bool** | | [optional] [default to False]
**backend_protocol** | [**BackendProtocol**](BackendProtocol.md) | | [optional]
**frontend** | [**DynamoFrontendConfig**](DynamoFrontendConfig.md) | Frontend replica bounds this revision requests; the defaults for revisions created before the field. | [optional]
**container_port** | **int** | |
**healthcheck** | **str** | | [optional]
**command** | **List[str]** | | [optional]
Expand Down
29 changes: 0 additions & 29 deletions docs/DynamoCommunicationsOutput.md

This file was deleted.

31 changes: 31 additions & 0 deletions docs/DynamoFrontendConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# DynamoFrontendConfig

Replica bounds for the Dynamo Frontend, shaped like a worker pool's so that Frontend autoscaling can arrive without an API change. Until it does, the Frontend runs a fixed count: ``min_replicas`` must equal ``max_replicas``.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**min_replicas** | **int** | | [optional] [default to 3]
**max_replicas** | **int** | | [optional] [default to 3]

## Example

```python
from platform_api_python_client.models.dynamo_frontend_config import DynamoFrontendConfig

# TODO update the JSON string below
json = "{}"
# create an instance of DynamoFrontendConfig from a JSON string
dynamo_frontend_config_instance = DynamoFrontendConfig.from_json(json)
# print the JSON string representation of the object
print(DynamoFrontendConfig.to_json())

# convert the object into a dict
dynamo_frontend_config_dict = dynamo_frontend_config_instance.to_dict()
# create an instance of DynamoFrontendConfig from a dict
dynamo_frontend_config_from_dict = DynamoFrontendConfig.from_dict(dynamo_frontend_config_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


2 changes: 1 addition & 1 deletion docs/DynamoWorkerPoolConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Hardware and scaling for one Dynamo worker role. ``min_replicas``/``max_replica
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hardware_instance_id** | **int** | |
**replicas** | **int** | | [optional]
**replicas** | **int** | Deprecated fixed pool size, equivalent to min_replicas == max_replicas. | [optional]
**min_replicas** | **int** | | [optional]
**max_replicas** | **int** | | [optional]
**concurrency** | **int** | | [optional]
Expand Down
Loading
Loading