mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-04 04:04:14 +00:00
71 lines
No EOL
9.3 KiB
Text
71 lines
No EOL
9.3 KiB
Text
---
|
|
id: get-the-status-of-a-training-job
|
|
title: "Get the status of a training job."
|
|
description: "Get the status of a training job."
|
|
sidebar_label: "Get the status of a training job."
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWNtu2zgQ/RVCTw2QxGmxRbd5y6aXzSJFg1weFmkR0NLYYiuRKkk5MQz/+56hrrbsJmm3DwWSl1gSOddzZoZcRJZcYbQjFx0uohcHB/wvIRdbVXhldHQYHYkz4/yllUorPf3HjC+89KU7rzfuR7tRbLQn7XmvLIpMxZL3jr44FrCIXJxSLvmXnxcEkWb8hWKPjYU1BVmvKvVfzPimLFXSW+m8hVKsXLXpSqtvJQmVQKuaKLJiYqzwKQlf2ykgLFruQgAbu0ki6TKPDq9hfF5k5CnBO6VvYNIUQXF4mkiVhdfsQFJWv2OpY8r49+d1q45La2GQqHQKM9lsUSPsRvpNdsGTnL9EifS051VOA/effQy/ZLYjLvEd+vJC3Kakg0LoEbfSic7qKg7W/1qddEdxyWvEmKZSs9Y2tr9S7wThdXB1V6iJ6LIJ9cijKW1M7kZmmQEqKdmEQpkkqtJxtoJHo+njBBBpd+gyyyC3fR4bk1HwtLckH5Ptv6md7b2R1sp5/0VtyfLz8jven+gqWhxgOTalD76WXlYLROusaJ0V3jRRCtlIKf5aGKV9nxCVNcC+p9zdT9KOcz9D086UYJgl+VMg2YCMTkMgQ62CtVFh4rSnCEtoCncGQhvihg1bJTs5q+QWKJM3DdtvuJg9pJSddMHZUDDwQvrGeDwotxa6Qvr0fiXvUMiEmzukWPAOdsbSujcQ7ryxlTetIzlBZuyGjaHPzMbkerGQzplYBaNvFfStW757D8p+MEct+yrzbzLj+pCuP68LOcUqMZMZoGr0agoAOekoRBoLVBLI9sNiOxF9wXAbJetO+fn9Ms/atXWohdJJ6LccfJNQhqqgJ8y4mKLlcltxm8jMERfIb6XihKMPViFfidzQ6RVr0QC98hmb2x8RPgTDHqe8V1VWysFua9ZGdtX47xly3MfYWnvukN4QKimZLl26bandfjSowqfKeWZnHeCujG4T9Djn27mnHVdWa/WWOA9GsYHHF+0gIrlLki+bugInl2zjH5smvktAle1DSQ0VTukAA4HancuMy3E1Cf0/U99gQtvG9b8vL8+a2SpGJgLNq7jcV//eWsuNhxfvIhYuNRZjWpnn0s6bskthzW2qUEdU5bRVEmDhniV1/T3oCQDxmA4fqrlazaozo+GbSMtc6j2AJ5FjlObenhVzWJPS8JnZfK+uXkE+Elfnp7UzmFgxkYnSVQOBZXrSjIBmtAA1mCpYuSsoBhtjYeI4DLUxrdn1GHy3oK6y1Qavh+sQpi3Ba44oYmJNHmw4OjvZF+emnKbZHOnBuHPrxPm7Y/Hqz4NXgb90J3kO7OMLUO/0/SUTcV5BvLPngcivmfPi9WbmxJniQ0DKowH/8MZgs543glkqgDBVM8wTMjelDrWlnmueSPVEqt+JVC9ed/ougfQPjPSaWa5PrX9NCU4gQnQXEyVhmgXZ0D1FpnLl98UZzlKOZ6+5kFO0OJHho2061cttncqRnSH5CCdTCWNtwsAqNd0h3tybqQ7DE7WeqPUbUetlv1+dMLL5lH9Rob3TX9PraAj5JhjJvvhYAgkk89CVxoTGo00Yt5OGXglNZJn5Ddd/3xH8RKonUv1epDrYpO0BFAosYajJqWNv+ucw8ezY5Pz/whi9M7wWfk91PHunsf4dz344xlqJAz1ZF+4bNR6ws3cwVCwJXdXOh3cgkH11dfKmSU64NjJiuq6W9XQZ8bak3SE/m9vKJdyAQanB0giimqP2YTSaPR/xYXyv8WEEhaM2vVU7rtwoLcc19b44HI0wGOyl2EfJXpbJXO5hS/x1PzZ5xMocIdLhDgQb3zTV6Pozf2N8Bhvr1J3yfnHB+8VFjdKAXr6xgPIqLrPnG0LFpHYr8JZ9wvUlh6s3lKmZgpBPWqz9oYJQmNxJJ/VtgNRhqlEWpclWiE04yVzM7ETy3WwQKi190ow6vmxDrobCx3wCyUBQK6eNVR/49qG6nuD4o3ZwTGqoPARkK7FYdKX7QZtrfHi686Miwze2IyR4USPjuor4CjbwzJfP7cUGkskY4MWLxRjj3pXNlkt+XWGbk58ox/UwacvIVrufnddw3hGPIcFGV77SfJVx4eYOrwI6QxsYM/iu+ZI+Rc3mC3BYW+07imMqfG/XoBmuEOr920tQ7D+fWqnf
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api/llama-stack-specification
|
|
custom_edit_url: null
|
|
---
|
|
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import ParamsDetails from "@theme/ParamsDetails";
|
|
import RequestSchema from "@theme/RequestSchema";
|
|
import StatusCodes from "@theme/StatusCodes";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
import Heading from "@theme/Heading";
|
|
|
|
<Heading
|
|
as={"h1"}
|
|
className={"openapi__heading"}
|
|
children={"Get the status of a training job."}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/v1/post-training/job/status"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Get the status of a training job.
|
|
|
|
<Heading
|
|
id={"request"}
|
|
as={"h2"}
|
|
className={"openapi-tabs__heading"}
|
|
children={"Request"}
|
|
>
|
|
</Heading>
|
|
|
|
<ParamsDetails
|
|
parameters={[{"name":"job_uuid","in":"query","description":"The UUID of the job to get the status of.","required":true,"schema":{"type":"string"}}]}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"A PostTrainingJobStatusResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"job_uuid":{"type":"string","description":"Unique identifier for the training job"},"status":{"type":"string","enum":["completed","in_progress","failed","scheduled","cancelled"],"description":"Current status of the training job"},"scheduled_at":{"type":"string","format":"date-time","description":"(Optional) Timestamp when the job was scheduled"},"started_at":{"type":"string","format":"date-time","description":"(Optional) Timestamp when the job execution began"},"completed_at":{"type":"string","format":"date-time","description":"(Optional) Timestamp when the job finished, if completed"},"resources_allocated":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"(Optional) Information about computational resources allocated to the job"},"checkpoints":{"type":"array","items":{"type":"object","properties":{"identifier":{"type":"string","description":"Unique identifier for the checkpoint"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the checkpoint was created"},"epoch":{"type":"integer","description":"Training epoch when the checkpoint was saved"},"post_training_job_id":{"type":"string","description":"Identifier of the training job that created this checkpoint"},"path":{"type":"string","description":"File system path where the checkpoint is stored"},"training_metrics":{"description":"(Optional) Training metrics associated with this checkpoint","type":"object","properties":{"epoch":{"type":"integer","description":"Training epoch number"},"train_loss":{"type":"number","description":"Loss value on the training dataset"},"validation_loss":{"type":"number","description":"Loss value on the validation dataset"},"perplexity":{"type":"number","description":"Perplexity metric indicating model confidence"}},"additionalProperties":false,"required":["epoch","train_loss","validation_loss","perplexity"],"title":"PostTrainingMetric"}},"additionalProperties":false,"required":["identifier","created_at","epoch","post_training_job_id","path"],"title":"Checkpoint","description":"Checkpoint created during training runs."},"description":"List of model checkpoints created during training"}},"additionalProperties":false,"required":["job_uuid","status","checkpoints"],"title":"PostTrainingJobStatusResponse","description":"Status of a finetuning job."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
|
|
>
|
|
|
|
</StatusCodes>
|
|
|
|
|
|
|