Fine Tunes - Create

Služba:: Azure AI Services

Verze rozhraní API:: 2023-05-15

Vytvoří úlohu, která jemně naladí zadaný model z daného trénovacího souboru. Odpověď obsahuje podrobnosti o výčtové úloze, včetně stavu úlohy a parametrů hyper. Po dokončení se do odpovědi přidá název jemně vyladěného modelu.

POST {endpoint}/openai/fine-tunes?api-version=2023-05-15

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (url)	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem účtu Azure OpenAI).
api-version	query	True	string	Požadovaná verze rozhraní API.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
api-key	True	string	Tady zadejte svůj klíč účtu Azure OpenAI služeb Cognitive Services.

Text požadavku

Name	Vyžadováno	Typ	Description
model	True	string minLength: 1	Identifikátor (ID modelu) základního modelu, který se používá pro tuto vyladění.
training_file	True	string minLength: 1	Identita souboru (ID souboru), která se používá k trénování tohoto jemně vyladěného modelu.
batch_size		integer (int32)	Velikost dávky, která se má použít pro trénování. Velikost dávky je počet trénovacích příkladů, které se používají k trénování jednoho dopředu a dozadu. Obecně jsme zjistili, že větší velikosti dávek obvykle fungují lépe u větších datových sad. Výchozí hodnota a maximální hodnota této vlastnosti jsou specifické pro základní model.
classification_betas		number[] (double)	Hodnoty beta klasifikace. Pokud je k dispozici, vypočítáme skóre F-beta na zadaných beta hodnotách. Skóre F-beta je generalizace skóre F-1. Používá se jenom pro binární klasifikaci. Při beta verzi 1 (tj. skóre F-1) se přesnost a úplnost přidají stejné hmotnosti. Větší beta skóre dává větší váhu na úplnost a méně přesnosti. Menší beta skóre dává větší váhu přesnosti a méně při úplnosti.
classification_n_classes		integer (int32)	Počet tříd v úkolu klasifikace. Tento parametr je vyžadován pro klasifikaci s více třídami.
classification_positive_class		string	Kladná třída v binární klasifikaci. Tento parametr je potřeba ke generování metrik přesnosti, úplnosti a F1 při binární klasifikaci.
compute_classification_metrics		boolean	Hodnota označující, jestli se mají metriky klasifikace výpočetních prostředků provádět. V případě nastavení vypočítáme metriky specifické pro klasifikaci, jako je přesnost a skóre F-1, pomocí ověřovací sady na konci každé epochy. Tyto metriky je možné zobrazit v souboru výsledků. Abyste mohli vypočítat metriky klasifikace, musíte zadat validation_file. Kromě toho je nutné zadat classification_n_classes pro vícetřídní klasifikaci nebo classification_positive_class pro binární klasifikaci.
learning_rate_multiplier		number (double)	Násobitel rychlosti učení, který se má použít pro trénování. Míra doladění je původní míra učení používaná pro předtrénování vynásobenou touto hodnotou. Větší rychlost učení obvykle funguje lépe s většími velikostmi dávek. Doporučujeme experimentovat s hodnotami v rozsahu 0,02 až 0,2, abyste zjistili, co vede k dosažení nejlepších výsledků.
n_epochs		integer (int32)	Počet epoch pro trénování modelu. Epocha odkazuje na jeden celý cyklus prostřednictvím trénovací datové sady.
prompt_loss_weight		number (double)	Váha, která se má použít ke ztrátě v tokenech výzvy. To určuje, kolik se model snaží naučit se generovat výzvu (ve srovnání s dokončením, které má vždy váhu 1,0) a může přidat stabilizační efekt trénování, když jsou dokončení krátké. Pokud jsou výzvy extrémně dlouhé (vzhledem k dokončení), může být vhodné tuto váhu snížit, aby se zabránilo nadměrné prioritě učení výzvy.
suffix		string	Přípona použitá k identifikaci jemně vyladěného modelu. Přípona může obsahovat až 40 znaků (a-z, A-Z, 0-9 a _), které se přidají do vašeho jemně vyladěného názvu modelu.
validation_file		string	Identita souboru (ID souboru), která se používá k vyhodnocení jemně vyladěného modelu během trénování.

Odpovědi

Name	Typ	Description
201 Created	FineTune	Vyladění bylo úspěšně vytvořeno. Hlavičky Location: string
Other Status Codes	ErrorResponse	Došlo k chybě.

Name

Typ

Description

201 Created

FineTune

Vyladění bylo úspěšně vytvořeno.

Hlavičky

Location: string

Other Status Codes

ErrorResponse

Došlo k chybě.

Zabezpečení

api-key

Tady zadejte svůj klíč účtu Azure OpenAI služeb Cognitive Services.

Typ: apiKey
V: header

Příklady

Creating a fine tune job for classification.

Creating a fine tune job.

Creating a fine tune job for classification.

Ukázkový požadavek

HTTP

POST https://aoairesource.openai.azure.com/openai/fine-tunes?api-version=2023-05-15


{
  "compute_classification_metrics": true,
  "classification_n_classes": 4,
  "model": "curie",
  "training_file": "file-181a1cbdcdcf4677ada87f63a0928099"
}

Ukázková odpověď

Stavový kód:: 201

location: https://aoairesource.openai.azure.com/openai/fine-tunes/ft-72a2792ef7d24ba7b82c7fe4a37e379f

{
  "hyperparams": {
    "compute_classification_metrics": true,
    "classification_n_classes": 4,
    "batch_size": 32,
    "learning_rate_multiplier": 1,
    "n_epochs": 2,
    "prompt_loss_weight": 0.1
  },
  "model": "curie",
  "training_files": [
    {
      "statistics": {
        "tokens": 42,
        "examples": 23
      },
      "bytes": 140,
      "purpose": "fine-tune",
      "filename": "puppy.jsonl",
      "id": "file-181a1cbdcdcf4677ada87f63a0928099",
      "status": "succeeded",
      "created_at": 1646126127,
      "updated_at": 1646127311,
      "object": "file"
    }
  ],
  "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
  "status": "notRunning",
  "created_at": 1646126127,
  "updated_at": 1646127311,
  "object": "fine-tune"
}

Creating a fine tune job.

Ukázkový požadavek

HTTP

POST https://aoairesource.openai.azure.com/openai/fine-tunes?api-version=2023-05-15


{
  "model": "curie",
  "training_file": "file-181a1cbdcdcf4677ada87f63a0928099"
}

Ukázková odpověď

Stavový kód:: 201

location: https://aoairesource.openai.azure.com/openai/fine-tunes/ft-72a2792ef7d24ba7b82c7fe4a37e379f

{
  "hyperparams": {
    "batch_size": 32,
    "learning_rate_multiplier": 1,
    "n_epochs": 2,
    "prompt_loss_weight": 0.1
  },
  "model": "curie",
  "training_files": [
    {
      "statistics": {
        "tokens": 42,
        "examples": 23
      },
      "bytes": 140,
      "purpose": "fine-tune",
      "filename": "puppy.jsonl",
      "id": "file-181a1cbdcdcf4677ada87f63a0928099",
      "status": "succeeded",
      "created_at": 1646126127,
      "updated_at": 1646127311,
      "object": "file"
    }
  ],
  "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
  "status": "notRunning",
  "created_at": 1646126127,
  "updated_at": 1646127311,
  "object": "fine-tune"
}

Definice

Name	Description
Error	Chyba
ErrorCode	Kód chyby
ErrorResponse	ErrorResponse
Event	Událost
File	Soubor
FileStatistics	FileStatistics
FineTune	FineTune
FineTuneCreation	FineTuneCreation
HyperParameters	HyperParametry
InnerError	Vnitřní chyba
InnerErrorCode	InnerErrorCode
LogLevel	LogLevel
Purpose	Účel
State	Stát
TypeDiscriminator	Type Nábídka

Error

Objekt

Chyba

Name	Typ	Description
code	ErrorCode	Kód chyby Kódy chyb definované v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Podrobnosti o chybě, pokud jsou k dispozici.
innererror	InnerError	Vnitřní chyba Vnitřní chyba definovaná v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string minLength: 1	Zpráva o této chybě.
target	string	Umístění, kde k chybě došlo, pokud je k dispozici.

ErrorCode

Výčet

Kód chyby

Hodnota	Description
conflict	Požadovaná operace je v konfliktu s aktuálním stavem prostředku.
invalidPayload	Data požadavku jsou pro tuto operaci neplatná.
forbidden	Operace je zakázaná pro aktuální klíč uživatele nebo rozhraní API.
notFound	Prostředek nebyl nalezen.
unexpectedEntityState	Operaci nelze spustit ve stavu aktuálního prostředku.
itemDoesAlreadyExist	Položka již existuje.
serviceUnavailable	Služba není aktuálně dostupná.
internalFailure	Vnitřní chyba. Zkuste to prosím znovu.
quotaExceeded	Kvóta byla překročena.
jsonlValidationFailed	Ověření dat jsonl se nezdařilo.
fileImportFailed	Import souboru se nezdařil.

ErrorResponse

Objekt

ErrorResponse

Name	Typ	Description
error	Error	Chyba Obsah chyby definovaný v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

Event

Objekt

Událost

Name	Typ	Description
created_at	integer (unixtime)	Časové razítko, kdy byla tato událost vytvořena (v unixových epochách).
level	LogLevel	LogLevel Úroveň podrobností události.
message	string minLength: 1	Zpráva popisující událost. Může se jednat o změnu stavu, například zařazení do fronty, spuštění, selhání nebo dokončení nebo jiné události, jako jsou nahrané výsledky.
object	TypeDiscriminator	Type Nábídka Definuje typ objektu.

File

Objekt

Soubor

Name	Typ	Description
bytes	integer (int64)	Velikost tohoto souboru, pokud je k dispozici (může mít hodnotu null). Soubory větší než 2^53-1 nejsou podporovány, aby byla zajištěna kompatibilita s celými čísly Jazyka JavaScript.
created_at	integer (unixtime)	Časové razítko při vytvoření této úlohy nebo položky (v epochách unixu)
error	Error	Chyba Obsah chyby definovaný v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
filename	string minLength: 1	Název souboru.
id	string	Identita této položky.
object	TypeDiscriminator	Type Nábídka Definuje typ objektu.
purpose	Purpose	Účel Zamýšlený účel nahraných dokumentů. K jemnému ladění použijte "jemné ladění". To nám umožňuje ověřit formát nahraného souboru.
statistics	FileStatistics	FileStatistics Soubor je dokument použitelný pro trénování a ověřování. Může to být také dokument vygenerovaný službou s podrobnostmi o výsledku.
status	State	Stát Stav úlohy nebo položky
updated_at	integer (unixtime)	Časové razítko, kdy byla tato úloha nebo položka změněna naposledy (v unixových epochách).

FileStatistics

Objekt

FileStatistics

Name	Typ	Description
examples	integer (int32)	Počet trénovacích příkladů v souborech typu "doladění" po dokončení ověření obsahu souboru.
tokens	integer (int32)	Počet tokenů použitých v dotazech a dokončování pro soubory typu "doladění" po dokončení ověření obsahu souboru.

FineTune

Objekt

FineTune

Name	Typ	Description
created_at	integer (unixtime)	Časové razítko při vytvoření této úlohy nebo položky (v epochách unixu)
error	Error	Chyba Obsah chyby definovaný v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
events	Event[]	Události, které ukazují průběh ladění spuštění, včetně zařazení do fronty, spuštění a dokončení.
fine_tuned_model	string	Identifikátor (ID modelu) výsledného jemně vyladěného modelu. Tato vlastnost se vyplní pouze pro úspěšně dokončená spuštění vyladění. Tento identifikátor použijte k vytvoření nasazení pro odvozování.
hyperparams	HyperParameters	HyperParametry Nastavení hyperparametru použitého v úloze vyladění.
id	string	Identita této položky.
model	string minLength: 1	Identifikátor (ID modelu) základního modelu, který se používá pro vyladění.
object	TypeDiscriminator	Type Nábídka Definuje typ objektu.
organisation_id	string	ID organizace této vyladěné práce. Nepoužívá se v Azure OpenAI; pouze pro OpenAI.
result_files	File[]	Identity výsledného souboru (id souboru) obsahující trénovací a vyhodnocovací metriky ve formátu CSV. Soubor je k dispozici pouze pro úspěšně dokončená spuštění dolaďování.
status	State	Stát Stav úlohy nebo položky
suffix	string	Přípona použitá k identifikaci jemně vyladěného modelu.
training_files	File[]	Identity souborů (id souboru), které se používají k trénování jemně vyladěného modelu.
updated_at	integer (unixtime)	Časové razítko, kdy byla tato úloha nebo položka změněna naposledy (v unixových epochách).
user_id	string	ID uživatele této úlohy vyladění Nepoužívá se v Azure OpenAI; pouze pro OpenAI.
validation_files	File[]	Identity souborů (id souboru), které se používají k vyhodnocení jemně vyladěného modelu během trénování.

FineTuneCreation

Objekt

FineTuneCreation

Name	Typ	Description
batch_size	integer (int32)	Velikost dávky, která se má použít pro trénování. Velikost dávky je počet trénovacích příkladů, které se používají k trénování jednoho dopředu a dozadu. Obecně jsme zjistili, že větší velikosti dávek obvykle fungují lépe u větších datových sad. Výchozí hodnota a maximální hodnota této vlastnosti jsou specifické pro základní model.
classification_betas	number[] (double)	Hodnoty beta klasifikace. Pokud je k dispozici, vypočítáme skóre F-beta na zadaných beta hodnotách. Skóre F-beta je generalizace skóre F-1. Používá se jenom pro binární klasifikaci. Při beta verzi 1 (tj. skóre F-1) se přesnost a úplnost přidají stejné hmotnosti. Větší beta skóre dává větší váhu na úplnost a méně přesnosti. Menší beta skóre dává větší váhu přesnosti a méně při úplnosti.
classification_n_classes	integer (int32)	Počet tříd v úkolu klasifikace. Tento parametr je vyžadován pro klasifikaci s více třídami.
classification_positive_class	string	Kladná třída v binární klasifikaci. Tento parametr je potřeba ke generování metrik přesnosti, úplnosti a F1 při binární klasifikaci.
compute_classification_metrics	boolean	Hodnota označující, jestli se mají metriky klasifikace výpočetních prostředků provádět. V případě nastavení vypočítáme metriky specifické pro klasifikaci, jako je přesnost a skóre F-1, pomocí ověřovací sady na konci každé epochy. Tyto metriky je možné zobrazit v souboru výsledků. Abyste mohli vypočítat metriky klasifikace, musíte zadat validation_file. Kromě toho je nutné zadat classification_n_classes pro vícetřídní klasifikaci nebo classification_positive_class pro binární klasifikaci.
learning_rate_multiplier	number (double)	Násobitel rychlosti učení, který se má použít pro trénování. Míra doladění je původní míra učení používaná pro předtrénování vynásobenou touto hodnotou. Větší rychlost učení obvykle funguje lépe s většími velikostmi dávek. Doporučujeme experimentovat s hodnotami v rozsahu 0,02 až 0,2, abyste zjistili, co vede k dosažení nejlepších výsledků.
model	string minLength: 1	Identifikátor (ID modelu) základního modelu, který se používá pro tuto vyladění.
n_epochs	integer (int32)	Počet epoch pro trénování modelu. Epocha odkazuje na jeden celý cyklus prostřednictvím trénovací datové sady.
prompt_loss_weight	number (double)	Váha, která se má použít ke ztrátě v tokenech výzvy. To určuje, kolik se model snaží naučit se generovat výzvu (ve srovnání s dokončením, které má vždy váhu 1,0) a může přidat stabilizační efekt trénování, když jsou dokončení krátké. Pokud jsou výzvy extrémně dlouhé (vzhledem k dokončení), může být vhodné tuto váhu snížit, aby se zabránilo nadměrné prioritě učení výzvy.
suffix	string	Přípona použitá k identifikaci jemně vyladěného modelu. Přípona může obsahovat až 40 znaků (a-z, A-Z, 0-9 a _), které se přidají do vašeho jemně vyladěného názvu modelu.
training_file	string minLength: 1	Identita souboru (ID souboru), která se používá k trénování tohoto jemně vyladěného modelu.
validation_file	string	Identita souboru (ID souboru), která se používá k vyhodnocení jemně vyladěného modelu během trénování.

HyperParameters

Objekt

HyperParametry

Name	Typ	Description
batch_size	integer (int32)	Velikost dávky, která se má použít pro trénování. Velikost dávky je počet trénovacích příkladů, které se používají k trénování jednoho dopředu a dozadu. Obecně jsme zjistili, že větší velikosti dávek obvykle fungují lépe u větších datových sad. Výchozí hodnota a maximální hodnota této vlastnosti jsou specifické pro základní model.
classification_betas	number[] (double)	Hodnoty beta klasifikace. Pokud je k dispozici, vypočítáme skóre F-beta na zadaných beta hodnotách. Skóre F-beta je generalizace skóre F-1. Používá se jenom pro binární klasifikaci. Při beta verzi 1 (tj. skóre F-1) se přesnost a úplnost přidají stejné hmotnosti. Větší beta skóre dává větší váhu na úplnost a méně přesnosti. Menší beta skóre dává větší váhu přesnosti a méně při úplnosti.
classification_n_classes	integer (int32)	Počet tříd v úkolu klasifikace. Tento parametr je vyžadován pro klasifikaci s více třídami.
classification_positive_class	string	Kladná třída v binární klasifikaci. Tento parametr je potřeba ke generování metrik přesnosti, úplnosti a F1 při binární klasifikaci.
compute_classification_metrics	boolean	Hodnota označující, jestli se mají metriky klasifikace výpočetních prostředků provádět. V případě nastavení vypočítáme metriky specifické pro klasifikaci, jako je přesnost a skóre F-1, pomocí ověřovací sady na konci každé epochy. Tyto metriky je možné zobrazit v souboru výsledků. Abyste mohli vypočítat metriky klasifikace, musíte zadat validation_file. Kromě toho je nutné zadat classification_n_classes pro vícetřídní klasifikaci nebo classification_positive_class pro binární klasifikaci.
learning_rate_multiplier	number (double)	Násobitel rychlosti učení, který se má použít pro trénování. Míra doladění je původní míra učení používaná pro předtrénování vynásobenou touto hodnotou. Větší rychlost učení obvykle funguje lépe s většími velikostmi dávek. Doporučujeme experimentovat s hodnotami v rozsahu 0,02 až 0,2, abyste zjistili, co vede k dosažení nejlepších výsledků.
n_epochs	integer (int32)	Počet epoch pro trénování modelu. Epocha odkazuje na jeden celý cyklus prostřednictvím trénovací datové sady.
prompt_loss_weight	number (double)	Váha, která se má použít ke ztrátě v tokenech výzvy. To určuje, kolik se model snaží naučit se generovat výzvu (ve srovnání s dokončením, které má vždy váhu 1,0) a může přidat stabilizační efekt trénování, když jsou dokončení krátké. Pokud jsou výzvy extrémně dlouhé (vzhledem k dokončení), může být vhodné tuto váhu snížit, aby se zabránilo nadměrné prioritě učení výzvy.

InnerError

Objekt

Vnitřní chyba

Name	Typ	Description
code	InnerErrorCode	InnerErrorCode Vnitřní kódy chyb definované v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	Vnitřní chyba Vnitřní chyba definovaná v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Výčet

InnerErrorCode

Hodnota	Description
invalidPayload	Data požadavku jsou pro tuto operaci neplatná.

LogLevel

Výčet

LogLevel

Hodnota	Description
info	Tato událost je určena pouze pro informace.
warning	Tato událost představuje zmírnit problém.
error	Tato zpráva představuje problém, který nejde obnovit.

Purpose

Výčet

Účel

Hodnota	Description
fine-tune	Tento soubor obsahuje trénovací data pro doladění úlohy.
fine-tune-results	Tento soubor obsahuje výsledky úlohy vyladění.

State

Výčet

Stát

Hodnota	Description
notRunning	Operace byla vytvořena a není zařazena do fronty ke zpracování v budoucnu.
running	Operace se začala zpracovávat.
succeeded	Operace byla úspěšně zpracována a je připravená k použití.
canceled	Operace byla zrušena a je neúplná.
failed	Operace dokončila zpracování s chybou a nelze ji dále využívat.
deleted	Entita byla odstraněna, ale ostatní entity před odstraněním mohou být stále odkazovány.

TypeDiscriminator

Výčet

Type Nábídka

Hodnota	Description
list	Tento objekt představuje seznam dalších objektů.
fine-tune	Tento objekt představuje doladění úlohy.
file	Tento objekt představuje soubor.
fine-tune-event	Tento objekt představuje událost úlohy doladění.
model	Tento objekt představuje model (může to být základní modely nebo vyladění výsledku úlohy).

Sdílet prostřednictvím

Fine Tunes - Create

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

api-key

Příklady

Creating a fine tune job for classification.

Ukázkový požadavek

Ukázková odpověď

Creating a fine tune job.

Ukázkový požadavek

Ukázková odpověď

Definice

Error

ErrorCode

ErrorResponse

Event

File

FileStatistics

FineTune

FineTuneCreation

HyperParameters

InnerError

InnerErrorCode

LogLevel

Purpose

State

TypeDiscriminator