Fine Tuning - Create
指定したトレーニング ファイルから指定したモデルを微調整するジョブを作成します。 応答には、ジョブの状態やハイパー パラメーターなど、エンキューされたジョブの詳細が含まれます。 微調整されたモデルの名前は、完了すると応答に追加されます。
POST {endpoint}/openai/fine_tuning/jobs?api-version=2023-12-01-preview
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
endpoint
|
path | True |
string url |
サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など): https://aoairesource.openai.azure.com"aoairesource" を Azure OpenAI アカウント名に置き換えます)。 |
api-version
|
query | True |
string |
要求された API バージョン。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
api-key | True |
string |
Cognitive Services Azure OpenAI アカウント キーをここに入力します。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
model | True |
string |
この微調整に使用される基本モデルの識別子 (model-id)。 |
training_file | True |
string |
この微調整されたモデルのトレーニングに使用されるファイル ID (ファイル ID)。 |
hyperparameters |
FineTuningHyperParameters |
||
suffix |
string |
微調整されたモデルを識別するために使用されるサフィックス。 サフィックスには、微調整されたモデル名に追加される最大 40 文字 (a から z、A から Z、0 から 9、および _) を含めることができます。 |
|
validation_file |
string |
トレーニング中に微調整されたモデルを評価するために使用されるファイル ID (ファイル ID)。 |
応答
名前 | 型 | 説明 |
---|---|---|
201 Created |
微調整が正常に作成されました。 ヘッダー Location: string |
|
Other Status Codes |
エラーが発生しました。 |
セキュリティ
api-key
Cognitive Services Azure OpenAI アカウント キーをここに入力します。
型:
apiKey
/:
header
例
Creating a fine tune job.
要求のサンプル
POST https://aoairesource.openai.azure.com/openai/fine_tuning/jobs?api-version=2023-12-01-preview
{
"model": "curie",
"training_file": "file-181a1cbdcdcf4677ada87f63a0928099"
}
応答のサンプル
location: https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f
{
"hyperparameters": {
"n_epochs": 2
},
"model": "curie",
"training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
"id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
"status": "notRunning",
"created_at": 1646126127,
"updated_at": 1646127311,
"object": "fine_tuning.job"
}
定義
名前 | 説明 |
---|---|
Error |
エラー |
Error |
ErrorCode |
Error |
ErrorResponse |
Fine |
FineTuningHyperParameters |
Fine |
FineTuningJob |
Fine |
FineTuningJobCreation |
Fine |
FineTuningState |
Inner |
InnerError |
Inner |
InnerErrorCode |
Type |
TypeDiscriminator |
Error
エラー
名前 | 型 | 説明 |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
エラーの詳細 (使用可能な場合)。 |
innererror |
InnerError |
|
message |
string |
このエラーのメッセージ。 |
target |
string |
エラーが発生した場所 (使用可能な場合)。 |
ErrorCode
ErrorCode
名前 | 型 | 説明 |
---|---|---|
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
ErrorResponse
名前 | 型 | 説明 |
---|---|---|
error |
エラー |
FineTuningHyperParameters
FineTuningHyperParameters
名前 | 型 | 説明 |
---|---|---|
batch_size |
integer |
トレーニングに使用するバッチ サイズ。 バッチ サイズは、単一の順方向および逆方向の合格をトレーニングするために使用するトレーニング例の数です。 一般的に、大規模なデータセットでは、バッチ サイズが大きいほど適切に機能する傾向があることがわかっています。 既定値とこのプロパティの最大値は、基本モデルに固有です。 |
learning_rate_multiplier |
number |
トレーニングに使用する学習率乗数。 微調整の学習率は、事前トレーニングに使用された元の学習率にこの値を掛けた値です。 より大きな学習率は、より大きなバッチサイズでより良いパフォーマンスを発揮する傾向があります。 0.02 から 0.2 の範囲の値を試して、最適な結果が得られるものを確認することをお勧めします。 |
n_epochs |
integer |
モデルをトレーニングするエポックの数。 エポックとは、トレーニング データセット全体での 1 つの完全なサイクルを指します。 |
FineTuningJob
FineTuningJob
名前 | 型 | 説明 |
---|---|---|
created_at |
integer |
このジョブまたは項目が作成されたときのタイムスタンプ (unix エポック)。 |
fine_tuned_model |
string |
結果として得られる微調整されたモデルの識別子 (model-id)。 このプロパティは、正常に完了した微調整の実行に対してのみ設定されます。 この識別子を使用して、推論用のデプロイを作成します。 |
finished_at |
integer |
このジョブまたは項目が正常に完了したときのタイムスタンプ (unix エポック)。 |
hyperparameters |
FineTuningHyperParameters |
|
id |
string |
このアイテムの ID。 |
model |
string |
微調整に使用される基本モデルの識別子 (model-id)。 |
object |
TypeDiscriminator |
|
organisation_id |
string |
この微調整ジョブの組織 ID。 Azure OpenAI では使用されていません。OpenAI のみの互換性。 |
result_files |
string[] |
トレーニングと評価のメトリックを csv 形式で含む結果ファイル ID (ファイル ID)。 ファイルは、正常に完了した微調整実行でのみ使用できます。 |
status |
FineTuningState |
|
suffix |
string |
微調整されたモデルを識別するために使用されるサフィックス。 サフィックスには、微調整されたモデル名に追加される最大 40 文字 (a から z、A から Z、0 から 9、および _) を含めることができます。 |
trained_tokens |
integer |
この微調整ジョブによって処理された課金対象トークンの合計数。 |
training_file |
string |
トレーニングに使用されるファイル。 |
updated_at |
integer |
このジョブまたは項目が最後に変更されたときのタイムスタンプ (unix エポック)。 |
validation_file |
string |
トレーニング中に微調整されたモデルを評価するために使用されるファイル。 |
FineTuningJobCreation
FineTuningJobCreation
名前 | 型 | 説明 |
---|---|---|
hyperparameters |
FineTuningHyperParameters |
|
model |
string |
この微調整に使用される基本モデルの識別子 (model-id)。 |
suffix |
string |
微調整されたモデルを識別するために使用されるサフィックス。 サフィックスには、微調整されたモデル名に追加される最大 40 文字 (a から z、A から Z、0 から 9、および _) を含めることができます。 |
training_file |
string |
この微調整されたモデルのトレーニングに使用されるファイル ID (ファイル ID)。 |
validation_file |
string |
トレーニング中に微調整されたモデルを評価するために使用されるファイル ID (ファイル ID)。 |
FineTuningState
FineTuningState
名前 | 型 | 説明 |
---|---|---|
cancelled |
string |
操作が取り消され、不完全です。 これは、終了状態として分類できます。 |
created |
string |
操作が作成されました。 この状態は Azure OpenAI によって返されず、互換性のためにのみ公開されます。 非アクティブ状態として分類できます。 |
failed |
string |
操作はエラーで処理を完了しており、それ以上使用することはできません。 これは、終了状態として分類できます。 |
pending |
string |
この操作は、今後処理されるキューにまだありません。 非アクティブ状態として分類できます。 |
running |
string |
操作の処理が開始されました。 アクティブな状態として分類できます。 |
succeeded |
string |
操作が正常に処理され、使用の準備が整いました。 これは、終了状態として分類できます。 |
InnerError
InnerError
名前 | 型 | 説明 |
---|---|---|
code |
InnerErrorCode |
|
innererror |
InnerError |
InnerErrorCode
InnerErrorCode
名前 | 型 | 説明 |
---|---|---|
invalidPayload |
string |
この操作の要求データが無効です。 |
TypeDiscriminator
TypeDiscriminator
名前 | 型 | 説明 |
---|---|---|
file |
string |
このオブジェクトは、ファイルを表します。 |
fine-tune |
string |
このオブジェクトは、微調整ジョブを表します。 |
fine-tune-event |
string |
このオブジェクトは、微調整ジョブのイベントを表します。 |
fine_tuning.job |
string |
このオブジェクトは、微調整ジョブを表します。 |
fine_tuning.job.event |
string |
このオブジェクトは、微調整ジョブのイベントを表します。 |
list |
string |
このオブジェクトは、他のオブジェクトの一覧を表します。 |
model |
string |
このオブジェクトは、モデルを表します (基本モデルまたは微調整ジョブの結果を指定できます)。 |