Python SDK リファレンスとコマンド

クライアントを安全に作成する

TrainingClient は API キー、HTTPS の base_url、有限かつ正のタイムアウト、0～5 の max_get_retries を受け取ります。既定のタイムアウトは60秒、GET の既定再試行回数は2回です。リダイレクトは拒否されます。allow_loopback は明示的なローカルテスト専用です。安全でないリモート接続で実際のキーを送信する理由として使わないでください。

• すべてのロケールでコードと環境変数名は英語のままにします。
• 既存のセッション連携では引き続き TrainingClient を利用できます。
• スキーマに基づくローカルのプロジェクト実行には TrainingProject と fpai-training を使います。

python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
# Install the GPU-compatible PyTorch build for your runtime first.
python -m pip install 'fusionpointai-training[train] @ https://fusionpointai.com/downloads/fusionpointai-training.zip'
# API-only use without local training dependencies:
# python -m pip install 'fusionpointai-training @ https://fusionpointai.com/downloads/fusionpointai-training.zip'

import os
from fusionpointai_training import TrainingClient

client = TrainingClient(
    api_key=os.environ["FUSIONPOINTAI_API_KEY"],
    base_url="https://fusionpointai.com/api/v1/training",
    timeout=60.0,
    max_get_retries=2,
)
# transport optionally accepts an httpx transport for controlled integrations.
# Never enable insecure remote HTTP to work around a TLS error.

from importlib.metadata import PackageNotFoundError, version
from importlib.util import find_spec

for package in ("fusionpointai-training", "httpx", "torch", "transformers", "peft"):
    try:
        print(f"{package}=={version(package)}")
    except PackageNotFoundError:
        print(f"{package}: not installed")

for module in ("torch", "transformers", "peft", "safetensors"):
    print(f"{module} importable:", find_spec(module) is not None)
# The train extra includes optional model-training dependencies; inspect before use.

公開メソッドを使う

open_session と create_session は同じ操作です。prepare_session は回数を制限して準備を行います。get_session は状態を確認します。download_dataset は DatasetManifest を検証します。post_event は実行環境の実際の進捗を報告します。train はセッション用の学習エンジンを実行します。complete はローカルで作成した成果物を報告し、cancel はサービスのセッション状態をキャンセルします。これらの TrainingClient メソッドは既存連携向けに維持されています。

• reference_model_id はキーワード専用で、ブール値ではない正の整数を指定します。
• max_requests は準備リクエスト数の上限であり、モデル学習のエポック数ではありません。
• TrainingClient.train はセッション ID と新しい出力ディレクトリを受け取り、TrainingProject は設定からモデルパスを読み込みます。

from fusionpointai_training.client import DatasetManifest

# Continue with an authenticated client and an owned session.
ready = client.prepare_session(session["id"])
for item in ready["datasets"]:
    manifest = DatasetManifest(
        split=item["split"], sha256=item["sha256"],
        bytes=item["bytes"], rows=item["rows"],
    )
    rows = client.download_dataset(ready["id"], manifest)
    print(manifest.split, len(rows), manifest.sha256)
    # Each row has a text field. Do not log private training content.

# For a genuine external trainer integration, not simulated progress.
def report_progress(client, session_id, *, step, total_steps, loss):
    return client.post_event(session_id, {
        "state": "running",
        "step": step,
        "total_steps": total_steps,
        "metrics": {"loss": loss},
    })
# Supply values observed from your real trainer.
# The built-in train() already reports its progress; do not duplicate it.

import json
from pathlib import Path

# Continue with client/session. Inspect state before retrying reporting.
report = json.loads(Path("customer-model-run-001/training-report.json").read_text())
state = client.get_session(session["id"])
if state["status"] == "evaluating":
    state = client.complete(session["id"], report["completion_report"])
print(state["status"])
# Do not restart weight training just to reconcile reporting.

import os
from fusionpointai_training import TrainingClient

client = TrainingClient(api_key=os.environ["FUSIONPOINTAI_API_KEY"])
session = client.get_session(os.environ["FUSIONPOINTAI_SESSION_ID"])
report = session.get("report")
last_event = report.get("last_event", {}) if isinstance(report, dict) else {}
print("State:", session["status"], "Step:", session["step"])
print("Last reported error code:", last_event.get("error_code"))
# A missing error_code does not prove success. Read state and your local report.
# Do not dump full provider responses, private data or authorization headers.

例外と想定される出力

セッション操作で TrainingClient が送出するのは APIError と IntegrityError です。TrainingProject では ConfigurationError、CompatibilityError、AuthenticationError、BudgetExceededError、EvaluationFailedError、CheckpointError、CancellationError、ExportError が TrainingError のサブクラスとして定義されています。デバッグ時に環境変数や認証ヘッダーを出力しないでください。従来のクライアントメソッドとプロジェクト API では契約が異なります。

• 実行ごとに SDK パッケージと依存関係のバージョンを記録します。
• TrainingProject のエラーでは、可能な場合に機密情報を除いた診断情報とレポートが保持されます。
• 状態を変更する操作を再試行する前に、必ず現在の状態を読み取ってください。

import os
from fusionpointai_training import TrainingClient
from fusionpointai_training.errors import APIError, IntegrityError, TrainingError

client = TrainingClient(api_key=os.environ["FUSIONPOINTAI_API_KEY"])
try:
    state = client.get_session(os.environ["FUSIONPOINTAI_SESSION_ID"])
    print("Current state:", state["status"])
except IntegrityError:
    print("Integrity check failed; preserve the report and investigate.")
except TrainingError:
    print("Training failed; inspect the local report before retrying.")
except APIError:
    print("Request failed; inspect access and session state before another write.")
except ValueError:
    print("Invalid local configuration; correct the input before retrying.")
# Never print the key or authorization headers.

import os
from fusionpointai_training import TrainingClient
from fusionpointai_training.errors import APIError

client = TrainingClient(
    api_key=os.environ["FUSIONPOINTAI_API_KEY"],
    timeout=30.0,
    max_get_retries=2,
)
try:
    session = client.get_session(os.environ["FUSIONPOINTAI_SESSION_ID"])
except APIError:
    # GET retries are bounded. Do not blindly retry a write after an error.
    print("Session inspection failed; check access and current server state.")
else:
    print("Status:", session["status"])
# Never print the API key, authorization headers, or response secrets.

Python インターフェース

• TrainingClient(api_key: str, *, base_url: str = "https://fusionpointai.com/api/v1/training", allow_loopback: bool = False, timeout: float = 60.0, max_get_retries: int = 2, transport: httpx.BaseTransport | None = None)
• create_session(job: str, runtime: str, *, reference_model_id: int | None = None) -> dict
• open_session(job: str, runtime: str, *, reference_model_id: int | None = None) -> dict
• get_session(session_id: str) -> dict
• prepare_session(session_id: str, *, max_requests: int | None = None) -> dict
• DatasetManifest(split: str, sha256: str, bytes: int, rows: int)
• download_dataset(session_id: str, manifest: DatasetManifest) -> list[dict[str, str]]
• post_event(session_id: str, event: dict) -> dict
• train(session_id: str, output_dir: str | os.PathLike[str]) -> dict
• complete(session_id: str, report: dict) -> dict
• cancel(session_id: str) -> dict
• TrainingProject.from_file(path: str | os.PathLike[str], *, api_key: str) -> TrainingProject
• TrainingProject.plan(*, dry_run: bool = True) -> dict
• TrainingProject.run() -> dict
• TrainingProject.status() -> dict
• TrainingProject.pause() -> dict
• TrainingProject.resume() -> dict
• TrainingProject.cancel() -> dict
• TrainingProject.evaluate(*, split: str = "test") -> dict
• TrainingProject.export(*, format: str = "safetensors") -> dict
• register_evaluator(name: str, scorer: Callable, *, version: str) -> None