Saltar al contenido principal
Capítulos de la guía de entrenamiento Toda la documentación

CLI de entrenamiento: comandos y opciones

La línea de comandos de SDK 0.2.0, desde la configuración del proyecto hasta la recuperación, evaluación, exportación y códigos de salida con significado.

Capítulos de la guía de entrenamiento

Los comandos y el código se mantienen en inglés en todos los idiomas. Sustituye los marcadores en mayúsculas por valores de tu cuenta y de tu tarea de pago; no pegues claves reales en cuadernos ni registros compartidos.

Flujo de trabajo de la línea de comandos

Cada comando tiene un efecto concreto y un resultado significativo.
  1. init / doctor Crear y comprobar el proyecto
  2. plan Revisar sin entrenar
  3. run Entrenar dentro del presupuesto
  4. evaluate Comprobar criterios reservados
  5. export Validar y empaquetar

Seguir una secuencia clara de comandos

SDK 0.2.0 incluye el ejecutable fpai-training. La secuencia usa el mismo contrato de proyecto que la interfaz Python: inicializar, comprobar compatibilidad, revisar el plan de prueba, ejecutar, evaluar y exportar. Consultar el estado o un plan no demuestra que el entrenamiento haya tenido éxito.

  • La autenticación se lee desde FUSIONPOINTAI_API_KEY. La clave no se pasa como argumento y no queda expuesta en la lista de procesos.
  • Usa --help en el ejecutable o en un comando. --version muestra la versión instalada del paquete.
  • El plan revisado fija los ajustes resueltos; la CLI no admite cambios ocultos de hiperparámetros.
Referencia completa de comandos CLI
Campo o interfazTipo o resultadoValor predeterminado o código de salidaComportamiento y validación
init --directory PATH command Obligatorio / sin valor predeterminado Crea la estructura de un proyecto nuevo y una configuración de ejemplo; rechaza un directorio existente que no esté vacío. No entrena ni realiza llamadas de pago.
doctor --config PATH command Obligatorio / sin valor predeterminado Comprueba el esquema, los archivos locales del modelo, las dependencias, el almacenamiento, los dispositivos y la compatibilidad del adaptador. No actualiza pesos ni genera contenido con el docente.
plan --config PATH --dry-run command Obligatorio / sin valor predeterminado Resuelve valores predeterminados, fija huellas y muestra temas, uso compartido, presupuestos y resultados. No optimiza ni realiza trabajo de pago con el docente.
run --config PATH command Obligatorio / sin valor predeterminado Exige un plan válido y revisado, así como permisos activos; bloquea una ejecución y realiza entrenamiento real dentro de los presupuestos.
status --run PATH command Obligatorio / sin valor predeterminado Lee la instantánea local depurada de la ejecución. No reinicia procesos ni genera solicitudes al docente.
pause --run PATH command Obligatorio / sin valor predeterminado Solicita una pausa segura y espera a que se complete un punto de control atómico. Solo es válido para una ejecución activa propia.
resume --run PATH command Obligatorio / sin valor predeterminado Reanuda una ejecución pausada o interrumpida recuperable solo después de validar estrictamente el punto de control y el plan.
cancel --run PATH command Obligatorio / sin valor predeterminado Detiene los procesos propios, libera sus recursos y registra la cancelación; conserva los resultados válidos y los diagnósticos.
evaluate --run PATH --split test command Obligatorio / sin valor predeterminado Evalúa el modelo fijado con datos de validación o prueba. No optimiza ni comparte datos reservados.
export --run PATH --format safetensors command Obligatorio / sin valor predeterminado Valida y empaqueta un resultado compatible y aceptado; no lo sube a servicios externos ni lo despliega en producción.
Ejemplo · bash 
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.

Pausar, reanudar o cancelar de forma segura

Los comandos de control se dirigen a un único directorio de ejecución propio. La pausa espera a que se guarde un punto de control atómico y a que el proceso de trabajo confirme la operación. La reanudación valida el mismo modelo, los datos, la configuración, el evaluador y la topología distribuida. La cancelación detiene únicamente los procesos de esa ejecución y registra una cancelación definitiva. Repetir una solicitud de control no debe iniciar otro proceso de entrenamiento.

  • Una ejecución pausada se puede recuperar, pero no está completada. Una ejecución cancelada no es un entregable aceptado.
  • Usa otro terminal para controlar una ejecución en primer plano.
  • Tras un tiempo de espera agotado, consulta el estado antes de volver a intentarlo. No borres archivos de bloqueo ni finalices trabajos GPU ajenos.
Opciones de comandos
Campo o interfazTipo o resultadoValor predeterminado o código de salidaComportamiento y validación
--directory path Obligatorio / sin valor predeterminado Obligatorio para init. Directorio nuevo del proyecto con permisos de escritura.
--config path Obligatorio / sin valor predeterminado Obligatorio para doctor, plan y run. Ruta a un archivo completo del esquema 1.0.
--run path Obligatorio / sin valor predeterminado Obligatorio para status, pause, resume, cancel, evaluate y export. Directorio de ejecución propio, no un ID de cuenta o sesión.
--dry-run flag true Opción explícita del plan; plan siempre es de solo lectura respecto a los pesos y al trabajo de pago. No existe un modo de ejecución false/off.
--split enum "test" Solo para evaluate: validation o test. Los datos de prueba nunca se usan para mejorar el modelo.
--format enum "safetensors" Solo para export: safetensors o adapters, según las capacidades del adaptador.
--help flag false Muestra la ayuda del ejecutable o del comando sin acceder al proveedor.
--version flag false Muestra los metadatos reales de la versión instalada, no la versión del esquema de configuración.
Ejemplo · bash 
# 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.

Interpretar conjuntamente el estado y los códigos de salida

El código de salida cero significa que la operación solicitada se completó correctamente; leer el estado, pausar o hacer una simulación correctamente no equivale a un entrenamiento aceptado. El resultado del entrenamiento también necesita un estado completado, un motivo de parada aceptado y todos los criterios de evaluación obligatorios. Los objetivos fallidos siguen apareciendo como tales en los informes, sin etiquetarlos como éxitos.

  • Los comandos escriben JSON legible por máquinas en stdout y diagnósticos depurados en stderr. Ningún flujo contiene secretos.
  • run y resume esperan a un estado final o pausado; status devuelve la instantánea actual.
  • SIGINT termina con el código 130 tras intentar limpiar los procesos propios. Un proceso interrumpido no puede inventar un punto de control completado.
Ejemplo · text 
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.