Fine Tunes - Create

Service:: Azure AI Services

API-versie:: 2023-05-15

Hiermee maakt u een taak waarmee een opgegeven model wordt aangepast op basis van een bepaald trainingsbestand. Het antwoord bevat details van de enqueued-taak, inclusief taakstatus en hyperparameters. De naam van het nauwkeurig afgestemde model wordt toegevoegd aan het antwoord zodra het is voltooid.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (url)	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-account).
api-version	query	True	string	De aangevraagde API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
api-key	True	string	Geef hier uw Azure OpenAI-accountsleutel voor Cognitive Services op.

Aanvraagbody

Name	Vereist	Type	Description
model	True	string minLength: 1	De id (model-id) van het basismodel dat voor deze verfijning wordt gebruikt.
training_file	True	string minLength: 1	De bestandsidentiteit (file-id) die wordt gebruikt voor het trainen van dit nauwkeurig afgestemde model.
batch_size		integer (int32)	De batchgrootte die moet worden gebruikt voor training. De batchgrootte is het aantal trainingsvoorbeelden dat wordt gebruikt voor het trainen van één vooruit- en achterwaartse pass. Over het algemeen hebben we vastgesteld dat grotere batchgrootten meestal beter werken voor grotere gegevenssets. De standaardwaarde en de maximumwaarde voor deze eigenschap zijn specifiek voor een basismodel.
classification_betas		number[] (double)	De bètawaarden voor classificatie. Als dit wordt opgegeven, berekenen we F-beta-scores bij de opgegeven bètawaarden. De F-beta-score is een generalisatie van F-1 score. Dit wordt alleen gebruikt voor binaire classificatie. Met een bèta van 1 (de F-1 score) krijgen precisie en relevante overeenkomsten hetzelfde gewicht. Een grotere bètascore brengt meer gewicht in op relevante overeenkomsten en minder op precisie. Een kleinere bètascore brengt meer gewicht in op precisie en minder op relevante overeenkomsten.
classification_n_classes		integer (int32)	Het aantal klassen in een classificatietaak. Deze parameter is vereist voor classificatie met meerdere klassen.
classification_positive_class		string	De positieve klasse in binaire classificatie. Deze parameter is nodig om metrische gegevens voor precisie, relevante overeenkomsten en F1 te genereren bij het uitvoeren van binaire classificatie.
compute_classification_metrics		boolean	Een waarde die aangeeft of metrische gegevens voor classificatie moeten worden berekend. Indien ingesteld, berekenen we classificatiespecifieke metrische gegevens, zoals nauwkeurigheid en F-1-score, met behulp van de validatieset aan het einde van elk tijdvak. Deze metrische gegevens kunnen worden weergegeven in het resultatenbestand. Als u metrische gegevens voor classificatie wilt berekenen, moet u een validation_file opgeven. Daarnaast moet u classification_n_classes opgeven voor classificatie met meerdere klassen of classification_positive_class voor binaire classificatie.
learning_rate_multiplier		number (double)	De vermenigvuldiger met leersnelheid die moet worden gebruikt voor training. Het afstemmen van de leersnelheid is het oorspronkelijke leerpercentage dat wordt gebruikt voor pretraining vermenigvuldigd met deze waarde. Grotere leersnelheden presteren meestal beter met grotere batchgrootten. We raden u aan te experimenteren met waarden in het bereik 0,02 tot 0,2 om te zien wat de beste resultaten oplevert.
n_epochs		integer (int32)	Het aantal tijdvakken waarvoor het model moet worden getraind. Een tijdsperiode verwijst naar één volledige cyclus door de trainingsgegevensset.
prompt_loss_weight		number (double)	Het gewicht dat moet worden gebruikt voor verlies op de prompttokens. Dit bepaalt hoeveel het model probeert te leren om de prompt te genereren (vergeleken met de voltooiing die altijd een gewicht van 1,0 heeft) en kan een stabiliserend effect toevoegen aan de training wanneer voltooiingen kort zijn. Als prompts extreem lang zijn (ten opzichte van voltooiingen), kan het zinvol zijn om dit gewicht te verminderen om te voorkomen dat de prompt te veel prioriteit krijgt.
suffix		string	Het achtervoegsel dat wordt gebruikt om het nauwkeurig afgestemde model te identificeren. Het achtervoegsel mag maximaal 40 tekens (a-z, A-Z, 0-9 en _) bevatten die worden toegevoegd aan de naam van het aangepaste model.
validation_file		string	De bestandsidentiteit (file-id) die wordt gebruikt om het nauwkeurig afgestemde model tijdens de training te evalueren.

Antwoorden

Name	Type	Description
201 Created	FineTune	De fine tune is gemaakt. Kopteksten Location: string
Other Status Codes	ErrorResponse	Er is een fout opgetreden.

Name

Type

Description

201 Created

FineTune

De fine tune is gemaakt.

Kopteksten

Location: string

Other Status Codes

ErrorResponse

Er is een fout opgetreden.

Beveiliging

api-key

Geef hier uw Azure OpenAI-accountsleutel voor Cognitive Services op.

Type: apiKey
In: header

Voorbeelden

Creating a fine tune job for classification.

Creating a fine tune job.

Creating a fine tune job for classification.

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 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.

Voorbeeldaanvraag

HTTP

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


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

Voorbeeldrespons

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

Definities

Name	Description
Error	Fout
ErrorCode	Foutcode
ErrorResponse	ErrorResponse
Event	Gebeurtenis
File	Bestand
FileStatistics	FileStatistics
FineTune	FineTune
FineTuneCreation	FineTuneCreation
HyperParameters	HyperParameters
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LogLevel	LogLevel
Purpose	Doel
State	Staat
TypeDiscriminator	TypeDiscriminator

Error

Object

Fout

Name	Type	Description
code	ErrorCode	Foutcode Foutcodes zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	De foutdetails indien beschikbaar.
innererror	InnerError	InnerError Interne fout zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string minLength: 1	Het bericht van deze fout.
target	string	De locatie waar de fout is opgetreden, indien beschikbaar.

ErrorCode

Opsomming

Foutcode

Waarde	Description
conflict	De aangevraagde bewerking conflicteert met de huidige resourcestatus.
invalidPayload	De aanvraaggegevens zijn ongeldig voor deze bewerking.
forbidden	De bewerking is verboden voor de huidige gebruiker/API-sleutel.
notFound	De resource is niet gevonden.
unexpectedEntityState	De bewerking kan niet worden uitgevoerd in de status van de huidige resource.
itemDoesAlreadyExist	Het item bestaat al.
serviceUnavailable	De service is momenteel niet beschikbaar.
internalFailure	Interne fout. Probeer het opnieuw.
quotaExceeded	Het quotum is overschreden.
jsonlValidationFailed	Validatie van jsonl-gegevens is mislukt.
fileImportFailed	Importeren van bestand is mislukt.

ErrorResponse

Object

ErrorResponse

Name	Type	Description
error	Error	Fout Foutinhoud zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

Event

Object

Gebeurtenis

Name	Type	Description
created_at	integer (unixtime)	Een tijdstempel waarin deze gebeurtenis is gemaakt (in unix-epochs).
level	LogLevel	LogLevel Het uitgebreidheidsniveau van een gebeurtenis.
message	string minLength: 1	Het bericht waarin de gebeurtenis wordt beschreven. Dit kan een wijziging van de status zijn, bijvoorbeeld enqueued, gestart, mislukt of voltooid of andere gebeurtenissen, zoals geüploade resultaten.
object	TypeDiscriminator	TypeDiscriminator Hiermee definieert u het type van een object.

File

Object

Bestand

Name	Type	Description
bytes	integer (int64)	De grootte van dit bestand indien beschikbaar (kan null zijn). Bestandsgrootten groter dan 2^53-1 worden niet ondersteund om compatibiliteit met JavaScript-gehele getallen te garanderen.
created_at	integer (unixtime)	Een tijdstempel waarin deze taak of dit item is gemaakt (in unix-epochs).
error	Error	Fout Foutinhoud zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
filename	string minLength: 1	De naam van het bestand.
id	string	De identiteit van dit item.
object	TypeDiscriminator	TypeDiscriminator Hiermee definieert u het type van een object.
purpose	Purpose	Doel Het beoogde doel van de geüploade documenten. Gebruik 'fine-tune' om af te stemmen. Hierdoor kunnen we de indeling van het geüploade bestand valideren.
statistics	FileStatistics	FileStatistics Een bestand is een document dat kan worden gebruikt voor training en validatie. Het kan ook een servicedocument met resultaatdetails zijn.
status	State	Staat De status van een taak of item.
updated_at	integer (unixtime)	Een tijdstempel waarin deze taak of dit item voor het laatst is gewijzigd (in unix-epochs).

FileStatistics

Object

FileStatistics

Name	Type	Description
examples	integer (int32)	Het aantal ingesloten trainingsvoorbeelden in bestanden van het type 'fine-tune' zodra de validatie van bestandsinhoud is voltooid.
tokens	integer (int32)	Het aantal tokens dat wordt gebruikt in prompts en voltooiingen voor bestanden van het type 'fine-tune' zodra de validatie van bestandsinhoud is voltooid.

FineTune

Object

FineTune

Name	Type	Description
created_at	integer (unixtime)	Een tijdstempel waarin deze taak of dit item is gemaakt (in unix-epochs).
error	Error	Fout Foutinhoud zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
events	Event[]	De gebeurtenissen die de voortgang van de uitvoering weergeven, inclusief in de wachtrij geplaatst, uitgevoerd en voltooid.
fine_tuned_model	string	De id (model-id) van het resulterende, nauwkeurig afgestemde model. Deze eigenschap is alleen ingevuld voor voltooide uitvoeringen. Gebruik deze id om een implementatie te maken voor deductie.
hyperparams	HyperParameters	HyperParameters De hyperparameterinstellingen die worden gebruikt in een taak voor nauwkeurig afstemmen.
id	string	De identiteit van dit item.
model	string minLength: 1	De id (model-id) van het basismodel dat wordt gebruikt voor het verfijnen.
object	TypeDiscriminator	TypeDiscriminator Hiermee definieert u het type van een object.
organisation_id	string	De organisatie-id van deze taak. Ongebruikt in Azure OpenAI; alleen compatibiliteit voor OpenAI.
result_files	File[]	De resultaatbestandsidentiteiten (file-id) met metrische gegevens voor training en evaluatie in CSV-indeling. Het bestand is alleen beschikbaar voor voltooide uitvoeringen.
status	State	Staat De status van een taak of item.
suffix	string	Het achtervoegsel dat wordt gebruikt om het nauwkeurig afgestemde model te identificeren.
training_files	File[]	De bestandsidentiteiten (file-id) die worden gebruikt voor het trainen van het nauwkeurig afgestemde model.
updated_at	integer (unixtime)	Een tijdstempel waarin deze taak of dit item voor het laatst is gewijzigd (in unix-epochs).
user_id	string	De gebruikers-id van deze taak voor het afstemmen. Ongebruikt in Azure OpenAI; alleen compatibiliteit voor OpenAI.
validation_files	File[]	De bestandsidentiteiten (file-id) die worden gebruikt om het nauwkeurig afgestemde model tijdens de training te evalueren.

FineTuneCreation

Object

FineTuneCreation

Name	Type	Description
batch_size	integer (int32)	De batchgrootte die moet worden gebruikt voor training. De batchgrootte is het aantal trainingsvoorbeelden dat wordt gebruikt voor het trainen van één vooruit- en achterwaartse pass. Over het algemeen hebben we vastgesteld dat grotere batchgrootten meestal beter werken voor grotere gegevenssets. De standaardwaarde en de maximumwaarde voor deze eigenschap zijn specifiek voor een basismodel.
classification_betas	number[] (double)	De bètawaarden voor classificatie. Als dit wordt opgegeven, berekenen we F-beta-scores bij de opgegeven bètawaarden. De F-beta-score is een generalisatie van F-1 score. Dit wordt alleen gebruikt voor binaire classificatie. Met een bèta van 1 (de F-1 score) krijgen precisie en relevante overeenkomsten hetzelfde gewicht. Een grotere bètascore brengt meer gewicht in op relevante overeenkomsten en minder op precisie. Een kleinere bètascore brengt meer gewicht in op precisie en minder op relevante overeenkomsten.
classification_n_classes	integer (int32)	Het aantal klassen in een classificatietaak. Deze parameter is vereist voor classificatie met meerdere klassen.
classification_positive_class	string	De positieve klasse in binaire classificatie. Deze parameter is nodig om metrische gegevens voor precisie, relevante overeenkomsten en F1 te genereren bij het uitvoeren van binaire classificatie.
compute_classification_metrics	boolean	Een waarde die aangeeft of metrische gegevens voor classificatie moeten worden berekend. Indien ingesteld, berekenen we classificatiespecifieke metrische gegevens, zoals nauwkeurigheid en F-1-score, met behulp van de validatieset aan het einde van elk tijdvak. Deze metrische gegevens kunnen worden weergegeven in het resultatenbestand. Als u metrische gegevens voor classificatie wilt berekenen, moet u een validation_file opgeven. Daarnaast moet u classification_n_classes opgeven voor classificatie met meerdere klassen of classification_positive_class voor binaire classificatie.
learning_rate_multiplier	number (double)	De vermenigvuldiger met leersnelheid die moet worden gebruikt voor training. Het afstemmen van de leersnelheid is het oorspronkelijke leerpercentage dat wordt gebruikt voor pretraining vermenigvuldigd met deze waarde. Grotere leersnelheden presteren meestal beter met grotere batchgrootten. We raden u aan te experimenteren met waarden in het bereik 0,02 tot 0,2 om te zien wat de beste resultaten oplevert.
model	string minLength: 1	De id (model-id) van het basismodel dat voor deze verfijning wordt gebruikt.
n_epochs	integer (int32)	Het aantal tijdvakken waarvoor het model moet worden getraind. Een tijdsperiode verwijst naar één volledige cyclus door de trainingsgegevensset.
prompt_loss_weight	number (double)	Het gewicht dat moet worden gebruikt voor verlies op de prompttokens. Dit bepaalt hoeveel het model probeert te leren om de prompt te genereren (vergeleken met de voltooiing die altijd een gewicht van 1,0 heeft) en kan een stabiliserend effect toevoegen aan de training wanneer voltooiingen kort zijn. Als prompts extreem lang zijn (ten opzichte van voltooiingen), kan het zinvol zijn om dit gewicht te verminderen om te voorkomen dat de prompt te veel prioriteit krijgt.
suffix	string	Het achtervoegsel dat wordt gebruikt om het nauwkeurig afgestemde model te identificeren. Het achtervoegsel mag maximaal 40 tekens (a-z, A-Z, 0-9 en _) bevatten die worden toegevoegd aan de naam van het aangepaste model.
training_file	string minLength: 1	De bestandsidentiteit (file-id) die wordt gebruikt voor het trainen van dit nauwkeurig afgestemde model.
validation_file	string	De bestandsidentiteit (file-id) die wordt gebruikt om het nauwkeurig afgestemde model tijdens de training te evalueren.

HyperParameters

Object

HyperParameters

Name	Type	Description
batch_size	integer (int32)	De batchgrootte die moet worden gebruikt voor training. De batchgrootte is het aantal trainingsvoorbeelden dat wordt gebruikt voor het trainen van één vooruit- en achterwaartse pass. Over het algemeen hebben we vastgesteld dat grotere batchgrootten meestal beter werken voor grotere gegevenssets. De standaardwaarde en de maximumwaarde voor deze eigenschap zijn specifiek voor een basismodel.
classification_betas	number[] (double)	De bètawaarden voor classificatie. Als dit wordt opgegeven, berekenen we F-beta-scores bij de opgegeven bètawaarden. De F-beta-score is een generalisatie van F-1 score. Dit wordt alleen gebruikt voor binaire classificatie. Met een bèta van 1 (de F-1 score) krijgen precisie en relevante overeenkomsten hetzelfde gewicht. Een grotere bètascore brengt meer gewicht in op relevante overeenkomsten en minder op precisie. Een kleinere bètascore brengt meer gewicht in op precisie en minder op relevante overeenkomsten.
classification_n_classes	integer (int32)	Het aantal klassen in een classificatietaak. Deze parameter is vereist voor classificatie met meerdere klassen.
classification_positive_class	string	De positieve klasse in binaire classificatie. Deze parameter is nodig om metrische gegevens voor precisie, relevante overeenkomsten en F1 te genereren bij het uitvoeren van binaire classificatie.
compute_classification_metrics	boolean	Een waarde die aangeeft of metrische gegevens voor classificatie moeten worden berekend. Indien ingesteld, berekenen we classificatiespecifieke metrische gegevens, zoals nauwkeurigheid en F-1-score, met behulp van de validatieset aan het einde van elk tijdvak. Deze metrische gegevens kunnen worden weergegeven in het resultatenbestand. Als u metrische gegevens voor classificatie wilt berekenen, moet u een validation_file opgeven. Daarnaast moet u classification_n_classes opgeven voor classificatie met meerdere klassen of classification_positive_class voor binaire classificatie.
learning_rate_multiplier	number (double)	De vermenigvuldiger met leersnelheid die moet worden gebruikt voor training. Het afstemmen van de leersnelheid is het oorspronkelijke leerpercentage dat wordt gebruikt voor pretraining vermenigvuldigd met deze waarde. Grotere leersnelheden presteren meestal beter met grotere batchgrootten. We raden u aan te experimenteren met waarden in het bereik 0,02 tot 0,2 om te zien wat de beste resultaten oplevert.
n_epochs	integer (int32)	Het aantal tijdvakken waarvoor het model moet worden getraind. Een tijdsperiode verwijst naar één volledige cyclus door de trainingsgegevensset.
prompt_loss_weight	number (double)	Het gewicht dat moet worden gebruikt voor verlies op de prompttokens. Dit bepaalt hoeveel het model probeert te leren om de prompt te genereren (vergeleken met de voltooiing die altijd een gewicht van 1,0 heeft) en kan een stabiliserend effect toevoegen aan de training wanneer voltooiingen kort zijn. Als prompts extreem lang zijn (ten opzichte van voltooiingen), kan het zinvol zijn om dit gewicht te verminderen om te voorkomen dat de prompt te veel prioriteit krijgt.

InnerError

Object

InnerError

Name	Type	Description
code	InnerErrorCode	InnerErrorCode Interne foutcodes zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Interne fout zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Opsomming

InnerErrorCode

Waarde	Description
invalidPayload	De aanvraaggegevens zijn ongeldig voor deze bewerking.

LogLevel

Opsomming

LogLevel

Waarde	Description
info	Deze gebeurtenis is alleen bedoeld voor informatie.
warning	Deze gebeurtenis vertegenwoordigt een beperkt probleem.
error	Dit bericht vertegenwoordigt een probleem dat niet kan worden hersteld.

Purpose

Opsomming

Doel

Waarde	Description
fine-tune	Dit bestand bevat trainingsgegevens voor een taak voor het verfijnen van de taak.
fine-tune-results	Dit bestand bevat de resultaten van een taak voor het afstemmen.

State

Opsomming

Staat

Waarde	Description
notRunning	De bewerking is gemaakt en wordt niet in de wachtrij geplaatst om in de toekomst te worden verwerkt.
running	De bewerking is gestart.
succeeded	De bewerking is verwerkt en is gereed voor gebruik.
canceled	De bewerking is geannuleerd en is onvolledig.
failed	De bewerking is voltooid met een fout en kan niet verder worden verbruikt.
deleted	De entiteit is verwijderd, maar kan nog steeds worden verwezen door andere entiteiten die de verwijdering voorafgaan.

TypeDiscriminator

Opsomming

TypeDiscriminator

Waarde	Description
list	Dit object vertegenwoordigt een lijst met andere objecten.
fine-tune	Dit object vertegenwoordigt een taak voor het afstemmen.
file	Dit object vertegenwoordigt een bestand.
fine-tune-event	Dit object vertegenwoordigt een gebeurtenis van een taak voor het afstemmen.
model	Dit object vertegenwoordigt een model (kan een basismodel zijn of taakresultaat verfijnen).