بازدان بۆ ناوەڕۆکی سەرەکی
بەشەکانی ڕێنمایی ڕاهێنان هەموو بەڵگەنامەکان

SDKی Python: شێواز، ئەنجام و هەڵەکان

واژۆ، ئارگومێنت، گرێبەستی گەڕاندنەوە و شکستی گەڕاندنەوەی TrainingProject لەگەڵ نموونەی تەواوی Python.

فەرمان و کۆد لە هەموو زمانێکدا بە ئینگلیزی دەمێننەوە. جێگرەوە گەورەنووسەکان بە بەهای هەژمار و کاری پارەدراوی خۆت بگۆڕە؛ کلیلی ڕاستەقینە لە نۆتبووکی هاوبەش یان تۆمارەکاندا مەنووسە.

یەک APIی پڕۆژە، یەک ئامێری بنەڕەتی

CLI و Python دەبێت لە ڕێکخستن، دۆخ و بەرهەمدا هاوتا بن.
  1. from_file بێ گۆڕینی کێش باربکە
  2. plan تێخستنی چارەسەرکراو بپشکنە
  3. run / controls کارکەر و گەڕاندنەوە خاوەنداریکراو بن
  4. evaluate / export دەرچوونی ناوخۆی پەسەندکراو بپشکنە

from_file: بێ گۆڕینی کێش باربکە. plan: تێخستنی چارەسەرکراو بپشکنە. run / controls: کارکەر و گەڕاندنەوە خاوەنداریکراو بن. evaluate / export: دەرچوونی ناوخۆی پەسەندکراو بپشکنە

هەمان ئامێر لە Python بەکاربهێنە

TrainingProject تەواوکەرە، نەک جێگرەوەی TrainingClient. ڕێکخستن و کلیلی APIی مەودادار باربکە، پلان بپشکنە و پاشان ڕاکردن دەست پێبکە. ئۆبجێکتی پڕۆژە ڕاکردنی خاوەنداریکراوی بۆ پشکنین و کۆنترۆڵ ئاشکرا دەکات؛ 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 پێویست / بەبێ بنەڕەت تا دۆخی کۆتایی یان pauseکراو بلۆک دەکات؛ بۆ کردارێکی سەرکەوتوو دەرئەنجامی هاوبەش دەگەڕێنێتەوە، لە حاڵەتی تر هەڵەی گونجاو دەهێنێتەوە.
status() dict پێویست / بەبێ بنەڕەت run_id، status، stop_reason، report_path و unmet_criteria بخوێنەوە بێ دەستپێکردنی کارکەر.
pause() dict پێویست / بەبێ بنەڕەت پشتڕاستکردنەوەی وەڵامی کارکەر و checkpointی دروست چاوەڕێ بکە؛ دەرئەنجامی هاوبەش بگەڕێنەوە. دۆخی ناگونجاو هەڵەی ڕێکخستنە.
resume() dict پێویست / بەبێ بنەڕەت هەموو fingerprintەکان پشتڕاست بکەوە و کارکەرە خاوەنداریکراوەکان resume بکە؛ کاتێک کردارەکە سەرکەوتووە دەرئەنجامی هاوبەش بگەڕێنەوە.
cancel() dict پێویست / بەبێ بنەڕەت تا وەستانی کارکەرە خاوەنداریکراوەکان چاوەڕێ بکە و دۆخی cancelled بگەڕێنەوە؛ ئەگەر وەستانی پارێزراو پشتڕاست نەکرایەوە 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 بگەڕێنێتەوە. metricی بنەڕەتی ناتوانرێت بگۆڕدرێت.
نموونە · 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 بپشکنە. ئەنجامی هەڵسەنگاندن هەر پێوەر و دواگەڕانێک دیاری دەکات. Hەناردە ڕێڕەوی ناوخۆ و metadataی یەکپارچەیی دەگەڕێنێتەوە؛ مۆدێل خۆکارانە بارناکات و inferenceی بەرهەمهێنان ناگۆڕێت.

  • دۆخ و زانیاریی 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 دەگونجێن. شکستی ڕێکخستن و گونجانی پێش ڕاهێنان ڕوودەدات. شکستی بودجە و هەڵسەنگاندن ڕاپۆرت و پێوەری جێبەجێنەکراو دەپارێزێت. هەڵەی وەستاندنی کارکەر یان checkpoint تا دڵنیابوونەوە لە پاککردنەوەی پارێزراو شکست دەمێنێتەوە.

  • شێوازی سەرکەوتوو dictionaryی بەڵگەنامەکراو دەگەڕێنێتەوە. پێوەری شکستخواردوو دوای پاشەکەوتکردنی ڕاپۆرت EvaluationFailedError دەهێنێتەوە.
  • کلیلی API، authorization header، ژینگەی تەواو یان نموونەی تایبەتیی ڕاهێنان هەرگیز تۆمار مەکە.
  • هەڵەکان بە دووبارەکردنەوەی خۆکار مەپۆشە. سەرەتا دۆخی ڕاکردن و خزمەتگوزاری بخوێنەوە.
هەڵەکانی Python و هاوتاکردنی دەرچوونی CLI
خانە یان ڕووکارجۆر یان ئەنجامبنەڕەت یان کۆدی دەرچوونهەڵسوکەوت و پشتڕاستکردنەوە
ConfigurationError TrainingError 2 سکیما، ئارگومێنت، ڕێڕەو، دۆخ یان زیادکاریی پشتگیری‌نەکراو نادروستە. پێش دووبارەکردنەوە تێخستن چاک بکە.
CompatibilityError TrainingError 3 ئادا‌پتەر، مۆدێل، ئامێر، وردی، دابەشکردن یان فۆرماتی پشتگیری‌نەکراو.
AuthenticationError TrainingError 4 کلیلی ون، بەسەرچوو، مۆڵەتی ڕەتکراو یان هاوبەشکردنی قەدەغەکراوی مامۆستا؛ هەرگیز ناسنامەنهێنی لە پەیامدا مەخە.
BudgetExceededError TrainingError 5 بودجەی سنووردار پێش قبوڵکردن تەواو بوو. checkpointی دروست و پێوەری جێبەجێنەکراو بپارێزە.
EvaluationFailedError TrainingError 6 پێوەری پێویست تێپەڕ نەبوو، باشترکردن وەستا یان دواگەڕان بەردەوام بوو. ڕاپۆرتی هەڵسەنگاندن بپارێزە.
CheckpointError TrainingError 7 دۆخی گەڕاندنەوە نادروست، ناتەواو یان ناهاوتایە. هەرگیز resume بە زۆر مەکە.
CancellationError TrainingError 7 وەستانی پارێزراوی کارکەرە خاوەنداریکراوەکان پشتڕاست نەکرایەوە؛ پاککردنەوە هێشتا کراوە بهێڵەوە.
ExportError TrainingError 7 بەرهەم، ڕێڕەوی ناپارێزراو یان checksum نادروستە؛ مەیگەیەنە.
TrainingError Exception 7 شکستی بنەڕەتیی ڕاهێنان. هەموو هەڵە ناونراوەکان میراتگری ئەون؛ diagnosticsی بێ‌نهێنی بپارێزە.
نموونە · 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.