Les commandes et le code restent en anglais dans toutes les langues. Remplacez les espaces réservés en majuscules par les valeurs de votre compte et de votre tâche payante ; ne collez pas de vraies clés dans des carnets ou des journaux partagés.
Processus en ligne de commande
- init / doctor Créer et vérifier le projet
- plan Examiner sans entraîner
- run Entraîner dans les limites des budgets
- evaluate Vérifier les critères réservés
- export Valider et empaqueter
init / doctor: Créer et vérifier le projet. plan: Examiner sans entraîner. run: Entraîner dans les limites des budgets. evaluate: Vérifier les critères réservés. export: Valider et empaqueter
Suivre une séquence claire de commandes
SDK 0.2.0 fournit l’exécutable fpai-training. La séquence suit le même contrat de projet que l’interface Python : initialiser, vérifier la compatibilité, examiner le plan à blanc, exécuter, évaluer et exporter. Lire l’état ou un plan ne prouve pas que l’entraînement a réussi.
- L’authentification est lue dans FUSIONPOINTAI_API_KEY. La clé n’est pas transmise en argument de commande et n’apparaît donc pas dans la liste des processus.
- Utilisez --help sur l’exécutable ou une commande. --version indique la version du paquet installé.
- Le plan examiné fixe les paramètres résolus ; la CLI ne permet pas de remplacer des hyperparamètres en cachette.
| Champ ou interface | Type ou résultat | Valeur par défaut ou code de sortie | Comportement et validation |
|---|---|---|---|
init --directory PATH |
command |
Obligatoire / sans valeur par défaut | Crée l’ossature d’un nouveau projet et un exemple de configuration ; refuse tout répertoire non vide existant. Aucun entraînement ni appel payant. |
doctor --config PATH |
command |
Obligatoire / sans valeur par défaut | Vérifie le schéma, les fichiers locaux du modèle, les dépendances, le stockage, les périphériques et la compatibilité de l’adaptateur. Aucune mise à jour des poids ni génération par l’enseignant. |
plan --config PATH --dry-run |
command |
Obligatoire / sans valeur par défaut | Résout les valeurs par défaut, épingle les empreintes et affiche thèmes, partage, budgets et sorties. Aucune optimisation ni opération payante auprès de l’enseignant. |
run --config PATH |
command |
Obligatoire / sans valeur par défaut | Exige un plan valide examiné et un droit d’accès actif ; verrouille une exécution et exécute un entraînement réel dans les limites des budgets. |
status --run PATH |
command |
Obligatoire / sans valeur par défaut | Lit l’instantané local expurgé de l’exécution. Ne redémarre pas les processus et ne génère pas de requêtes à l’enseignant. |
pause --run PATH |
command |
Obligatoire / sans valeur par défaut | Demande une mise en pause sûre et attend un point de contrôle atomique complet. Valide uniquement pour une exécution active qui vous appartient. |
resume --run PATH |
command |
Obligatoire / sans valeur par défaut | Reprend une exécution récupérable, en pause ou interrompue, uniquement après validation stricte du point de contrôle et du plan. |
cancel --run PATH |
command |
Obligatoire / sans valeur par défaut | Arrête les processus de l’exécution, libère les ressources correspondantes et consigne l’annulation ; préserve les sorties valides et les diagnostics. |
evaluate --run PATH --split test |
command |
Obligatoire / sans valeur par défaut | Évalue le modèle épinglé sur les données de validation ou de test. Aucune optimisation ni aucun partage de données réservées. |
export --run PATH --format safetensors |
command |
Obligatoire / sans valeur par défaut | Valide et empaquette une sortie prise en charge et acceptée ; aucun téléversement externe ni déploiement en production. |
fpai-training --version
fpai-training --help
fpai-training init --directory ./german-project
# Replace training.json and rubric/data files with your reviewed configuration.
fpai-training doctor --config ./german-project/training.json
fpai-training plan --config ./german-project/training.json --dry-run
# Inspect resolved values, data sharing and budgets BEFORE the next command.
fpai-training run --config ./german-project/training.json
fpai-training status --run ./german-project/runs/german-001
fpai-training evaluate --run ./german-project/runs/german-001 --split test
fpai-training export --run ./german-project/runs/german-001 --format safetensors
# Supply the key through FUSIONPOINTAI_API_KEY, never a command-line argument.Mettre en pause, reprendre ou annuler en toute sécurité
Les commandes de contrôle ciblent un seul répertoire d’exécution appartenant au projet. La mise en pause attend un point de contrôle atomique et l’accusé de réception du processus de travail. La reprise valide le même modèle, les mêmes données, la même configuration, le même évaluateur et la même topologie distribuée. L’annulation arrête uniquement les processus de cette exécution et consigne une annulation définitive. Répéter une demande de contrôle ne doit pas lancer un autre processus d’entraînement.
- Une exécution en pause peut être repris ; il n’est pas terminé. Une exécution annulée n’est pas un livrable accepté.
- Utilisez un deuxième terminal pour les commandes de contrôle pendant qu’une exécution s’exécute au premier plan.
- Après un délai d’expiration, consultez l’état avant de réessayer. Ne supprimez pas les fichiers de verrouillage et n’arrêtez pas des tâches GPU sans rapport.
| Champ ou interface | Type ou résultat | Valeur par défaut ou code de sortie | Comportement et validation |
|---|---|---|---|
--directory |
path |
Obligatoire / sans valeur par défaut | Obligatoire pour init. Nouveau répertoire de projet accessible en écriture. |
--config |
path |
Obligatoire / sans valeur par défaut | Obligatoire pour doctor, plan et run. Chemin vers un fichier complet au schéma 1.0. |
--run |
path |
Obligatoire / sans valeur par défaut | Obligatoire pour status, pause, resume, cancel, evaluate et export. Répertoire d’exécution qui vous appartient, et non identifiant de compte ou de session. |
--dry-run |
flag |
true |
Option explicite du plan ; plan est toujours en lecture seule pour les poids et les opérations payantes. Il n’existe pas de mode d’exécution false/off. |
--split |
enum |
"test" |
Pour evaluate uniquement : validation ou test. Les données de test ne servent jamais aux améliorations. |
--format |
enum |
"safetensors" |
Pour export uniquement : safetensors ou adapters, selon les capacités de l’adaptateur. |
--help |
flag |
false |
Affiche l’aide de l’exécutable ou de la commande sans accéder au fournisseur. |
--version |
flag |
false |
Affiche les métadonnées de version réellement installées, et non la version du schéma de configuration. |
# Run controls from a separate terminal if training is active.
fpai-training pause --run ./german-project/runs/german-001
# Wait for status=paused and a completed atomic checkpoint before stopping a host.
fpai-training status --run ./german-project/runs/german-001
fpai-training resume --run ./german-project/runs/german-001
# Cancellation is terminal; preserve existing artifacts, do not pretend it passed.
fpai-training cancel --run ./german-project/runs/german-001
# Repeat status, not run(), after a timeout. Never kill an unrelated process.Interpréter ensemble l’état et les codes de sortie
Le code de sortie zéro signifie que l’opération demandée a réussi ; une lecture d’état, une pause ou un essai à blanc réussi ne constitue pas un entraînement accepté. Le résultat d’entraînement doit aussi présenter un état terminé, un motif d’arrêt accepté et satisfaire tous les critères d’évaluation obligatoires. Les échecs restent visibles dans les rapports au lieu d’être requalifiés en succès.
- Les commandes écrivent du JSON lisible par machine sur stdout et des diagnostics expurgés sur stderr. Aucun secret n’apparaît dans ces flux.
runetresumeattendent un état final ou une mise en pause ; status renvoie l’instantané actuel.- SIGINT se termine avec le code 130 après une tentative de nettoyage des processus appartenant à l’exécution. Un processus interrompu ne peut pas fabriquer un point de contrôle indiquant une exécution terminée.
SDK 0.2.0 EXIT AND STATE CONTRACT
0 accepted, successful read/control, or successful dry-run; inspect operation.
2 invalid configuration; no training started.
3 incompatible model/runtime/method/export combination.
4 authentication, entitlement or authorized-sharing failure.
5 resource budget exhausted; preserve latest valid checkpoint and report.
6 evaluation requirements not met; not an accepted model.
7 execution, checkpoint, cancellation-control or export failure.
130 interrupted by the caller.
Lifecycle:
planned -> preparing -> training -> evaluating -> completed
training -> pausing -> paused -> training (validated resume)
active -> cancelling -> cancelled
active -> failed
stop_reason: accepted | budget_exhausted | no_progress | regression |
cancelled | failed
paused is a recoverable state, not an accepted training result.
completed requires stop_reason=accepted and all required criteria passing.
Repeated control requests must read/reuse the owned transition, not spawn workers.
One run lock prevents duplicate execution of the same run directory.