اصلي منځپانګې ته ورټوپ کړئ
د روزنې لارښود څپرکي ټول اسناد

د Python SDK مرجع او امرونه

د TrainingClient د ناستې طریقې، د TrainingProject طریقې، د جوړوونکي اختیارونه، ډیټاسېټونه او د چلولو وړ بېلګې.

په ټولو ژبو کې امرونه او کوډ په انګلیسي پاتې کېږي. غټ‌توري ځای‌نښې د خپل حساب او پیسې ورکړل شوې دندې له ارزښتونو سره بدلې کړئ؛ ریښتینې کیلي په شریکو notebook-ونو یا لاګونو کې مه نښلوئ.

د Python SDK انترفېسونه

TrainingClient شته پاتې کېږي؛ TrainingProject محلي د پروژې اجرا اداره کوي.
  1. TrainingClient HTTPS او محدوده API key
  2. د ناستې طریقې پرانیستل، چمتو کول او کتنه
  3. TrainingProject پلان جوړول او محلي روزنه
  4. پایله محلي محصول او راپورونه

TrainingClient: HTTPS او محدوده API key. د ناستې طریقې: پرانیستل، چمتو کول او کتنه. TrainingProject: پلان جوړول او محلي روزنه. پایله: محلي محصول او راپورونه

مراجع په خوندي ډول جوړ کړئ

TrainingClient یو API key، د HTTPS base_url، مثبت محدود timeout او له 0 تر 5 پورې max_get_retries مني. تلواله timeout 60 ثانیې او د GET بیا هڅو تلواله شمېر 2 دی. Redirect-ونه رد کېږي. allow_loopback یوازې د څرګندو محلي ازموینو لپاره دی؛ د ناامنه لرې اتصال له لارې د اصلي کیلي لېږلو دلیل نه شي کېدای.

  • په ټولو ژبو کې د کوډ او چاپېریالي متغیرونو نومونه انګلیسي وساتئ.
  • TrainingClient د پخوانیو ناستو ادغامونو لپاره لا هم شته.
  • د schema پر بنسټ د محلي پروژې اجرا لپاره TrainingProject او fpai-training وکاروئ.
بېلګه · bash
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'
بېلګه · python
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.
بېلګه · python
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 د keyword-only په توګه او د مثبت integer په بڼه ورکړئ، boolean نه.
  • max_requests د چمتو کولو غوښتنې محدودوي؛ د ماډل د روزنې د دورو شمېر نه دی.
  • TrainingClient.train د ناستې ID او نوې محصول ډایرکټري مني؛ TrainingProject د ماډل مسیر د پروژې له تنظیمه اخلي.
بېلګه · python
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.
بېلګه · python
# 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.
بېلګه · python
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.
بېلګه · python
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 د TrainingError فرعي ټولګیو په توګه ConfigurationError، CompatibilityError، AuthenticationError، BudgetExceededError، EvaluationFailedError، CheckpointError، CancellationError او ExportError وړاندې کوي. د ستونزې د موندلو پر مهال ټول چاپېریال یا د واک سرلیکونه مه چاپوئ. د پخواني مراجع میتودونه او د نوې پروژې API جلا قراردادونه لري.

  • د هرې اجرا له ثبت سره د بسته او تړاوونو نسخې وساتئ.
  • د شته‌والي په صورت کې د TrainingProject تېروتنې پټې شوې تشخیصي نښې او راپورونه ساتي.
  • د وضعیت تر لوستلو مخکې د حالت بدلولو عملیات مه تکراروئ.
بېلګه · python
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.
بېلګه · python
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