API du registre de modèles

{{< details >}}

• Édition : Gratuite, GitLab Premium, GitLab Ultimate
• Offre : GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

Utilisez cette API pour interagir avec le registre de modèles de machine learning.

L'attribut :model_version_id dans chaque endpoint accepte soit un ID de version de modèle, soit un ID d'exécution de candidat. Pour plus d'informations, voir ID de version de modèle et de candidat.

Télécharger un fichier de package de modèle de machine learning {#download-a-machine-learning-model-package-file}

Télécharge un fichier spécifié depuis un package de modèle de machine learning.

GET /api/v4/projects/:id/packages/ml_models/:model_version_id/files/(*path/):file_name

Attributs pris en charge :

En cas de succès, renvoie 200 OK ainsi que le contenu du fichier.

Exemple de requête :

curl --header "Authorization: Bearer <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/packages/ml_models/2/files/foo.txt"

Exemple de requête avec un chemin de répertoire :

curl --header "Authorization: Bearer <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/packages/ml_models/2/files/my_dir/foo.txt"

Envoyer un fichier de package de modèle {#upload-a-model-package-file}

Envoie un fichier vers un package de modèle de machine learning.

Autoriser l'envoi {#authorize-the-upload}

Autorise l'envoi d'un fichier vers un package de modèle de machine learning.

PUT /api/v4/projects/:id/packages/ml_models/:model_version_id/files/(*path/):file_name/authorize

Attributs pris en charge :

En cas de succès, renvoie 200 OK.

Exemple de requête :

curl --request PUT \
  --header "Authorization: Bearer <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/packages/ml_models/2/files/model.pkl/authorize"

Envoyer le fichier {#send-the-file}

Envoie le fichier vers un package de modèle de machine learning.

PUT /api/v4/projects/:id/packages/ml_models/:model_version_id/files/(*path/):file_name

Attributs pris en charge :

En cas de succès, renvoie 201 Created.

Exemple de requête :

curl --request PUT \
  --header "Authorization: Bearer <your_access_token>" \
  --form "[email protected]" \
  --url "https://gitlab.example.com/api/v4/projects/1/packages/ml_models/2/files/model.pkl"

Exemple de requête avec un chemin de répertoire :

curl --request PUT \
  --header "Authorization: Bearer <your_access_token>" \
  --form "[email protected]" \
  --url "https://gitlab.example.com/api/v4/projects/1/packages/ml_models/2/files/my_dir/model.pkl"

ID de version de modèle et de candidat {#model-version-and-candidate-ids}

L'attribut :model_version_id accepte soit un ID de version de modèle, soit un ID d'exécution de candidat.

Pour trouver l'ID de version du modèle, vérifiez l'URL de la page de version du modèle. Par exemple, dans https://gitlab.example.com/my-namespace/my-project/-/ml/models/1/versions/5, l'ID de version du modèle est 5.

curl --header "Authorization: Bearer <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/packages/ml_models/5/files/model.pkl"

Pour utiliser un ID d'exécution de candidat, faites précéder l'ID interne du candidat de candidate:. Par exemple, dans https://gitlab.example.com/my-namespace/my-project/-/ml/candidates/5, la valeur pour :model_version_id est candidate:5.

curl --header "Authorization: Bearer <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/packages/ml_models/candidate:5/files/model.pkl"