Fine Tuning - Create

Référence

Service:: Azure AI Services

API Version:: 2023-12-01-preview

Crée un travail qui ajuste un modèle spécifié à partir d’un fichier d’entraînement donné. La réponse inclut les détails du travail en file d’attente, y compris les paramètres d’status et d’hyper du travail. Le nom du modèle affiné est ajouté à la réponse une fois terminé.

POST {endpoint}/openai/fine_tuning/jobs?api-version=2023-12-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string url	Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre compte Azure OpenAI).
api-version	query	True	string	Version de l’API demandée.

En-tête de la demande

Nom	Obligatoire	Type	Description
api-key	True	string	Fournissez la clé de votre compte Azure OpenAI Cognitive Services ici.

Corps de la demande

Nom	Obligatoire	Type	Description
model	True	string	Identificateur (model-id) du modèle de base utilisé pour cette optimisation.
training_file	True	string	Identité de fichier (file-id) utilisée pour l’apprentissage de ce modèle affiné.
hyperparameters		FineTuningHyperParameters	FineTuningHyperParameters Paramètres hyper utilisés dans un travail d’optimisation.
suffix		string	Suffixe utilisé pour identifier le modèle affiné. Le suffixe peut contenir jusqu’à 40 caractères (a-z, A-Z, 0-9 et _) qui seront ajoutés à votre nom de modèle affiné.
validation_file		string	Identité de fichier (file-id) utilisée pour évaluer le modèle affiné pendant l’entraînement.

Réponses

Nom	Type	Description
201 Created	FineTuningJob	Le réglage a été créé avec succès. Headers Location: string
Other Status Codes	ErrorResponse	Une erreur est survenue.

Nom

Type

Description

201 Created

FineTuningJob

Le réglage a été créé avec succès.

Headers

Location: string

Other Status Codes

ErrorResponse

Une erreur est survenue.

Sécurité

api-key

Fournissez la clé de votre compte Azure OpenAI Cognitive Services ici.

Type: apiKey
In: header

Exemples

Creating a fine tune job.

Sample Request

HTTP

POST https://aoairesource.openai.azure.com/openai/fine_tuning/jobs?api-version=2023-12-01-preview


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

Sample Response

Status code:: 201

location: https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f

Response Body

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

Définitions

Nom	Description
Error	Erreur
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningHyperParameters	FineTuningHyperParameters
FineTuningJob	FineTuningJob
FineTuningJobCreation	FineTuningJobCreation
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TypeDiscriminator

Error

Erreur

Nom	Type	Description
code	ErrorCode	ErrorCode Codes d’erreur tels que définis dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Les détails de l’erreur s’ils sont disponibles.
innererror	InnerError	InnerError Erreur interne telle que définie dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Message de cette erreur.
target	string	Emplacement où l’erreur s’est produite si disponible.

ErrorCode

Nom	Type	Description
conflict	string	L’opération demandée est en conflit avec l’état actuel de la ressource.
contentFilter	string	La génération d’images a échoué en raison de notre système de sécurité.
fileImportFailed	string	Échec de l’importation du fichier.
forbidden	string	L’opération est interdite pour l’utilisateur/la clé API actuelle.
internalFailure	string	Erreur interne. Veuillez réessayer.
invalidPayload	string	Les données de requête ne sont pas valides pour cette opération.
itemDoesAlreadyExist	string	L’élément existe déjà.
jsonlValidationFailed	string	Échec de la validation des données jsonl.
notFound	string	La ressource est introuvable.
quotaExceeded	string	Quota dépassé.
serviceUnavailable	string	Le service n’est actuellement pas disponible.
tooManyRequests	string	Trop grand nombre de requêtes. Veuillez réessayer ultérieurement.
unauthorized	string	L’utilisateur/clé api actuel n’est pas autorisé pour l’opération.
unexpectedEntityState	string	L’opération ne peut pas être exécutée dans l’état de la ressource actuelle.

ErrorResponse

Nom	Type	Description
error	Error	Erreur Contenu d’erreur tel que défini dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FineTuningHyperParameters

Nom	Type	Description
batch_size	integer	Taille de lot à utiliser pour la formation. La taille du lot est le nombre d’exemples de la formation utilisés pour entraîner un seul passage avant et arrière. En général, nous avons constaté que les tailles de lot plus grandes ont tendance à fonctionner mieux pour les jeux de données plus volumineux. La valeur par défaut ainsi que la valeur maximale de cette propriété sont spécifiques à un modèle de base.
learning_rate_multiplier	number	Multiplicateur de taux de formation à utiliser pour la formation. Le taux d’apprentissage de réglage est le taux d’apprentissage d’origine utilisé pour le pré-entraînement multiplié par cette valeur. Les taux d’apprentissage plus élevés ont tendance à mieux fonctionner avec des tailles de lots plus importantes. Nous vous recommandons d’expérimenter des valeurs comprises entre 0,02 et 0,2 pour voir ce qui produit les meilleurs résultats.
n_epochs	integer	Nombre d’époques pour lequel effectuer la formation du modèle. Une époque fait référence à un cycle complet dans le jeu de données de formation.

FineTuningJob

Nom	Type	Description
created_at	integer	Horodatage lorsque ce travail ou cet élément a été créé (dans les époques Unix).
fine_tuned_model	string	Identificateur (model-id) du modèle affiné résultant. Cette propriété est renseignée uniquement pour les exécutions d’optimisation réussies. Utilisez cet identificateur pour créer un déploiement pour l’inférence.
finished_at	integer	Horodatage lorsque ce travail ou cet élément s’est terminé avec succès (dans les époques Unix).
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters Paramètres hyper utilisés dans un travail d’optimisation.
id	string	Identité de cet élément.
model	string	Identificateur (model-id) du modèle de base utilisé pour le réglage.
object	TypeDiscriminator	TypeDiscriminator Définit le type d’un objet.
organisation_id	string	Id d’organisation de ce travail de réglage. Inutilisé sur Azure OpenAI ; compatibilité pour OpenAI uniquement.
result_files	string[]	Identités de fichier de résultat (file-id) contenant des métriques d’entraînement et d’évaluation au format csv. Le fichier n’est disponible que pour les exécutions d’optimisation réussies.
status	FineTuningState	FineTuningState État d’un objet affiné ou d’un travail de réglage.
suffix	string	Suffixe utilisé pour identifier le modèle affiné. Le suffixe peut contenir jusqu’à 40 caractères (a-z, A-Z, 0-9 et _) qui seront ajoutés à votre nom de modèle affiné.
trained_tokens	integer	Nombre total de jetons facturables traités par ce travail de réglage.
training_file	string	Fichier utilisé pour l’entraînement.
updated_at	integer	Horodatage lorsque ce travail ou cet élément a été modifié en dernier (dans les époques unix).
validation_file	string	Fichier utilisé pour évaluer le modèle affiné pendant l’entraînement.

FineTuningJobCreation

Nom	Type	Description
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters Paramètres hyper utilisés dans un travail d’optimisation.
model	string	Identificateur (model-id) du modèle de base utilisé pour cette optimisation.
suffix	string	Suffixe utilisé pour identifier le modèle affiné. Le suffixe peut contenir jusqu’à 40 caractères (a-z, A-Z, 0-9 et _) qui seront ajoutés à votre nom de modèle affiné.
training_file	string	Identité de fichier (file-id) utilisée pour l’apprentissage de ce modèle affiné.
validation_file	string	Identité de fichier (file-id) utilisée pour évaluer le modèle affiné pendant l’entraînement.

FineTuningState

Nom	Type	Description
cancelled	string	L’opération a été annulée et est incomplète. Il peut être classé comme état terminal.
created	string	L’opération a été créée. Cet état n’est pas retourné par Azure OpenAI et n’est exposé qu’à des fins de compatibilité. Il peut être classé comme un état inactif.
failed	string	L’opération a terminé le traitement avec un échec et ne peut pas être consommée davantage. Il peut être classé comme état terminal.
pending	string	L’opération n’est pas encore mise en file d’attente pour être traitée à l’avenir. Il peut être classé comme un état inactif.
running	string	L’opération a commencé à être traitée. Il peut être classé en tant qu’état actif.
succeeded	string	L’opération a été traitée avec succès et est prête à être consommée. Il peut être classé comme état terminal.

InnerError

Nom	Type	Description
code	InnerErrorCode	InnerErrorCode Codes d’erreur internes tels que définis dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Erreur interne telle que définie dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Nom	Type	Description
invalidPayload	string	Les données de requête ne sont pas valides pour cette opération.

TypeDiscriminator

Nom	Type	Description
file	string	Cet objet représente un fichier.
fine-tune	string	Cet objet représente un travail d’optimisation.
fine-tune-event	string	Cet objet représente un événement d’un travail de réglage.
fine_tuning.job	string	Cet objet représente un travail d’optimisation.
fine_tuning.job.event	string	Cet objet représente un événement d’un travail de réglage.
list	string	Cet objet représente une liste d’autres objets.
model	string	Cet objet représente un modèle (il peut s’agir d’un modèle de base ou d’un résultat de travail de réglage).

Fine Tuning - Create

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

api-key

Exemples

Creating a fine tune job.

Sample Request

Sample Response

Définitions

Error

ErrorCode

ErrorResponse

FineTuningHyperParameters

FineTuningJob

FineTuningJobCreation

FineTuningState

InnerError

InnerErrorCode

TypeDiscriminator

Ressources supplémentaires