@gpuai/sdk 0.5.4 → 0.5.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +56 -0
- package/README.md +50 -2
- package/dist/apis/EndpointsApi.d.ts +150 -0
- package/dist/apis/EndpointsApi.js +379 -0
- package/dist/apis/InstancesApi.d.ts +15 -0
- package/dist/apis/InstancesApi.js +45 -0
- package/dist/apis/JobsApi.d.ts +172 -0
- package/dist/apis/JobsApi.js +444 -0
- package/dist/apis/OperationsApi.d.ts +17 -0
- package/dist/apis/OperationsApi.js +48 -0
- package/dist/apis/SecretsApi.d.ts +123 -0
- package/dist/apis/SecretsApi.js +328 -0
- package/dist/apis/index.d.ts +3 -0
- package/dist/apis/index.js +3 -0
- package/dist/esm/apis/EndpointsApi.d.ts +150 -0
- package/dist/esm/apis/EndpointsApi.js +375 -0
- package/dist/esm/apis/InstancesApi.d.ts +15 -0
- package/dist/esm/apis/InstancesApi.js +45 -0
- package/dist/esm/apis/JobsApi.d.ts +172 -0
- package/dist/esm/apis/JobsApi.js +440 -0
- package/dist/esm/apis/OperationsApi.d.ts +17 -0
- package/dist/esm/apis/OperationsApi.js +48 -0
- package/dist/esm/apis/SecretsApi.d.ts +123 -0
- package/dist/esm/apis/SecretsApi.js +324 -0
- package/dist/esm/apis/index.d.ts +3 -0
- package/dist/esm/apis/index.js +3 -0
- package/dist/esm/models/DedicatedIPOffer.d.ts +98 -0
- package/dist/esm/models/DedicatedIPOffer.js +87 -0
- package/dist/esm/models/Endpoint.d.ts +147 -0
- package/dist/esm/models/Endpoint.js +121 -0
- package/dist/esm/models/EndpointCreate.d.ts +80 -0
- package/dist/esm/models/EndpointCreate.js +63 -0
- package/dist/esm/models/EndpointList.d.ts +33 -0
- package/dist/esm/models/EndpointList.js +44 -0
- package/dist/esm/models/EndpointMachine.d.ts +90 -0
- package/dist/esm/models/EndpointMachine.js +84 -0
- package/dist/esm/models/EndpointReplicaCounts.d.ts +38 -0
- package/dist/esm/models/EndpointReplicaCounts.js +47 -0
- package/dist/esm/models/Job.d.ts +352 -0
- package/dist/esm/models/Job.js +254 -0
- package/dist/esm/models/JobAttempt.d.ts +176 -0
- package/dist/esm/models/JobAttempt.js +147 -0
- package/dist/esm/models/JobCreate.d.ts +153 -0
- package/dist/esm/models/JobCreate.js +84 -0
- package/dist/esm/models/JobGpuTypes.d.ts +39 -0
- package/dist/esm/models/JobGpuTypes.js +48 -0
- package/dist/esm/models/JobGpuTypesDataInner.d.ts +58 -0
- package/dist/esm/models/JobGpuTypesDataInner.js +59 -0
- package/dist/esm/models/JobLogChunk.d.ts +50 -0
- package/dist/esm/models/JobLogChunk.js +55 -0
- package/dist/esm/models/JobLogs.d.ts +39 -0
- package/dist/esm/models/JobLogs.js +48 -0
- package/dist/esm/models/JobPage.d.ts +39 -0
- package/dist/esm/models/JobPage.js +48 -0
- package/dist/esm/models/JobSharingHint.d.ts +46 -0
- package/dist/esm/models/JobSharingHint.js +51 -0
- package/dist/esm/models/JobTelemetry.d.ts +51 -0
- package/dist/esm/models/JobTelemetry.js +56 -0
- package/dist/esm/models/JobTelemetryPoint.d.ts +56 -0
- package/dist/esm/models/JobTelemetryPoint.js +59 -0
- package/dist/esm/models/JobTrial.d.ts +79 -0
- package/dist/esm/models/JobTrial.js +73 -0
- package/dist/esm/models/Operation.d.ts +6 -0
- package/dist/esm/models/Operation.js +2 -0
- package/dist/esm/models/Secret.d.ts +62 -0
- package/dist/esm/models/Secret.js +63 -0
- package/dist/esm/models/SecretCreate.d.ts +44 -0
- package/dist/esm/models/SecretCreate.js +49 -0
- package/dist/esm/models/SecretImportItem.d.ts +38 -0
- package/dist/esm/models/SecretImportItem.js +47 -0
- package/dist/esm/models/SecretImportRequest.d.ts +39 -0
- package/dist/esm/models/SecretImportRequest.js +46 -0
- package/dist/esm/models/SecretImportResult.d.ts +44 -0
- package/dist/esm/models/SecretImportResult.js +51 -0
- package/dist/esm/models/SecretList.d.ts +33 -0
- package/dist/esm/models/SecretList.js +44 -0
- package/dist/esm/models/SecretPut.d.ts +38 -0
- package/dist/esm/models/SecretPut.js +45 -0
- package/dist/esm/models/index.d.ts +25 -0
- package/dist/esm/models/index.js +25 -0
- package/dist/esm/runtime.js +1 -1
- package/dist/models/DedicatedIPOffer.d.ts +98 -0
- package/dist/models/DedicatedIPOffer.js +94 -0
- package/dist/models/Endpoint.d.ts +147 -0
- package/dist/models/Endpoint.js +129 -0
- package/dist/models/EndpointCreate.d.ts +80 -0
- package/dist/models/EndpointCreate.js +70 -0
- package/dist/models/EndpointList.d.ts +33 -0
- package/dist/models/EndpointList.js +51 -0
- package/dist/models/EndpointMachine.d.ts +90 -0
- package/dist/models/EndpointMachine.js +92 -0
- package/dist/models/EndpointReplicaCounts.d.ts +38 -0
- package/dist/models/EndpointReplicaCounts.js +54 -0
- package/dist/models/Job.d.ts +352 -0
- package/dist/models/Job.js +262 -0
- package/dist/models/JobAttempt.d.ts +176 -0
- package/dist/models/JobAttempt.js +155 -0
- package/dist/models/JobCreate.d.ts +153 -0
- package/dist/models/JobCreate.js +92 -0
- package/dist/models/JobGpuTypes.d.ts +39 -0
- package/dist/models/JobGpuTypes.js +55 -0
- package/dist/models/JobGpuTypesDataInner.d.ts +58 -0
- package/dist/models/JobGpuTypesDataInner.js +66 -0
- package/dist/models/JobLogChunk.d.ts +50 -0
- package/dist/models/JobLogChunk.js +62 -0
- package/dist/models/JobLogs.d.ts +39 -0
- package/dist/models/JobLogs.js +55 -0
- package/dist/models/JobPage.d.ts +39 -0
- package/dist/models/JobPage.js +55 -0
- package/dist/models/JobSharingHint.d.ts +46 -0
- package/dist/models/JobSharingHint.js +58 -0
- package/dist/models/JobTelemetry.d.ts +51 -0
- package/dist/models/JobTelemetry.js +63 -0
- package/dist/models/JobTelemetryPoint.d.ts +56 -0
- package/dist/models/JobTelemetryPoint.js +66 -0
- package/dist/models/JobTrial.d.ts +79 -0
- package/dist/models/JobTrial.js +81 -0
- package/dist/models/Operation.d.ts +6 -0
- package/dist/models/Operation.js +2 -0
- package/dist/models/Secret.d.ts +62 -0
- package/dist/models/Secret.js +70 -0
- package/dist/models/SecretCreate.d.ts +44 -0
- package/dist/models/SecretCreate.js +56 -0
- package/dist/models/SecretImportItem.d.ts +38 -0
- package/dist/models/SecretImportItem.js +54 -0
- package/dist/models/SecretImportRequest.d.ts +39 -0
- package/dist/models/SecretImportRequest.js +53 -0
- package/dist/models/SecretImportResult.d.ts +44 -0
- package/dist/models/SecretImportResult.js +58 -0
- package/dist/models/SecretList.d.ts +33 -0
- package/dist/models/SecretList.js +51 -0
- package/dist/models/SecretPut.d.ts +38 -0
- package/dist/models/SecretPut.js +52 -0
- package/dist/models/index.d.ts +25 -0
- package/dist/models/index.js +25 -0
- package/dist/runtime.js +1 -1
- package/docs/DedicatedIPOffer.md +56 -0
- package/docs/Endpoint.md +68 -0
- package/docs/EndpointCreate.md +50 -0
- package/docs/EndpointList.md +34 -0
- package/docs/EndpointMachine.md +50 -0
- package/docs/EndpointReplicaCounts.md +36 -0
- package/docs/EndpointsApi.md +544 -0
- package/docs/InstancesApi.md +68 -1
- package/docs/Job.md +125 -0
- package/docs/JobAttempt.md +69 -0
- package/docs/JobCreate.md +66 -0
- package/docs/JobGpuTypes.md +36 -0
- package/docs/JobGpuTypesDataInner.md +42 -0
- package/docs/JobLogChunk.md +40 -0
- package/docs/JobLogs.md +36 -0
- package/docs/JobPage.md +36 -0
- package/docs/JobSharingHint.md +39 -0
- package/docs/JobTelemetry.md +40 -0
- package/docs/JobTelemetryPoint.md +42 -0
- package/docs/JobTrial.md +46 -0
- package/docs/JobsApi.md +609 -0
- package/docs/Operation.md +2 -0
- package/docs/OperationsApi.md +76 -0
- package/docs/Secret.md +45 -0
- package/docs/SecretCreate.md +38 -0
- package/docs/SecretImportItem.md +36 -0
- package/docs/SecretImportRequest.md +36 -0
- package/docs/SecretImportResult.md +38 -0
- package/docs/SecretList.md +34 -0
- package/docs/SecretPut.md +36 -0
- package/docs/SecretsApi.md +450 -0
- package/package.json +1 -1
- package/src/apis/EndpointsApi.ts +481 -0
- package/src/apis/InstancesApi.ts +52 -0
- package/src/apis/JobsApi.ts +551 -0
- package/src/apis/OperationsApi.ts +59 -0
- package/src/apis/SecretsApi.ts +413 -0
- package/src/apis/index.ts +3 -0
- package/src/models/DedicatedIPOffer.ts +165 -0
- package/src/models/Endpoint.ts +247 -0
- package/src/models/EndpointCreate.ts +132 -0
- package/src/models/EndpointList.ts +74 -0
- package/src/models/EndpointMachine.ts +151 -0
- package/src/models/EndpointReplicaCounts.ts +75 -0
- package/src/models/Job.ts +538 -0
- package/src/models/JobAttempt.ts +267 -0
- package/src/models/JobCreate.ts +221 -0
- package/src/models/JobGpuTypes.ts +83 -0
- package/src/models/JobGpuTypesDataInner.ts +104 -0
- package/src/models/JobLogChunk.ts +93 -0
- package/src/models/JobLogs.ts +83 -0
- package/src/models/JobPage.ts +83 -0
- package/src/models/JobSharingHint.ts +86 -0
- package/src/models/JobTelemetry.ts +101 -0
- package/src/models/JobTelemetryPoint.ts +102 -0
- package/src/models/JobTrial.ts +132 -0
- package/src/models/Operation.ts +8 -0
- package/src/models/Secret.ts +111 -0
- package/src/models/SecretCreate.ts +83 -0
- package/src/models/SecretImportItem.ts +75 -0
- package/src/models/SecretImportRequest.ts +82 -0
- package/src/models/SecretImportResult.ts +84 -0
- package/src/models/SecretList.ts +74 -0
- package/src/models/SecretPut.ts +74 -0
- package/src/models/index.ts +25 -0
- package/src/runtime.ts +1 -1
package/docs/InstancesApi.md
CHANGED
|
@@ -6,6 +6,7 @@ All URIs are relative to *https://api.gpu.ai/v1*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
| [**createInstance**](InstancesApi.md#createinstanceoperation) | **POST** /instances | Create an instance (async — returns 202 + Operation-Id header) |
|
|
8
8
|
| [**deleteInstance**](InstancesApi.md#deleteinstance) | **DELETE** /instances/{id} | Terminate an instance (idempotent) |
|
|
9
|
+
| [**getDedicatedIpOffer**](InstancesApi.md#getdedicatedipoffer) | **GET** /dedicated-ip | Get the dedicated public IP add-on offer |
|
|
9
10
|
| [**getInstance**](InstancesApi.md#getinstance) | **GET** /instances/{id} | Get an instance |
|
|
10
11
|
| [**getInstanceGpuSuggestion**](InstancesApi.md#getinstancegpusuggestion) | **GET** /instances/{id}/gpu-suggestion | Suggest a lower-priced GPU for an instance |
|
|
11
12
|
| [**listInstances**](InstancesApi.md#listinstances) | **GET** /instances | List instances |
|
|
@@ -82,7 +83,7 @@ example().catch(console.error);
|
|
|
82
83
|
### HTTP response details
|
|
83
84
|
| Status code | Description | Response headers |
|
|
84
85
|
|-------------|-------------|------------------|
|
|
85
|
-
| **202** | Accepted; long-running operation | * Operation-Id - Use GET /operations/{id} to poll <br> * GPUAI-Hint - Advisory only, and absent on most launches. Sent when the request is a one-off batch run (a custom image with a command and auto_terminate_hours)
|
|
86
|
+
| **202** | Accepted; long-running operation | * Operation-Id - Use GET /operations/{id} to poll <br> * GPUAI-Hint - Advisory only, and absent on most launches. Sent to point at Jobs (POST /jobs), which start a machine for the work and shut it down a few minutes after it ends, when the request is a one-off batch run (a custom image with a command and auto_terminate_hours) or the organization launched many instances in the last 24 hours that each ran for less than 15 minutes. The same text is in the response body\'s hint field. It never changes the launch. <br> * GPUAI-Balance-Warning - <br> |
|
|
86
87
|
| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. | * Retry-After - Seconds the client should wait before retrying. <br> |
|
|
87
88
|
| **0** | Error response (RFC 7807) | - |
|
|
88
89
|
|
|
@@ -167,6 +168,72 @@ example().catch(console.error);
|
|
|
167
168
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
168
169
|
|
|
169
170
|
|
|
171
|
+
## getDedicatedIpOffer
|
|
172
|
+
|
|
173
|
+
> DedicatedIPOffer getDedicatedIpOffer()
|
|
174
|
+
|
|
175
|
+
Get the dedicated public IP add-on offer
|
|
176
|
+
|
|
177
|
+
Describes the dedicated public IPv4 add-on for instances and the caller\'s usage of it. A dedicated IP is a GPU.ai-owned public address (never the supplier\'s) that forwards the chosen inbound TCP ports, raw and without TLS termination, to the same ports on the instance\'s loopback. Request one at launch with the `dedicated_ip` field on POST /instances. The response carries the hourly fee charged while the address is attached, the transfer price per GB (counted in both directions), the transfer cap per attachment after which forwarding is suspended, the ports a launch may forward, the organization\'s limit and how many it holds, how many addresses are free right now, and the acceptable use policy. Requires the `instances:read` scope. Returns 404 when the add-on is not enabled for this deployment.
|
|
178
|
+
|
|
179
|
+
### Example
|
|
180
|
+
|
|
181
|
+
```ts
|
|
182
|
+
import {
|
|
183
|
+
Configuration,
|
|
184
|
+
InstancesApi,
|
|
185
|
+
} from '@gpuai/sdk';
|
|
186
|
+
import type { GetDedicatedIpOfferRequest } from '@gpuai/sdk';
|
|
187
|
+
|
|
188
|
+
async function example() {
|
|
189
|
+
console.log("🚀 Testing @gpuai/sdk SDK...");
|
|
190
|
+
const config = new Configuration({
|
|
191
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
192
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
193
|
+
});
|
|
194
|
+
const api = new InstancesApi(config);
|
|
195
|
+
|
|
196
|
+
try {
|
|
197
|
+
const data = await api.getDedicatedIpOffer();
|
|
198
|
+
console.log(data);
|
|
199
|
+
} catch (error) {
|
|
200
|
+
console.error(error);
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
// Run the test
|
|
205
|
+
example().catch(console.error);
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Parameters
|
|
209
|
+
|
|
210
|
+
This endpoint does not need any parameter.
|
|
211
|
+
|
|
212
|
+
### Return type
|
|
213
|
+
|
|
214
|
+
[**DedicatedIPOffer**](DedicatedIPOffer.md)
|
|
215
|
+
|
|
216
|
+
### Authorization
|
|
217
|
+
|
|
218
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
219
|
+
|
|
220
|
+
### HTTP request headers
|
|
221
|
+
|
|
222
|
+
- **Content-Type**: Not defined
|
|
223
|
+
- **Accept**: `application/json`, `application/problem+json`
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
### HTTP response details
|
|
227
|
+
| Status code | Description | Response headers |
|
|
228
|
+
|-------------|-------------|------------------|
|
|
229
|
+
| **200** | OK | - |
|
|
230
|
+
| **404** | The dedicated IP add-on is not enabled for this deployment. | - |
|
|
231
|
+
| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. | * Retry-After - Seconds the client should wait before retrying. <br> |
|
|
232
|
+
| **0** | Error response (RFC 7807) | - |
|
|
233
|
+
|
|
234
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
235
|
+
|
|
236
|
+
|
|
170
237
|
## getInstance
|
|
171
238
|
|
|
172
239
|
> Instance getInstance(id, include)
|
package/docs/Job.md
ADDED
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
|
|
2
|
+
# Job
|
|
3
|
+
|
|
4
|
+
A batch job. It names no machine: the machines a job runs on are instances of your organization and appear in the instance list.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`id` | string
|
|
11
|
+
`name` | string
|
|
12
|
+
`image` | string
|
|
13
|
+
`command` | Array<string>
|
|
14
|
+
`envNames` | Array<string>
|
|
15
|
+
`secrets` | Array<string>
|
|
16
|
+
`gpuType` | string
|
|
17
|
+
`minVramGb` | number
|
|
18
|
+
`memoryHintMb` | number
|
|
19
|
+
`computeHintPct` | number
|
|
20
|
+
`timeoutSeconds` | number
|
|
21
|
+
`maxWaitSeconds` | number
|
|
22
|
+
`allowSharing` | boolean
|
|
23
|
+
`allowRestart` | boolean
|
|
24
|
+
`isolation` | string
|
|
25
|
+
`migProfile` | string
|
|
26
|
+
`checkpointPath` | string
|
|
27
|
+
`maxRetries` | number
|
|
28
|
+
`maxPricePerHour` | number
|
|
29
|
+
`status` | string
|
|
30
|
+
`statusReason` | string
|
|
31
|
+
`cancelRequested` | boolean
|
|
32
|
+
`attempt` | number
|
|
33
|
+
`retries` | number
|
|
34
|
+
`evictions` | number
|
|
35
|
+
`oomExits` | number
|
|
36
|
+
`reservationMb` | number
|
|
37
|
+
`wholeGpu` | boolean
|
|
38
|
+
`predictedMb` | number
|
|
39
|
+
`predictionSource` | string
|
|
40
|
+
`predictedComputePct` | number
|
|
41
|
+
`computePredictionSource` | string
|
|
42
|
+
`peakMemoryMb` | number
|
|
43
|
+
`gpuMemoryTotalMb` | number
|
|
44
|
+
`utilMeanPct` | number
|
|
45
|
+
`busyPct` | number
|
|
46
|
+
`memorySource` | string
|
|
47
|
+
`sharingMode` | string
|
|
48
|
+
`gpuSeconds` | number
|
|
49
|
+
`attributedCostUsd` | number
|
|
50
|
+
`exitCode` | number
|
|
51
|
+
`createdAt` | Date
|
|
52
|
+
`startedAt` | Date
|
|
53
|
+
`finishedAt` | Date
|
|
54
|
+
`sharingHint` | [JobSharingHint](JobSharingHint.md)
|
|
55
|
+
`attempts` | [Array<JobAttempt>](JobAttempt.md)
|
|
56
|
+
|
|
57
|
+
## Example
|
|
58
|
+
|
|
59
|
+
```typescript
|
|
60
|
+
import type { Job } from '@gpuai/sdk'
|
|
61
|
+
|
|
62
|
+
// TODO: Update the object below with actual values
|
|
63
|
+
const example = {
|
|
64
|
+
"id": null,
|
|
65
|
+
"name": null,
|
|
66
|
+
"image": null,
|
|
67
|
+
"command": null,
|
|
68
|
+
"envNames": null,
|
|
69
|
+
"secrets": null,
|
|
70
|
+
"gpuType": null,
|
|
71
|
+
"minVramGb": null,
|
|
72
|
+
"memoryHintMb": null,
|
|
73
|
+
"computeHintPct": null,
|
|
74
|
+
"timeoutSeconds": null,
|
|
75
|
+
"maxWaitSeconds": null,
|
|
76
|
+
"allowSharing": null,
|
|
77
|
+
"allowRestart": null,
|
|
78
|
+
"isolation": null,
|
|
79
|
+
"migProfile": null,
|
|
80
|
+
"checkpointPath": null,
|
|
81
|
+
"maxRetries": null,
|
|
82
|
+
"maxPricePerHour": null,
|
|
83
|
+
"status": null,
|
|
84
|
+
"statusReason": null,
|
|
85
|
+
"cancelRequested": null,
|
|
86
|
+
"attempt": null,
|
|
87
|
+
"retries": null,
|
|
88
|
+
"evictions": null,
|
|
89
|
+
"oomExits": null,
|
|
90
|
+
"reservationMb": null,
|
|
91
|
+
"wholeGpu": null,
|
|
92
|
+
"predictedMb": null,
|
|
93
|
+
"predictionSource": null,
|
|
94
|
+
"predictedComputePct": null,
|
|
95
|
+
"computePredictionSource": null,
|
|
96
|
+
"peakMemoryMb": null,
|
|
97
|
+
"gpuMemoryTotalMb": null,
|
|
98
|
+
"utilMeanPct": null,
|
|
99
|
+
"busyPct": null,
|
|
100
|
+
"memorySource": null,
|
|
101
|
+
"sharingMode": null,
|
|
102
|
+
"gpuSeconds": null,
|
|
103
|
+
"attributedCostUsd": null,
|
|
104
|
+
"exitCode": null,
|
|
105
|
+
"createdAt": null,
|
|
106
|
+
"startedAt": null,
|
|
107
|
+
"finishedAt": null,
|
|
108
|
+
"sharingHint": null,
|
|
109
|
+
"attempts": null,
|
|
110
|
+
} satisfies Job
|
|
111
|
+
|
|
112
|
+
console.log(example)
|
|
113
|
+
|
|
114
|
+
// Convert the instance to a JSON string
|
|
115
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
116
|
+
console.log(exampleJSON)
|
|
117
|
+
|
|
118
|
+
// Parse the JSON string back to an object
|
|
119
|
+
const exampleParsed = JSON.parse(exampleJSON) as Job
|
|
120
|
+
console.log(exampleParsed)
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
124
|
+
|
|
125
|
+
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
|
|
2
|
+
# JobAttempt
|
|
3
|
+
|
|
4
|
+
One run of a job.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`attempt` | number
|
|
11
|
+
`reservationMb` | number
|
|
12
|
+
`wholeGpu` | boolean
|
|
13
|
+
`predictionSource` | string
|
|
14
|
+
`outcome` | string
|
|
15
|
+
`reason` | string
|
|
16
|
+
`exitCode` | number
|
|
17
|
+
`peakMemoryMb` | number
|
|
18
|
+
`predictedComputePct` | number
|
|
19
|
+
`utilMeanPct` | number
|
|
20
|
+
`busyPct` | number
|
|
21
|
+
`computeSource` | string
|
|
22
|
+
`memorySource` | string
|
|
23
|
+
`sharingMode` | string
|
|
24
|
+
`migProfile` | string
|
|
25
|
+
`resumed` | boolean
|
|
26
|
+
`startedAt` | Date
|
|
27
|
+
`endedAt` | Date
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
```typescript
|
|
32
|
+
import type { JobAttempt } from '@gpuai/sdk'
|
|
33
|
+
|
|
34
|
+
// TODO: Update the object below with actual values
|
|
35
|
+
const example = {
|
|
36
|
+
"attempt": null,
|
|
37
|
+
"reservationMb": null,
|
|
38
|
+
"wholeGpu": null,
|
|
39
|
+
"predictionSource": null,
|
|
40
|
+
"outcome": null,
|
|
41
|
+
"reason": null,
|
|
42
|
+
"exitCode": null,
|
|
43
|
+
"peakMemoryMb": null,
|
|
44
|
+
"predictedComputePct": null,
|
|
45
|
+
"utilMeanPct": null,
|
|
46
|
+
"busyPct": null,
|
|
47
|
+
"computeSource": null,
|
|
48
|
+
"memorySource": null,
|
|
49
|
+
"sharingMode": null,
|
|
50
|
+
"migProfile": null,
|
|
51
|
+
"resumed": null,
|
|
52
|
+
"startedAt": null,
|
|
53
|
+
"endedAt": null,
|
|
54
|
+
} satisfies JobAttempt
|
|
55
|
+
|
|
56
|
+
console.log(example)
|
|
57
|
+
|
|
58
|
+
// Convert the instance to a JSON string
|
|
59
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
60
|
+
console.log(exampleJSON)
|
|
61
|
+
|
|
62
|
+
// Parse the JSON string back to an object
|
|
63
|
+
const exampleParsed = JSON.parse(exampleJSON) as JobAttempt
|
|
64
|
+
console.log(exampleParsed)
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
68
|
+
|
|
69
|
+
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
|
|
2
|
+
# JobCreate
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`name` | string
|
|
10
|
+
`image` | string
|
|
11
|
+
`command` | Array<string>
|
|
12
|
+
`env` | { [key: string]: string; }
|
|
13
|
+
`gpuType` | string
|
|
14
|
+
`minVramGb` | number
|
|
15
|
+
`memoryHintMb` | number
|
|
16
|
+
`computeHintPct` | number
|
|
17
|
+
`timeoutSeconds` | number
|
|
18
|
+
`maxWaitSeconds` | number
|
|
19
|
+
`allowSharing` | boolean
|
|
20
|
+
`allowRestart` | boolean
|
|
21
|
+
`isolation` | string
|
|
22
|
+
`checkpointPath` | string
|
|
23
|
+
`maxRetries` | number
|
|
24
|
+
`maxPricePerHour` | number
|
|
25
|
+
`secrets` | Array<string>
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import type { JobCreate } from '@gpuai/sdk'
|
|
31
|
+
|
|
32
|
+
// TODO: Update the object below with actual values
|
|
33
|
+
const example = {
|
|
34
|
+
"name": null,
|
|
35
|
+
"image": null,
|
|
36
|
+
"command": null,
|
|
37
|
+
"env": null,
|
|
38
|
+
"gpuType": null,
|
|
39
|
+
"minVramGb": null,
|
|
40
|
+
"memoryHintMb": null,
|
|
41
|
+
"computeHintPct": null,
|
|
42
|
+
"timeoutSeconds": null,
|
|
43
|
+
"maxWaitSeconds": null,
|
|
44
|
+
"allowSharing": null,
|
|
45
|
+
"allowRestart": null,
|
|
46
|
+
"isolation": null,
|
|
47
|
+
"checkpointPath": null,
|
|
48
|
+
"maxRetries": null,
|
|
49
|
+
"maxPricePerHour": null,
|
|
50
|
+
"secrets": null,
|
|
51
|
+
} satisfies JobCreate
|
|
52
|
+
|
|
53
|
+
console.log(example)
|
|
54
|
+
|
|
55
|
+
// Convert the instance to a JSON string
|
|
56
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
57
|
+
console.log(exampleJSON)
|
|
58
|
+
|
|
59
|
+
// Parse the JSON string back to an object
|
|
60
|
+
const exampleParsed = JSON.parse(exampleJSON) as JobCreate
|
|
61
|
+
console.log(exampleParsed)
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
65
|
+
|
|
66
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# JobGpuTypes
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<JobGpuTypesDataInner>](JobGpuTypesDataInner.md)
|
|
10
|
+
`complete` | boolean
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { JobGpuTypes } from '@gpuai/sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"data": null,
|
|
20
|
+
"complete": null,
|
|
21
|
+
} satisfies JobGpuTypes
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as JobGpuTypes
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
|
|
2
|
+
# JobGpuTypesDataInner
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`gpuType` | string
|
|
10
|
+
`vramGb` | number
|
|
11
|
+
`availableNow` | boolean
|
|
12
|
+
`pricePerGpuHour` | number
|
|
13
|
+
`lastSeenAt` | Date
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { JobGpuTypesDataInner } from '@gpuai/sdk'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"gpuType": null,
|
|
23
|
+
"vramGb": null,
|
|
24
|
+
"availableNow": null,
|
|
25
|
+
"pricePerGpuHour": null,
|
|
26
|
+
"lastSeenAt": null,
|
|
27
|
+
} satisfies JobGpuTypesDataInner
|
|
28
|
+
|
|
29
|
+
console.log(example)
|
|
30
|
+
|
|
31
|
+
// Convert the instance to a JSON string
|
|
32
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
33
|
+
console.log(exampleJSON)
|
|
34
|
+
|
|
35
|
+
// Parse the JSON string back to an object
|
|
36
|
+
const exampleParsed = JSON.parse(exampleJSON) as JobGpuTypesDataInner
|
|
37
|
+
console.log(exampleParsed)
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
41
|
+
|
|
42
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
|
|
2
|
+
# JobLogChunk
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`attempt` | number
|
|
11
|
+
`text` | string
|
|
12
|
+
`createdAt` | Date
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { JobLogChunk } from '@gpuai/sdk'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"id": null,
|
|
22
|
+
"attempt": null,
|
|
23
|
+
"text": null,
|
|
24
|
+
"createdAt": null,
|
|
25
|
+
} satisfies JobLogChunk
|
|
26
|
+
|
|
27
|
+
console.log(example)
|
|
28
|
+
|
|
29
|
+
// Convert the instance to a JSON string
|
|
30
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
31
|
+
console.log(exampleJSON)
|
|
32
|
+
|
|
33
|
+
// Parse the JSON string back to an object
|
|
34
|
+
const exampleParsed = JSON.parse(exampleJSON) as JobLogChunk
|
|
35
|
+
console.log(exampleParsed)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
39
|
+
|
|
40
|
+
|
package/docs/JobLogs.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# JobLogs
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<JobLogChunk>](JobLogChunk.md)
|
|
10
|
+
`nextAfter` | number
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { JobLogs } from '@gpuai/sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"data": null,
|
|
20
|
+
"nextAfter": null,
|
|
21
|
+
} satisfies JobLogs
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as JobLogs
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
package/docs/JobPage.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# JobPage
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<Job>](Job.md)
|
|
10
|
+
`nextCursor` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { JobPage } from '@gpuai/sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"data": null,
|
|
20
|
+
"nextCursor": null,
|
|
21
|
+
} satisfies JobPage
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as JobPage
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
# JobSharingHint
|
|
3
|
+
|
|
4
|
+
Advisory only, and present only when it applies. A job carries it when it succeeded with a whole GPU it did not allow to be shared, ran at least a minute with no out-of-memory exit or eviction, and its peak GPU memory, measured from per-process accounting (`memory_source` `process`), was at most half of the GPU\'s memory. Sharing stays opt-in; the hint never changes how a job is placed.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`message` | string
|
|
11
|
+
`peakMemoryMb` | number
|
|
12
|
+
`gpuMemoryTotalMb` | number
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { JobSharingHint } from '@gpuai/sdk'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"message": null,
|
|
22
|
+
"peakMemoryMb": null,
|
|
23
|
+
"gpuMemoryTotalMb": null,
|
|
24
|
+
} satisfies JobSharingHint
|
|
25
|
+
|
|
26
|
+
console.log(example)
|
|
27
|
+
|
|
28
|
+
// Convert the instance to a JSON string
|
|
29
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
30
|
+
console.log(exampleJSON)
|
|
31
|
+
|
|
32
|
+
// Parse the JSON string back to an object
|
|
33
|
+
const exampleParsed = JSON.parse(exampleJSON) as JobSharingHint
|
|
34
|
+
console.log(exampleParsed)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
38
|
+
|
|
39
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
|
|
2
|
+
# JobTelemetry
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`peakMemoryMb` | number
|
|
10
|
+
`reservationMb` | number
|
|
11
|
+
`gpuMemoryTotalMb` | number
|
|
12
|
+
`points` | [Array<JobTelemetryPoint>](JobTelemetryPoint.md)
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { JobTelemetry } from '@gpuai/sdk'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"peakMemoryMb": null,
|
|
22
|
+
"reservationMb": null,
|
|
23
|
+
"gpuMemoryTotalMb": null,
|
|
24
|
+
"points": null,
|
|
25
|
+
} satisfies JobTelemetry
|
|
26
|
+
|
|
27
|
+
console.log(example)
|
|
28
|
+
|
|
29
|
+
// Convert the instance to a JSON string
|
|
30
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
31
|
+
console.log(exampleJSON)
|
|
32
|
+
|
|
33
|
+
// Parse the JSON string back to an object
|
|
34
|
+
const exampleParsed = JSON.parse(exampleJSON) as JobTelemetry
|
|
35
|
+
console.log(exampleParsed)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
39
|
+
|
|
40
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
|
|
2
|
+
# JobTelemetryPoint
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`ts` | Date
|
|
10
|
+
`attempt` | number
|
|
11
|
+
`memoryMb` | number
|
|
12
|
+
`gpuMemoryMb` | number
|
|
13
|
+
`gpuUtilPct` | number
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { JobTelemetryPoint } from '@gpuai/sdk'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"ts": null,
|
|
23
|
+
"attempt": null,
|
|
24
|
+
"memoryMb": null,
|
|
25
|
+
"gpuMemoryMb": null,
|
|
26
|
+
"gpuUtilPct": null,
|
|
27
|
+
} satisfies JobTelemetryPoint
|
|
28
|
+
|
|
29
|
+
console.log(example)
|
|
30
|
+
|
|
31
|
+
// Convert the instance to a JSON string
|
|
32
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
33
|
+
console.log(exampleJSON)
|
|
34
|
+
|
|
35
|
+
// Parse the JSON string back to an object
|
|
36
|
+
const exampleParsed = JSON.parse(exampleJSON) as JobTelemetryPoint
|
|
37
|
+
console.log(exampleParsed)
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
41
|
+
|
|
42
|
+
|