Fine Tuning - Get Checkpoints

參考

服務:: Azure AI Services

API 版本:: 2024-10-21

取得指定 fine-tune-id 所指定微調作業的檢查點。檢查點會在定型期間成功的 Epoch 結尾建立。

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints?api-version=2024-10-21

含選擇性參數:

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints?after={after}&limit={limit}&api-version=2024-10-21

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string url	支援的認知服務端點（通訊協定和主機名，例如：https://aoairesource.openai.azure.com。以您的 Azure OpenAI 帳戶名稱取代「aoairesource」。。
fine-tuning-job-id	path	True	string	微調作業的標識碼。
api-version	query	True	string	要求的 API 版本。
after	query		string	上一個分頁要求中最後一個檢查點標識碼的標識碼。
limit	query		integer int32	要擷取的檢查點數目。預設值為 10。

要求標頭

名稱	必要	類型	Description
api-key	True	string	在這裡提供您的認知服務 Azure OpenAI 帳戶密鑰。

回應

名稱	類型	Description
200 OK	FineTuningJobCheckpointList	成功
Other Status Codes	ErrorResponse	發生錯誤。

安全性

api-key

在這裡提供您的認知服務 Azure OpenAI 帳戶密鑰。

類型: apiKey
位於: header

範例

Getting checkpoints of a fine tuning job.

範例要求

HTTP

GET https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ftjob-72a2792ef7d24ba7b82c7fe4a37e379f/checkpoints?api-version=2024-10-21

範例回覆

狀態碼:: 200

{
  "has_more": false,
  "data": [
    {
      "id": "ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P",
      "created_at": 1646126127,
      "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-10",
      "step_number": 10,
      "metrics": {
        "step": 10,
        "train_loss": 0.478,
        "train_mean_token_accuracy": 0.924,
        "valid_loss": 10.112,
        "valid_mean_token_accuracy": 0.145,
        "full_valid_loss": 0.567,
        "full_valid_mean_token_accuracy": 0.944
      },
      "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
      "object": "fine_tuning.job.checkpoint"
    },
    {
      "id": "ftckpt_frtXDR2453C4FG67t03MLPs5",
      "created_at": 1646126137,
      "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-20",
      "step_number": 20,
      "metrics": {
        "step": 20,
        "train_loss": 0.355,
        "train_mean_token_accuracy": 0.947,
        "valid_loss": 11.32,
        "valid_mean_token_accuracy": 0.122,
        "full_valid_loss": 0.317,
        "full_valid_mean_token_accuracy": 0.955
      },
      "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
      "object": "fine_tuning.job.checkpoint"
    },
    {
      "id": "ftckpt_agLk6Gio560ORp14gl123fgd",
      "created_at": 1646126147,
      "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-30",
      "step_number": 30,
      "metrics": {
        "step": 30,
        "train_loss": 0.155,
        "train_mean_token_accuracy": 0.975,
        "valid_loss": 9.31,
        "valid_mean_token_accuracy": 0.092,
        "full_valid_loss": 0.114,
        "full_valid_mean_token_accuracy": 0.963
      },
      "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
      "object": "fine_tuning.job.checkpoint"
    }
  ],
  "object": "list"
}

定義

名稱	Description
Error	錯誤
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningJobCheckpoint	FineTuningJobCheckpoint
FineTuningJobCheckpointList	FineTuningJobCheckpointList
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TypeDiscriminator

Error

錯誤

名稱	類型	Description
code	ErrorCode	ErrorCode Microsoft REST 指導方針中所定義的錯誤碼（https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses）。
details	Error[]	如果有的話，錯誤詳細數據。
innererror	InnerError	InnerError Microsoft REST 指導方針中所定義的內部錯誤（https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses）。
message	string	此錯誤的訊息。
target	string	如果有的話，就會發生錯誤的位置。

ErrorCode

名稱	類型	Description
conflict	string	要求的作業與目前的資源狀態衝突。
contentFilter	string	映射產生因我們的安全系統而失敗。
fileImportFailed	string	匯入檔案失敗。
forbidden	string	目前使用者/API 金鑰禁止此作業。
internalFailure	string	內部錯誤。請重試。
invalidPayload	string	此作業的要求數據無效。
itemDoesAlreadyExist	string	專案已經存在。
jsonlValidationFailed	string	jsonl 數據的驗證失敗。
notFound	string	找不到資源。
quotaExceeded	string	超過配額。
serviceUnavailable	string	服務目前無法使用。
tooManyRequests	string	要求太多。請稍後再試一次。
unauthorized	string	目前的使用者/API 金鑰未獲授權進行作業。
unexpectedEntityState	string	作業無法以目前資源的狀態執行。

ErrorResponse

名稱	類型	Description
error	Error	錯誤 Microsoft REST 指導方針中所定義的錯誤內容（https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses）。

FineTuningJobCheckpoint

名稱	類型	Description
created_at	integer	建立檢查點時的 Unix 時間戳（以秒為單位）。
fine_tuned_model_checkpoint	string	所建立之微調檢查點模型的名稱。
fine_tuning_job_id	string	從中建立這個檢查點的微調作業名稱。
id	string	這個檢查點的身分識別。
metrics	object	字典』2 微調作業期間步驟編號的計量。
object	TypeDiscriminator	TypeDiscriminator 定義物件的型別。
step_number	integer	建立檢查點的步驟編號。

FineTuningJobCheckpointList

名稱	類型	Description
data	FineTuningJobCheckpoint[]	項目清單。
has_more	boolean	值，指出清單是否包含超過傳回的元素。
object	TypeDiscriminator	TypeDiscriminator 定義物件的型別。

InnerError

名稱	類型	Description
code	InnerErrorCode	InnerErrorCode Microsoft REST 指導方針中所定義的內部錯誤碼（https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses）。
innererror	InnerError	InnerError Microsoft REST 指導方針中所定義的內部錯誤（https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses）。

InnerErrorCode

名稱	類型	Description
invalidPayload	string	此作業的要求數據無效。

TypeDiscriminator

名稱	類型	Description
batch	string	這個物件代表批次。
file	string	這個物件代表檔案。
fine_tuning.job	string	這個物件代表微調作業。
fine_tuning.job.checkpoint	string	這個物件代表微調作業的檢查點。
fine_tuning.job.event	string	這個物件代表微調作業的事件。
list	string	這個物件代表其他物件的清單。
model	string	這個物件代表模型（可以是基底模型或微調作業結果）。
upload	string	這個物件代表檔案上傳。
upload.part	string	這個物件代表檔案上傳的一部分。

共用方式為

Fine Tuning - Get Checkpoints

URI 參數

要求標頭

回應

安全性

api-key

範例

Getting checkpoints of a fine tuning job.

範例要求

範例回覆

定義

Error

ErrorCode

ErrorResponse

FineTuningJobCheckpoint

FineTuningJobCheckpointList

InnerError

InnerErrorCode

TypeDiscriminator

其他資源