Skip to content
Closed
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
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ 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.20.0
- Package version: 4.21.0
- Generator version: 7.9.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

Expand Down Expand Up @@ -98,6 +98,7 @@ Class | Method | HTTP request | Description
*EXTERNALApi* | [**create_compute_deployment_deployments_compute_post**](docs/EXTERNALApi.md#create_compute_deployment_deployments_compute_post) | **POST** /deployments/compute | Create Compute Deployment
*EXTERNALApi* | [**create_cserve_v2_deployment_deployments_cserve_v2_post**](docs/EXTERNALApi.md#create_cserve_v2_deployment_deployments_cserve_v2_post) | **POST** /deployments/cserve_v2 | Create Cserve V2 Deployment
*EXTERNALApi* | [**create_cserve_v3_deployment_deployments_cserve_v3_post**](docs/EXTERNALApi.md#create_cserve_v3_deployment_deployments_cserve_v3_post) | **POST** /deployments/cserve_v3 | Create Cserve V3 Deployment
*EXTERNALApi* | [**create_dynamo_deployment_deployments_dynamo_post**](docs/EXTERNALApi.md#create_dynamo_deployment_deployments_dynamo_post) | **POST** /deployments/dynamo | Create Dynamo Deployment
*EXTERNALApi* | [**create_hardware_instance_hardware_instances_post**](docs/EXTERNALApi.md#create_hardware_instance_hardware_instances_post) | **POST** /hardware-instances | Create Hardware Instance
*EXTERNALApi* | [**create_inference_deployment_deployments_inference_post**](docs/EXTERNALApi.md#create_inference_deployment_deployments_inference_post) | **POST** /deployments/inference | Create Inference Deployment
*EXTERNALApi* | [**create_inference_v3_deployment_deployments_inference_v3_post**](docs/EXTERNALApi.md#create_inference_v3_deployment_deployments_inference_v3_post) | **POST** /deployments/inference_v3 | Create Inference V3 Deployment
Expand Down Expand Up @@ -126,6 +127,7 @@ Class | Method | HTTP request | Description
*EXTERNALApi* | [**get_deployment_status_deployments_status_deployment_id_get**](docs/EXTERNALApi.md#get_deployment_status_deployments_status_deployment_id_get) | **GET** /deployments/status/{deployment_id} | Get Deployment Status
*EXTERNALApi* | [**get_deployment_status_v3_deployments_status_v3_deployment_id_get**](docs/EXTERNALApi.md#get_deployment_status_v3_deployments_status_v3_deployment_id_get) | **GET** /deployments/status_v3/{deployment_id} | Get Deployment Status V3
*EXTERNALApi* | [**get_deployments_deployments_get**](docs/EXTERNALApi.md#get_deployments_deployments_get) | **GET** /deployments | Get Deployments
*EXTERNALApi* | [**get_dynamo_deployment_deployments_dynamo_deployment_id_get**](docs/EXTERNALApi.md#get_dynamo_deployment_deployments_dynamo_deployment_id_get) | **GET** /deployments/dynamo/{deployment_id} | Get Dynamo Deployment
*EXTERNALApi* | [**get_hardware_instances_hardware_instances_get**](docs/EXTERNALApi.md#get_hardware_instances_hardware_instances_get) | **GET** /hardware-instances | Get Hardware Instances
*EXTERNALApi* | [**get_inference_deployment_deployments_inference_deployment_id_get**](docs/EXTERNALApi.md#get_inference_deployment_deployments_inference_deployment_id_get) | **GET** /deployments/inference/{deployment_id} | Get Inference Deployment
*EXTERNALApi* | [**get_inference_v3_deployment_deployments_inference_v3_deployment_id_get**](docs/EXTERNALApi.md#get_inference_v3_deployment_deployments_inference_v3_deployment_id_get) | **GET** /deployments/inference_v3/{deployment_id} | Get Inference V3 Deployment
Expand All @@ -145,6 +147,7 @@ Class | Method | HTTP request | Description
*EXTERNALApi* | [**update_cserve_v3_deployment_deployments_cserve_v3_put**](docs/EXTERNALApi.md#update_cserve_v3_deployment_deployments_cserve_v3_put) | **PUT** /deployments/cserve_v3 | Update Cserve V3 Deployment
*EXTERNALApi* | [**update_deployment_status_deployments_status_deployment_id_put**](docs/EXTERNALApi.md#update_deployment_status_deployments_status_deployment_id_put) | **PUT** /deployments/status/{deployment_id} | Update Deployment Status
*EXTERNALApi* | [**update_deployment_status_v3_deployments_status_v3_deployment_id_put**](docs/EXTERNALApi.md#update_deployment_status_v3_deployments_status_v3_deployment_id_put) | **PUT** /deployments/status_v3/{deployment_id} | Update Deployment Status V3
*EXTERNALApi* | [**update_dynamo_deployment_deployments_dynamo_put**](docs/EXTERNALApi.md#update_dynamo_deployment_deployments_dynamo_put) | **PUT** /deployments/dynamo | Update Dynamo Deployment
*EXTERNALApi* | [**update_inference_deployment_deployments_inference_put**](docs/EXTERNALApi.md#update_inference_deployment_deployments_inference_put) | **PUT** /deployments/inference | Update Inference Deployment
*EXTERNALApi* | [**update_inference_v3_deployment_deployments_inference_v3_put**](docs/EXTERNALApi.md#update_inference_v3_deployment_deployments_inference_v3_put) | **PUT** /deployments/inference_v3 | Update Inference V3 Deployment
*EXTERNALApi* | [**update_service_account_service_accounts_workos_id_put**](docs/EXTERNALApi.md#update_service_account_service_accounts_workos_id_put) | **PUT** /service-accounts/{workos_id} | Update Service Account
Expand Down Expand Up @@ -173,6 +176,8 @@ Class | Method | HTTP request | Description
- [CreateCServeV3DeploymentResponse](docs/CreateCServeV3DeploymentResponse.md)
- [CreateComputeDeploymentRequest](docs/CreateComputeDeploymentRequest.md)
- [CreateComputeDeploymentResponse](docs/CreateComputeDeploymentResponse.md)
- [CreateDynamoDeploymentRequest](docs/CreateDynamoDeploymentRequest.md)
- [CreateDynamoDeploymentResponse](docs/CreateDynamoDeploymentResponse.md)
- [CreateHardwareInstanceRequest](docs/CreateHardwareInstanceRequest.md)
- [CreateInferenceDeploymentResponse](docs/CreateInferenceDeploymentResponse.md)
- [CreateInferenceV3DeploymentRequest](docs/CreateInferenceV3DeploymentRequest.md)
Expand Down Expand Up @@ -207,6 +212,7 @@ Class | Method | HTTP request | Description
- [GetDeploymentResponse](docs/GetDeploymentResponse.md)
- [GetDeploymentRevisionResponse](docs/GetDeploymentRevisionResponse.md)
- [GetDeploymentUsageResponse](docs/GetDeploymentUsageResponse.md)
- [GetDynamoDeploymentResponse](docs/GetDynamoDeploymentResponse.md)
- [GetInferenceDeploymentResponse](docs/GetInferenceDeploymentResponse.md)
- [GetInferenceV3DeploymentResponse](docs/GetInferenceV3DeploymentResponse.md)
- [GetJobDeploymentResponse](docs/GetJobDeploymentResponse.md)
Expand Down
52 changes: 52 additions & 0 deletions docs/CreateDynamoDeploymentRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# CreateDynamoDeploymentRequest

Create a NVIDIA Dynamo (DynamoGraphDeployment) inference deployment. Aggregated + KV-router pattern with a vLLM backend. The Frontend pod enables KV-aware routing across worker replicas.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**max_surge** | **int** | | [optional]
**max_unavailable** | **int** | | [optional]
**name** | **str** | |
**cluster_id** | **int** | |
**hardware_instance_id** | **int** | |
**user_annotations** | **Dict[str, str]** | | [optional]
**chart_revision** | **str** | | [optional]
**image_url** | **str** | |
**image_pull_secret_credentials** | [**ImagePullSecretCredentials**](ImagePullSecretCredentials.md) | | [optional]
**model** | **str** | |
**served_model_name** | **str** | | [optional]
**container_port** | **int** | Internal Dynamo Frontend listener port for the non-root runtime. The public endpoint remains on HTTPS; port 8788 is unavailable when backend_protocol is GRPC. | [optional] [default to 8000]
**initial_replicas** | **int** | | [optional] [default to 1]
**gpus_per_worker** | **int** | | [optional] [default to 1]
**extra_args** | **str** | | [optional]
**hf_token** | **str** | | [optional]
**hf_token_secret_name** | **str** | | [optional]
**env_vars** | **Dict[str, str]** | | [optional]
**endpoint_bearer_token** | **str** | | [optional]
**endpoint_certificate_authority** | **str** | | [optional]
**enable_logging** | **bool** | | [optional] [default to True]
**enable_node_model_cache** | **bool** | | [optional] [default to False]
**backend_protocol** | [**BackendProtocol**](BackendProtocol.md) | | [optional]

## Example

```python
from platform_api_python_client.models.create_dynamo_deployment_request import CreateDynamoDeploymentRequest

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

# convert the object into a dict
create_dynamo_deployment_request_dict = create_dynamo_deployment_request_instance.to_dict()
# create an instance of CreateDynamoDeploymentRequest from a dict
create_dynamo_deployment_request_from_dict = CreateDynamoDeploymentRequest.from_dict(create_dynamo_deployment_request_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)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | |
**created_at** | **datetime** | |
**endpoint_url** | **str** | |

## Example

```python
from platform_api_python_client.models.create_dynamo_deployment_response import CreateDynamoDeploymentResponse

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

# convert the object into a dict
create_dynamo_deployment_response_dict = create_dynamo_deployment_response_instance.to_dict()
# create an instance of CreateDynamoDeploymentResponse from a dict
create_dynamo_deployment_response_from_dict = CreateDynamoDeploymentResponse.from_dict(create_dynamo_deployment_response_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)


6 changes: 5 additions & 1 deletion docs/DeploymentResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Name | Type | Description | Notes
**cserve_version** | **str** | | [optional]
**min_replicas** | **int** | |
**max_replicas** | **int** | |
**initial_replicas** | **int** | | [optional]
**initial_replicas** | **int** | |
**endpoint_certificate_authority** | **str** | | [optional]
**endpoint_bearer_token** | **str** | | [optional]
**concurrency** | **int** | | [optional]
Expand All @@ -39,6 +39,10 @@ Name | Type | Description | Notes
**backend_protocol** | [**BackendProtocol**](BackendProtocol.md) | | [optional]
**config_file** | [**ConfigFileMount**](ConfigFileMount.md) | | [optional]
**metrics** | [**MetricsConfig**](MetricsConfig.md) | | [optional]
**model** | **str** | |
**served_model_name** | **str** | | [optional]
**gpus_per_worker** | **int** | |
**extra_args** | **str** | | [optional]

## Example

Expand Down
2 changes: 2 additions & 0 deletions docs/DeploymentType.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@

* `JOB` (value: `'job'`)

* `DYNAMO` (value: `'dynamo'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading
Loading