Fine Tunes - Create

Usługa:: Azure AI Services

Wersja API:: 2023-05-15

Tworzy zadanie, które dostraja określony model z danego pliku szkoleniowego. Odpowiedź zawiera szczegóły zadania w kolejce, w tym stan zadania i parametry hyper. Nazwa dostrojonego modelu jest dodawana do odpowiedzi po zakończeniu.

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

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (url)	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą konta usługi Azure OpenAI.
api-version	query	True	string	Żądana wersja interfejsu API.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
api-key	True	string	Tutaj podaj klucz konta usługi Azure OpenAI w usługach Cognitive Services.

Ciało żądania

Nazwa	Wymagane	Typ	Opis
model	True	string minLength: 1	Identyfikator (model-id) modelu podstawowego używanego na potrzeby tej precyzyjnej melodii.
training_file	True	string minLength: 1	Tożsamość pliku (identyfikator pliku), która jest używana do trenowania tego dobrze dostosowanego modelu.
batch_size		integer (int32)	Rozmiar partii do użycia do trenowania. Rozmiar partii to liczba przykładów trenowania używanych do trenowania pojedynczego przebiegu do przodu i do tyłu. Ogólnie rzecz biorąc, odkryliśmy, że większe rozmiary partii zwykle działają lepiej w przypadku większych zestawów danych. Wartość domyślna, a także maksymalna wartość tej właściwości są specyficzne dla modelu podstawowego.
classification_betas		number[] (double)	Wartości beta klasyfikacji. Jeśli zostanie to podane, obliczymy wyniki F-beta na określonych wartościach beta. Wynik F-beta jest uogólnienie wyniku F-1. Jest to używane tylko do klasyfikacji binarnej. Z beta 1 (tj. wynik F-1), precyzja i kompletność mają taką samą wagę. Większy wynik beta stawia większą wagę na kompletność i mniej na precyzję. Mniejszy wynik beta stawia większą wagę na precyzję i mniej na kompletność.
classification_n_classes		integer (int32)	Liczba klas w zadaniu klasyfikacji. Ten parametr jest wymagany do klasyfikacji wieloklasowej.
classification_positive_class		string	Dodatnia klasa w klasyfikacji binarnej. Ten parametr jest potrzebny do generowania dokładności, kompletności i F1 metryk podczas klasyfikacji binarnej.
compute_classification_metrics		boolean	Wartość wskazująca, czy metryki klasyfikacji obliczeniowej. W przypadku ustawienia obliczamy metryki specyficzne dla klasyfikacji, takie jak dokładność i wynik F-1, przy użyciu zestawu weryfikacji ustawionego na końcu każdej epoki. Te metryki można wyświetlić w pliku wyników. Aby obliczyć metryki klasyfikacji, należy podać validation_file. Ponadto należy określić classification_n_classes dla klasyfikacji wieloklasowej lub classification_positive_class klasyfikacji binarnej.
learning_rate_multiplier		number (double)	Mnożnik szybkości nauki używany do trenowania. Współczynnik dostrajania uczenia to oryginalny współczynnik uczenia używany do wstępnego trenowania pomnożonego przez tę wartość. Większe wskaźniki uczenia się mają tendencję do lepszej pracy z większymi rozmiarami partii. Zalecamy eksperymentowanie z wartościami z zakresu od 0,02 do 0,2, aby zobaczyć, co daje najlepsze wyniki.
n_epochs		integer (int32)	Liczba epok trenowania modelu dla. Epoka odnosi się do jednego pełnego cyklu za pośrednictwem zestawu danych trenowania.
prompt_loss_weight		number (double)	Waga do użycia do utraty na tokenach monitu. Określa to, ile model próbuje nauczyć się wygenerować monit (w porównaniu z ukończeniem, które zawsze ma wagę 1,0) i może dodać stabilizujący efekt do trenowania, gdy ukończenie jest krótkie. Jeśli monity są bardzo długie (w stosunku do ukończenia), warto zmniejszyć tę wagę, aby uniknąć nadmiernego określania priorytetów uczenia się monitu.
suffix		string	Sufiks używany do identyfikowania dostosowanego modelu. Sufiks może zawierać maksymalnie 40 znaków (a-z, A-Z, 0-9 i _), które zostaną dodane do nazwy dostosowanego modelu.
validation_file		string	Tożsamość pliku (identyfikator pliku), która jest używana do oceny dobrze dostosowanego modelu podczas trenowania.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	FineTune	Pomyślnie utworzono dostrojenie. Nagłówki Location: string
Other Status Codes	ErrorResponse	Wystąpił błąd.

Nazwa

Typ

Opis

201 Created

FineTune

Pomyślnie utworzono dostrojenie.

Nagłówki

Location: string

Other Status Codes

ErrorResponse

Wystąpił błąd.

Zabezpieczenia

api-key

Tutaj podaj klucz konta usługi Azure OpenAI w usługach Cognitive Services.

Typ: apiKey
W: header

Przykłady

Creating a fine tune job for classification.

Creating a fine tune job.

Creating a fine tune job for classification.

Przykładowa prośba

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"
}

Przykładowa odpowiedź

Kod statusu:: 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.

Przykładowa prośba

HTTP

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


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

Przykładowa odpowiedź

Kod statusu:: 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"
}

Definicje

Nazwa	Opis
Error	Błąd
ErrorCode	Kod błędu
ErrorResponse	ErrorResponse
Event	Zdarzenie
File	Plik
FileStatistics	FileStatistics
FineTune	FineTune
FineTuneCreation	FineTuneCreation
HyperParameters	Hiperparametry
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LogLevel	LogLevel
Purpose	Cel
State	Stan
TypeDiscriminator	TypeDiscriminator

Error

Sprzeciwiać się

Błąd

Nazwa	Typ	Opis
code	ErrorCode	Kod błędu Kody błędów zdefiniowane w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Szczegóły błędu, jeśli są dostępne.
innererror	InnerError	InnerError Błąd wewnętrzny zdefiniowany w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string minLength: 1	Komunikat o tym błędzie.
target	string	Lokalizacja, w której wystąpił błąd, jeśli jest dostępny.

ErrorCode

Wyliczenie

Kod błędu

Wartość	Opis
conflict	Żądana operacja powoduje konflikt z bieżącym stanem zasobu.
invalidPayload	Dane żądania są nieprawidłowe dla tej operacji.
forbidden	Operacja jest zabroniona dla bieżącego klucza użytkownika/interfejsu API.
notFound	Nie można odnaleźć zasobu.
unexpectedEntityState	Nie można wykonać operacji w stanie bieżącego zasobu.
itemDoesAlreadyExist	Element już istnieje.
serviceUnavailable	Usługa jest obecnie niedostępna.
internalFailure	Błąd wewnętrzny. Ponów próbę.
quotaExceeded	Przekroczono limit przydziału.
jsonlValidationFailed	Sprawdzanie poprawności danych jsonl nie powiodło się.
fileImportFailed	Importowanie pliku nie powiodło się.

ErrorResponse

Sprzeciwiać się

ErrorResponse

Nazwa	Typ	Opis
error	Error	Błąd Zawartość błędu zdefiniowana w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

Event

Sprzeciwiać się

Zdarzenie

Nazwa	Typ	Opis
created_at	integer (unixtime)	Sygnatura czasowa utworzenia tego zdarzenia (w epokach unix).
level	LogLevel	LogLevel Poziom szczegółowości zdarzenia.
message	string minLength: 1	Komunikat opisujący zdarzenie. Może to być zmiana stanu, np. w kolejce, uruchomiona, zakończona lub zakończona albo inne zdarzenia, takie jak przekazane wyniki.
object	TypeDiscriminator	TypeDiscriminator Definiuje typ obiektu.

File

Sprzeciwiać się

Plik

Nazwa	Typ	Opis
bytes	integer (int64)	Rozmiar tego pliku, jeśli jest dostępny (może mieć wartość null). Rozmiary plików większe niż 2^53–1 nie są obsługiwane w celu zapewnienia zgodności z liczbami całkowitymi języka JavaScript.
created_at	integer (unixtime)	Sygnatura czasowa utworzenia tego zadania lub elementu (w epokach unix).
error	Error	Błąd Zawartość błędu zdefiniowana w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
filename	string minLength: 1	Nazwa pliku.
id	string	Tożsamość tego elementu.
object	TypeDiscriminator	TypeDiscriminator Definiuje typ obiektu.
purpose	Purpose	Cel Przeznaczenie przekazanych dokumentów. Użyj polecenia "fine-tune" w celu dostrajania. Dzięki temu możemy zweryfikować format przekazanego pliku.
statistics	FileStatistics	FileStatistics Plik jest dokumentem, który można wykorzystać do trenowania i walidacji. Może to być również dokument wygenerowany przez usługę ze szczegółami wyników.
status	State	Stan Stan zadania lub elementu.
updated_at	integer (unixtime)	Sygnatura czasowa ostatniej modyfikacji tego zadania lub elementu (w epokach unix).

FileStatistics

Sprzeciwiać się

FileStatistics

Nazwa	Typ	Opis
examples	integer (int32)	Liczba zawartych przykładów szkoleniowych w plikach rodzaju "dostrajanie" po zakończeniu walidacji zawartości pliku.
tokens	integer (int32)	Liczba tokenów używanych w monitach i uzupełnianiach dla plików rodzaju "dostrajanie" po zakończeniu walidacji zawartości pliku.

FineTune

Sprzeciwiać się

FineTune

Nazwa	Typ	Opis
created_at	integer (unixtime)	Sygnatura czasowa utworzenia tego zadania lub elementu (w epokach unix).
error	Error	Błąd Zawartość błędu zdefiniowana w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
events	Event[]	Zdarzenia, które pokazują postęp przebiegu dostrajania, w tym w kolejce, uruchomione i ukończone.
fine_tuned_model	string	Identyfikator (model-id) wynikowego, dostosowanego modelu. Ta właściwość jest wypełniana tylko dla pomyślnie ukończonych przebiegów dostosowywania. Użyj tego identyfikatora, aby utworzyć wdrożenie na potrzeby wnioskowania.
hyperparams	HyperParameters	Hiperparametry Ustawienia parametrów hyper używane w zadaniu dostrajania.
id	string	Tożsamość tego elementu.
model	string minLength: 1	Identyfikator (model-id) modelu podstawowego używanego do dostosowania.
object	TypeDiscriminator	TypeDiscriminator Definiuje typ obiektu.
organisation_id	string	Identyfikator organizacji tej dobrze dostrojonej pracy. Nieużywane w usłudze Azure OpenAI; zgodność tylko z funkcją OpenAI.
result_files	File[]	Tożsamości plików wynikowych (file-id) zawierające metryki trenowania i oceny w formacie csv. Plik jest dostępny tylko dla pomyślnie ukończonych przebiegów dostosowywania.
status	State	Stan Stan zadania lub elementu.
suffix	string	Sufiks używany do identyfikowania dostosowanego modelu.
training_files	File[]	Tożsamości plików (identyfikator pliku), które są używane do trenowania dostosowanego modelu.
updated_at	integer (unixtime)	Sygnatura czasowa ostatniej modyfikacji tego zadania lub elementu (w epokach unix).
user_id	string	Identyfikator użytkownika tego zadania dostrajania. Nieużywane w usłudze Azure OpenAI; zgodność tylko z funkcją OpenAI.
validation_files	File[]	Tożsamości plików (identyfikator pliku), które są używane do oceny dobrze dostosowanego modelu podczas trenowania.

FineTuneCreation

Sprzeciwiać się

FineTuneCreation

Nazwa	Typ	Opis
batch_size	integer (int32)	Rozmiar partii do użycia do trenowania. Rozmiar partii to liczba przykładów trenowania używanych do trenowania pojedynczego przebiegu do przodu i do tyłu. Ogólnie rzecz biorąc, odkryliśmy, że większe rozmiary partii zwykle działają lepiej w przypadku większych zestawów danych. Wartość domyślna, a także maksymalna wartość tej właściwości są specyficzne dla modelu podstawowego.
classification_betas	number[] (double)	Wartości beta klasyfikacji. Jeśli zostanie to podane, obliczymy wyniki F-beta na określonych wartościach beta. Wynik F-beta jest uogólnienie wyniku F-1. Jest to używane tylko do klasyfikacji binarnej. Z beta 1 (tj. wynik F-1), precyzja i kompletność mają taką samą wagę. Większy wynik beta stawia większą wagę na kompletność i mniej na precyzję. Mniejszy wynik beta stawia większą wagę na precyzję i mniej na kompletność.
classification_n_classes	integer (int32)	Liczba klas w zadaniu klasyfikacji. Ten parametr jest wymagany do klasyfikacji wieloklasowej.
classification_positive_class	string	Dodatnia klasa w klasyfikacji binarnej. Ten parametr jest potrzebny do generowania dokładności, kompletności i F1 metryk podczas klasyfikacji binarnej.
compute_classification_metrics	boolean	Wartość wskazująca, czy metryki klasyfikacji obliczeniowej. W przypadku ustawienia obliczamy metryki specyficzne dla klasyfikacji, takie jak dokładność i wynik F-1, przy użyciu zestawu weryfikacji ustawionego na końcu każdej epoki. Te metryki można wyświetlić w pliku wyników. Aby obliczyć metryki klasyfikacji, należy podać validation_file. Ponadto należy określić classification_n_classes dla klasyfikacji wieloklasowej lub classification_positive_class klasyfikacji binarnej.
learning_rate_multiplier	number (double)	Mnożnik szybkości nauki używany do trenowania. Współczynnik dostrajania uczenia to oryginalny współczynnik uczenia używany do wstępnego trenowania pomnożonego przez tę wartość. Większe wskaźniki uczenia się mają tendencję do lepszej pracy z większymi rozmiarami partii. Zalecamy eksperymentowanie z wartościami z zakresu od 0,02 do 0,2, aby zobaczyć, co daje najlepsze wyniki.
model	string minLength: 1	Identyfikator (model-id) modelu podstawowego używanego na potrzeby tej precyzyjnej melodii.
n_epochs	integer (int32)	Liczba epok trenowania modelu dla. Epoka odnosi się do jednego pełnego cyklu za pośrednictwem zestawu danych trenowania.
prompt_loss_weight	number (double)	Waga do użycia do utraty na tokenach monitu. Określa to, ile model próbuje nauczyć się wygenerować monit (w porównaniu z ukończeniem, które zawsze ma wagę 1,0) i może dodać stabilizujący efekt do trenowania, gdy ukończenie jest krótkie. Jeśli monity są bardzo długie (w stosunku do ukończenia), warto zmniejszyć tę wagę, aby uniknąć nadmiernego określania priorytetów uczenia się monitu.
suffix	string	Sufiks używany do identyfikowania dostosowanego modelu. Sufiks może zawierać maksymalnie 40 znaków (a-z, A-Z, 0-9 i _), które zostaną dodane do nazwy dostosowanego modelu.
training_file	string minLength: 1	Tożsamość pliku (identyfikator pliku), która jest używana do trenowania tego dobrze dostosowanego modelu.
validation_file	string	Tożsamość pliku (identyfikator pliku), która jest używana do oceny dobrze dostosowanego modelu podczas trenowania.

HyperParameters

Sprzeciwiać się

Hiperparametry

Nazwa	Typ	Opis
batch_size	integer (int32)	Rozmiar partii do użycia do trenowania. Rozmiar partii to liczba przykładów trenowania używanych do trenowania pojedynczego przebiegu do przodu i do tyłu. Ogólnie rzecz biorąc, odkryliśmy, że większe rozmiary partii zwykle działają lepiej w przypadku większych zestawów danych. Wartość domyślna, a także maksymalna wartość tej właściwości są specyficzne dla modelu podstawowego.
classification_betas	number[] (double)	Wartości beta klasyfikacji. Jeśli zostanie to podane, obliczymy wyniki F-beta na określonych wartościach beta. Wynik F-beta jest uogólnienie wyniku F-1. Jest to używane tylko do klasyfikacji binarnej. Z beta 1 (tj. wynik F-1), precyzja i kompletność mają taką samą wagę. Większy wynik beta stawia większą wagę na kompletność i mniej na precyzję. Mniejszy wynik beta stawia większą wagę na precyzję i mniej na kompletność.
classification_n_classes	integer (int32)	Liczba klas w zadaniu klasyfikacji. Ten parametr jest wymagany do klasyfikacji wieloklasowej.
classification_positive_class	string	Dodatnia klasa w klasyfikacji binarnej. Ten parametr jest potrzebny do generowania dokładności, kompletności i F1 metryk podczas klasyfikacji binarnej.
compute_classification_metrics	boolean	Wartość wskazująca, czy metryki klasyfikacji obliczeniowej. W przypadku ustawienia obliczamy metryki specyficzne dla klasyfikacji, takie jak dokładność i wynik F-1, przy użyciu zestawu weryfikacji ustawionego na końcu każdej epoki. Te metryki można wyświetlić w pliku wyników. Aby obliczyć metryki klasyfikacji, należy podać validation_file. Ponadto należy określić classification_n_classes dla klasyfikacji wieloklasowej lub classification_positive_class klasyfikacji binarnej.
learning_rate_multiplier	number (double)	Mnożnik szybkości nauki używany do trenowania. Współczynnik dostrajania uczenia to oryginalny współczynnik uczenia używany do wstępnego trenowania pomnożonego przez tę wartość. Większe wskaźniki uczenia się mają tendencję do lepszej pracy z większymi rozmiarami partii. Zalecamy eksperymentowanie z wartościami z zakresu od 0,02 do 0,2, aby zobaczyć, co daje najlepsze wyniki.
n_epochs	integer (int32)	Liczba epok trenowania modelu dla. Epoka odnosi się do jednego pełnego cyklu za pośrednictwem zestawu danych trenowania.
prompt_loss_weight	number (double)	Waga do użycia do utraty na tokenach monitu. Określa to, ile model próbuje nauczyć się wygenerować monit (w porównaniu z ukończeniem, które zawsze ma wagę 1,0) i może dodać stabilizujący efekt do trenowania, gdy ukończenie jest krótkie. Jeśli monity są bardzo długie (w stosunku do ukończenia), warto zmniejszyć tę wagę, aby uniknąć nadmiernego określania priorytetów uczenia się monitu.

InnerError

Sprzeciwiać się

InnerError

Nazwa	Typ	Opis
code	InnerErrorCode	InnerErrorCode Wewnętrzne kody błędów zdefiniowane w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Błąd wewnętrzny zdefiniowany w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Wyliczenie

InnerErrorCode

Wartość	Opis
invalidPayload	Dane żądania są nieprawidłowe dla tej operacji.

LogLevel

Wyliczenie

LogLevel

Wartość	Opis
info	To zdarzenie dotyczy tylko informacji.
warning	To zdarzenie reprezentuje rozwiązany problem.
error	Ten komunikat reprezentuje niemożliwy do odzyskania problem.

Purpose

Wyliczenie

Cel

Wartość	Opis
fine-tune	Ten plik zawiera dane szkoleniowe dla zadania dostrajania.
fine-tune-results	Ten plik zawiera wyniki zadania dostrajania.

State

Wyliczenie

Stan

Wartość	Opis
notRunning	Operacja została utworzona i nie zostanie utworzona w kolejce do przetworzenia w przyszłości.
running	Operacja została rozpoczęta do przetworzenia.
succeeded	Operacja została pomyślnie przetworzona i jest gotowa do użycia.
canceled	Operacja została anulowana i jest niekompletna.
failed	Operacja zakończyła przetwarzanie z powodu błędu i nie może być jeszcze bardziej zużywana.
deleted	Jednostka została usunięta, ale nadal może być przywoływała inne jednostki poprzedzające usunięcie.

TypeDiscriminator

Wyliczenie

TypeDiscriminator

Wartość	Opis
list	Ten obiekt reprezentuje listę innych obiektów.
fine-tune	Ten obiekt reprezentuje zadanie dostrajania.
file	Ten obiekt reprezentuje plik.
fine-tune-event	Ten obiekt reprezentuje zdarzenie zadania dostrajania.
model	Ten obiekt reprezentuje model (może być modelem bazowym lub dostrajać wynik zadania).

Udostępnij za pośrednictwem

Fine Tunes - Create

Parametry URI

Nagłówek żądania

Ciało żądania

Odpowiedzi

Zabezpieczenia

api-key

Przykłady

Creating a fine tune job for classification.

Przykładowa prośba

Przykładowa odpowiedź

Creating a fine tune job.

Przykładowa prośba

Przykładowa odpowiedź

Definicje

Error

ErrorCode

ErrorResponse

Event

File

FileStatistics

FineTune

FineTuneCreation

HyperParameters

InnerError

InnerErrorCode

LogLevel

Purpose

State

TypeDiscriminator