Перейти к основному содержимому
Главы руководства по обучению Вся документация

CLI для обучения: команды и параметры

Полный рабочий процесс CLI: настройка проекта, запуск, оценка, экспорт и обработка ошибок.

Главы руководства по обучению

Команды и код во всех языковых версиях остаются на английском. Заменяйте ЗАГЛАВНЫЕ заполнители значениями своей учетной записи и оплаченного задания. Не вставляйте реальные ключи в общие ноутбуки или журналы.

Рабочий процесс командной строки

У каждой команды есть конкретный побочный эффект и значимый результат.
  1. init / doctor Создать и проверить проект
  2. plan Проверить без обучения
  3. run Обучать в пределах бюджетов
  4. evaluate Проверить отложенные критерии
  5. export Проверить и упаковать

Выполняйте команды в заданном порядке

Программа fpai-training использует тот же контракт проекта, что и интерфейс Python: инициализация, проверка совместимости, просмотр плана без запуска, выполнение, оценка и экспорт. Просмотр статуса или плана сам по себе не доказывает успешное обучение.

  • Для аутентификации используется FUSIONPOINTAI_API_KEY. У CLI нет параметра для передачи API-ключа.
  • Команда --help показывает справку по программе или подкоманде. --version выводит фактическую версию установленного пакета.
  • Проверенный план фиксирует настройки. Не документированные переопределения гиперпараметров через CLI не поддерживаются.
Полный справочник команд CLI
Поле или интерфейсТип или результатЗначение по умолчанию или код завершенияПоведение и проверка
init --directory PATH command Обязательное / без значения по умолчанию Создает новый каркас проекта и пример конфигурации; отказывает, если каталог существует и не пуст. Не запускает обучение и платные запросы.
doctor --config PATH command Обязательное / без значения по умолчанию Проверяет схему, локальные файлы модели, зависимости, хранилище, устройства и совместимость адаптера. Не меняет веса и не генерирует данные с помощью модели-учителя.
plan --config PATH --dry-run command Обязательное / без значения по умолчанию Подбирает значения по умолчанию, фиксирует fingerprints и показывает темы, передачу данных, бюджеты и результаты. Без оптимизации и платных запросов модели-учителю.
run --config PATH command Обязательное / без значения по умолчанию Требует проверенный допустимый план и действующее право доступа; блокирует один запуск и выполняет реальное обучение в пределах бюджетов.
status --run PATH command Обязательное / без значения по умолчанию Читает локальный снимок запуска без секретов. Не перезапускает worker-процессы и не отправляет запросы модели-учителю.
pause --run PATH command Обязательное / без значения по умолчанию Запрашивает безопасную приостановку и ожидает полную атомарную контрольную точку. Допустимо только для активного принадлежащего проекту запуска.
resume --run PATH command Обязательное / без значения по умолчанию Возобновляет приостановленный или прерванный запуск с допустимым состоянием восстановления только после строгой проверки контрольной точки и плана.
cancel --run PATH command Обязательное / без значения по умолчанию Останавливает принадлежащие запуску worker-процессы, освобождает его ресурсы и фиксирует отмену; сохраняет допустимые результаты и диагностику.
evaluate --run PATH --split test command Обязательное / без значения по умолчанию Оценивает зафиксированную модель по данным проверки или теста. Без оптимизации и передачи скрытых данных.
export --run PATH --format safetensors command Обязательное / без значения по умолчанию Проверяет и упаковывает принятый поддерживаемый результат; не загружает его наружу и не выполняет развертывание.
Пример · 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.

Безопасно приостанавливайте, возобновляйте или отменяйте запуск

Команды управления относятся к одному принадлежащему вам каталогу запуска. Приостановка дожидается атомарной контрольной точки и подтверждения worker-процесса. Перед возобновлением проверяются модель, данные, конфигурация, оценщик и распределенная топология. Отмена останавливает только worker-процессы этого запуска и фиксирует его конечный статус. Повторный запрос управления не должен создавать еще один процесс обучения.

  • Приостановленный запуск можно восстановить, но он не завершен. Отмененный запуск не является принятым результатом.
  • Пока запуск выполняется в переднем плане, отправляйте команды управления из другого терминала.
  • После тайм-аута сначала проверьте статус. Не удаляйте файлы блокировки и не завершайте посторонние процессы GPU.
Параметры команд
Поле или интерфейсТип или результатЗначение по умолчанию или код завершенияПоведение и проверка
--directory path Обязательное / без значения по умолчанию Обязательно для init. Новый доступный для записи каталог проекта.
--config path Обязательное / без значения по умолчанию Обязательно для doctor, plan и run. Путь к полному файлу схемы 1.0.
--run path Обязательное / без значения по умолчанию Обязательно для status, pause, resume, cancel, evaluate и export. Каталог принадлежащего проекту запуска, а не ID учетной записи или сеанса.
--dry-run flag true Явный параметр планирования; plan в любом случае не изменяет веса и не инициирует платные операции. Это не режим отключения выполнения.
--split enum "test" Только для evaluate: validation или test. Тестовые данные никогда не используются для улучшения.
--format enum "safetensors" Только для export: safetensors или adapters, в зависимости от возможностей адаптера.
--help flag false Показывает справку по программе или команде без обращения к провайдеру.
--version flag false Показывает фактические метаданные установленного выпуска, а не версию схемы конфигурации.
Пример · 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.

Оценивайте состояние и коды завершения вместе

Нулевой код завершения означает успех запрошенной операции; успешное чтение статуса, приостановка или пробный запуск не означают, что обучение принято. Для этого также нужны завершенное состояние обучения, допустимая причина остановки и выполнение всех обязательных критериев оценки. Невыполненные цели остаются в отчетах и не переименовываются в успешные.

  • Команды выводят машиночитаемый JSON в stdout, а диагностические сведения с удаленными секретами — в stderr. Секреты не появляются ни в одном потоке.
  • Команды run и resume ожидают конечного или приостановленного состояния; status возвращает текущий снимок состояния.
  • При SIGINT возвращается код 130 после максимально возможной очистки принадлежащих запуску worker-процессов. Прерванный процесс не может выдать контрольную точку за завершенную.
Пример · 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.