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

Python SDK: طریقې، پایلې او تېروتنې

د TrainingProject لاسلیکونه، دلیلونه، د بېرته ورکولو قراردادونه او د بېرته رغېدونکو ناکامیو بشپړې Python بېلګې.

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

د پروژې یو API، یو بنسټیز انجن

CLI او Python باید د تنظیم، حالت او سپارل کېدونکو توکو په اړه یو شان وي.
  1. from_file بې له وزن بدلولو یې ولولئ
  2. plan حل شوي ننوتونه وګورئ
  3. run / controls خپل worker-ونه او بېرته ترلاسه کول اداره کړئ
  4. evaluate / export منل شوي محلي محصولات وګورئ

from_file: بې له وزن بدلولو یې ولولئ. plan: حل شوي ننوتونه وګورئ. run / controls: خپل worker-ونه او بېرته ترلاسه کول اداره کړئ. evaluate / export: منل شوي محلي محصولات وګورئ

په Python کې هماغه انجن وکاروئ

TrainingProject د TrainingClient بشپړوونکی دی، بدیل یې نه دی. تنظیم او محدوده API key ولولئ، پلان وګورئ او بیا اجرا پیل کړئ. د پروژې څیز خپله اجرا د کتنې او کنټرول لپاره وړاندې کوي؛ run شته اجرا نه لیکي او resume سم بېرته ترلاسه کېدونکی حالت غواړي.

  • مسیرونه string یا os.PathLike څیزونه مني. د طریقو اختیارونه یوازې د keyword له لارې دي.
  • from_file محلي تنظیم تاییدوي؛ وزنونه نه بدلوي او ښوونکي ته غوښتنه نه کوي.
  • د Python او CLI کاري بهیرونه یو شان تنظیمات، fingerprint-ونه، بودجې او محصولات کاروي.
د Python پروژې بشپړه مرجع
ډګر یا انترفېسډول یا پایلهتلواله یا د وتلو کوډچلند او تایید
TrainingProject.from_file(path, *, api_key) TrainingProject اړین / تلواله نه لري د تنظیم مسیر او ناتش پټ string ولولئ او تایید یې کړئ. د پروژې څیز ورکوي؛ وزنونه نه بدلوي او ښوونکي ته غوښتنه نه کوي.
plan(*, dry_run=True) dict true یوازې True. resolved_configuration، compatibility، data_sharing، budgets، topics، artifacts او fingerprints ورکوي.
run() dict اړین / تلواله نه لري تر وروستي یا ځنډول شوي حالت پورې تم کېږي؛ د بریالي عملیاتو پر مهال ګډه پایله ورکوي، که نه اړونده تېروتنه راپوروي.
status() dict اړین / تلواله نه لري پرته له worker پیلولو run_id، status، stop_reason، report_path او unmet_criteria ولولئ.
pause() dict اړین / تلواله نه لري د worker تایید او سم checkpoint ته تم شئ؛ ګډه پایله ورکوي. ناسم حالت د تنظیم تېروتنه ده.
resume() dict اړین / تلواله نه لري ټول fingerprint-ونه تایید او خپل worker بیاپیل کړئ؛ د بریالي عملیاتو پر مهال ګډه پایله ورکوي.
cancel() dict اړین / تلواله نه لري د خپلو worker-ونو درېدو ته تم او لغوه شوی حالت ورکړئ؛ که خوندي درېدل تایید نه شي، CancellationError راپوروي.
evaluate(*, split="test") dict "test" validation یا test ومنئ. run_id، split، accepted، criteria، regressions او report_path ورکوي؛ د منلو ناکامي د راپور تر خوندي کېدو وروسته EvaluationFailedError ورکوي.
export(*, format="safetensors") dict "safetensors" د منل شوي سازګار محصول لپاره run_id، format، artifact_path، manifest_path او sha256 ورکوي.
register_evaluator(name, scorer, *, version) None اړین / تلواله نه لري تر پلان یا ارزونې مخکې باوري درجه‌بندوونکی ثبت کړئ. ثابت نوم او څرګنده نسخه ورکړئ؛ فنکشن prediction، target او row اخلي او له 0 تر 1 پورې محدوده نمره باید ورکړي. جوړ معیارونه نه شي بدلولای.
بېلګه · python
import os
from fusionpointai_training import TrainingProject

project = TrainingProject.from_file(
    "./german-project/training.json",
    api_key=os.environ["FUSIONPOINTAI_API_KEY"],
)
plan = project.plan(dry_run=True)
print(plan["resolved_configuration"], plan["data_sharing"], plan["budgets"])
# Confirm the reviewed plan before starting real work.
result = project.run()
if result["status"] != "completed" or result["stop_reason"] != "accepted":
    raise RuntimeError("Training was not accepted; inspect the retained report.")
evaluation = project.evaluate(split="test")
# A failed required criterion raises EvaluationFailedError after saving its report.
artifact = project.export(format="safetensors")
print(artifact["manifest_path"])

جوړښتي پایلې وګورئ

لاندې د بېرته ورکولو قرارداد د معلوماتو بڼې بیانوي، نه د نمونې اندازه‌ګیرۍ. د ځای‌پرځای کولو مخکې status، stop_reason او unmet_criteria وګورئ. د ارزونې پایلې هر معیار او شاتګ جلا ښيي. Export محلي مسیرونه او د بشپړتیا metadata ورکوي؛ ماډل په اتومات ډول نه پورته کوي او نه د تولید استنتاج بدلوي.

  • د ښوونکي نوې غوښتنې پرته status او manifest لوستل کېدای شي.
  • د وروستۍ ازموینې ارزونه د پرمختګ پر مهال له کارېدلې اعتبارسنجونې جلا ده.
  • د محصول manifest باید له اصلي فایلونو، خوندي نسبي مسیرونو، د بایټونو شمېر او SHA-256 سره سمون ولري.
بېلګه · text
TrainingProject return contract (dictionary shapes)
from_file: validates configuration, attaches its owned run; no weight updates.
plan: {schema_version, resolved_configuration, compatibility, data_sharing,
       budgets, topics, artifacts, fingerprints}; dry_run must be true.
run/resume: {run_id, status, stop_reason, report_path, unmet_criteria}.
status/pause/cancel: {run_id, status, stop_reason, report_path, unmet_criteria}.
stop_reason is null until terminal; run/resume block until terminal or paused.
pause blocks until owned workers acknowledge an atomic checkpoint.
cancel blocks until owned workers stop; a failed stop raises CancellationError.
evaluate: {run_id, split, accepted, criteria, regressions, report_path}.
export: {run_id, format, artifact_path, manifest_path, sha256}.
Returned paths are local, resolved paths; no model upload is implied.
Status output is redacted and may be read without opening an API connection.
from_file requires path: str | os.PathLike and a nonempty api_key: str.
plan accepts dry_run=True only; False is ConfigurationError, not execution.
evaluate accepts split="validation" or "test"; defaults to test.
export accepts safetensors or adapters when supported by the selected adapter.
All method keyword options are keyword-only. Unlisted arguments are rejected.

ناکامۍ مه پټوئ، سمه اداره یې کړئ

د پروژې د تېروتنو ټولګي له TrainingError څخه ارث اخلي او د CLI د وتلو کوډونو سره تړلي دي. د تنظیم او سازګارۍ ناکامي تر روزنې مخکې پېښېږي. د بودجې او ارزونې ناکامي راپورونه او ناپوره معیارونه ساتي. د worker د درېدو یا checkpoint تېروتنه تر خوندي پاکولو پورې ناکامي ده.

  • بریالۍ طریقې مستند dictionaries ورکوي. ناکام معیارونه د راپور تر خوندي کېدو وروسته EvaluationFailedError ورکوي.
  • API key، د واک سرلیکونه، بشپړ چاپېریال یا د روزنې شخصي بېلګې هېڅکله لاګ ته مه لیکئ.
  • استثناوې په اتومات بیا هڅو کې مه نغاړئ. لومړی د اجرا او خدمت حالت ولولئ.
د Python تېروتنې او د CLI د وتلو نقشې
ډګر یا انترفېسډول یا پایلهتلواله یا د وتلو کوډچلند او تایید
ConfigurationError TrainingError 2 ناسم schema، دلیل، مسیر، حالت یا نه‌ملاتړ شوی override. تر بیا هڅې مخکې ننوتنې سمې کړئ.
CompatibilityError TrainingError 3 نه‌ملاتړ شوی adapter، ماډل، هارډوېیر، precision، وېش یا بڼه.
AuthenticationError TrainingError 4 ورکه/پای‌مهالې کیلي، رد شوی حق یا منع شوی د ښوونکي شریکول؛ تېروتنې ته هېڅ راز مه ورزیاتوئ.
BudgetExceededError TrainingError 5 محدوده بودجه تر منلو مخکې پای ته ورسېده. سم checkpoint او نه‌پوره شوي معیارونه وساتئ.
EvaluationFailedError TrainingError 6 اړین معیارونه ناکام شول، پرمختګ ودرېد یا شاتګ دوام وکړ. د ارزونې راپور وساتئ.
CheckpointError TrainingError 7 د بېرته ترلاسه کولو حالت ناسم، نیمګړی یا ناساز دی. Resume په زور مه کوئ.
CancellationError TrainingError 7 د خپلو worker-ونو خوندي درېدل تایید نه شول؛ د پاکولو کار خلاص وساتئ.
ExportError TrainingError 7 محصول ناسم یا نه‌ملاتړ شوی، مسیر ناامنه یا checksum ناکام دی؛ مه یې سپارئ.
TrainingError Exception 7 د روزنې بنسټیزه ناکامي. ټول نومول شوي هدف‌تېروتنې له دې ارث اخلي؛ پټې تشخیصي نښې وساتئ.
بېلګه · python
import os
from fusionpointai_training import TrainingProject
from fusionpointai_training.errors import (
    AuthenticationError, BudgetExceededError, CompatibilityError,
    ConfigurationError, EvaluationFailedError, TrainingError,
)

try:
    project = TrainingProject.from_file(
        "./german-project/training.json",
        api_key=os.environ.get("FUSIONPOINTAI_API_KEY", ""),
    )
    project.plan(dry_run=True)
    project.run()
    result = project.evaluate(split="test")
except (ConfigurationError, CompatibilityError):
    print("Correct the configuration before starting a new run.")
except AuthenticationError:
    print("Check access without logging the key.")
except BudgetExceededError:
    print("Preserve the checkpoint. A larger approved budget requires a new plan.")
except EvaluationFailedError:
    print("Preserve failed criteria; do not publish this model as accepted.")
except TrainingError:
    print("Inspect redacted diagnostics; do not blindly repeat a write.")
# CancellationError, CheckpointError and ExportError also inherit TrainingError.
بېلګه · python
from fusionpointai_training import register_evaluator

def category_match(prediction, target, row):
    return float(prediction.strip().casefold() == target.strip().casefold())

register_evaluator("category_match", category_match, version="1")
# Register before project.plan() in the same Python process.
# In rubric.json: "metric": "category_match", "minimum_score": 0.85
# This scorer measures category equality, not open-ended semantic correctness.