JobOperations الفصل

بدء مثيل JobOperations

يجب عدم إنشاء مثيل لهذه الفئة مباشرة. بدلا من ذلك، استخدم سمة المهام لعنصر MLClient.

توريث

azure.ai.ml._scope_dependent_operations._ScopeDependentOperations

JobOperations

الدالمنشئ

JobOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client_02_2023_preview: AzureMachineLearningWorkspaces, all_operations: OperationsContainer, credential: TokenCredential, **kwargs: Any)

المعلمات

operation_scope

<xref:azure.ai.ml._scope_dependent_operations.OperationScope>

مطلوب

متغيرات النطاق لفئات العمليات لعنصر MLClient.

operation_config

<xref:azure.ai.ml._scope_dependent_operations.OperationConfig>

مطلوب

التكوين الشائع لفئات العمليات لعنصر MLClient.

service_client_02_2023_preview

<xref:azure.ai.ml._restclient.v2023_02_01_preview.AzureMachineLearningWorkspaces>

مطلوب

عميل الخدمة للسماح للمستخدمين النهائيين بالعمل على موارد مساحة عمل التعلم الآلي من Microsoft Azure.

all_operations

<xref:azure.ai.ml._scope_dependent_operations.OperationsContainer>

مطلوب

جميع فئات العمليات لعنصر MLClient.

credential

TokenCredential

مطلوب

بيانات الاعتماد لاستخدامها للمصادقة.

الأساليب

archive	أرشفة وظيفة.
begin_cancel	إلغاء وظيفة.
create_or_update	إنشاء وظيفة أو تحديثها. إذا تم تعريف كيانات مثل البيئة أو التعليمات البرمجية بشكل مضمن، فسيتم إنشاؤها مع الوظيفة.
download	تنزيل سجلات ومخرجات الوظيفة.
get	الحصول على مورد وظيفة.
list	يسرد المهام في مساحة العمل.
restore	استعادة مهمة مؤرشفة.
show_services	يحصل على الخدمات المقترنة بعقدة الوظيفة.
stream	دفق سجلات مهمة قيد التشغيل.
validate	ملاحظة هذه طريقة تجريبية، وقد تتغير في أي وقت. يرجى مراجعة https://aka.ms/azuremlexperimental لمزيد من المعلومات. التحقق من صحة كائن Job قبل الإرسال إلى الخدمة. يمكن إنشاء أصول مجهولة إذا كانت هناك كيانات محددة مضمنة مثل المكون والبيئة والرمز. يتم دعم مهام البنية الأساسية لبرنامج ربط العمليات التجارية فقط للتحقق من الصحة حاليا.

archive

أرشفة وظيفة.

archive(name: str) -> None

المعلمات

name

str

مطلوب

اسم العمل.

استثناءات

ResourceNotFoundError

يرفع إذا لم يتم العثور على وظيفة بالاسم المحدد.

أمثلة

أرشفة وظيفة.

   ml_client.jobs.archive(name=job_name)

begin_cancel

إلغاء وظيفة.

begin_cancel(name: str, **kwargs) -> LROPoller[None]

المعلمات

name

str

مطلوب

اسم العمل.

المرتجعات

استقصاء لتعقب حالة العملية.

نوع الإرجاع

LROPoller[None]

استثناءات

ResourceNotFoundError

يرفع إذا لم يتم العثور على وظيفة بالاسم المحدد.

create_or_update

إنشاء وظيفة أو تحديثها. إذا تم تعريف كيانات مثل البيئة أو التعليمات البرمجية بشكل مضمن، فسيتم إنشاؤها مع الوظيفة.

create_or_update(job: Job, *, description: str | None = None, compute: str | None = None, tags: dict | None = None, experiment_name: str | None = None, skip_validation: bool = False, **kwargs) -> Job

المعلمات

job

Job

مطلوب

كائن الوظيفة.

description

Optional[str]

وصف الوظيفة.

compute

Optional[str]

هدف الحساب للوظيفة.

tags

Optional[dict]

علامات الوظيفة.

experiment_name

Optional[str]

اسم التجربة التي سيتم إنشاء الوظيفة ضمنها. إذا تم توفير None، فسيتم إنشاء المهمة ضمن التجربة "Default".

skip_validation

bool

يحدد ما إذا كان يجب تخطي التحقق من الصحة أم لا قبل إنشاء المهمة أو تحديثها. لاحظ أنه لن يتم تخطي التحقق من صحة الموارد التابعة مثل مكون مجهول. الإعدادات الافتراضية معينة على False.

المرتجعات

تم إنشاء مهمة أو تحديثها.

نوع الإرجاع

Job

استثناءات

Union

UserErrorException

ValidationException

يرفع إذا تعذر التحقق من صحة الوظيفة بنجاح. سيتم توفير التفاصيل في رسالة الخطأ.

AssetException

يتم رفعها إذا تعذر التحقق من صحة أصول الوظيفة (على سبيل المثال، البيانات، التعليمات البرمجية، النموذج، البيئة) بنجاح. سيتم توفير التفاصيل في رسالة الخطأ.

ModelException

يرفع إذا تعذر التحقق من صحة نموذج الوظيفة بنجاح. سيتم توفير التفاصيل في رسالة الخطأ.

JobException

يرفع إذا تم تنسيق عنصر المهمة أو السمات بشكل صحيح. سيتم توفير التفاصيل في رسالة الخطأ.

EmptyDirectoryError

يرفع إذا كان المسار المحلي يوفر نقاطا إلى دليل فارغ.

DockerEngineNotAvailableError

يرفع إذا لم يكن Docker Engine متوفرا للوظيفة المحلية.

أمثلة

إنشاء وظيفة جديدة ثم تحديث حسابها.

   from azure.ai.ml import load_job

   created_job = ml_client.jobs.create_or_update(
       name=job_name,
       job=load_job(
           "./sdk/ml/azure-ai-ml/tests/test_configs/command_job/command_job_test_local_env.yml",
           params_override=[{"name": job_name}, {"compute": "cpucluster"}],
       ),
   )

download

تنزيل سجلات ومخرجات الوظيفة.

download(name: str, *, download_path: PathLike | str = '.', output_name: str | None = None, all: bool = False) -> None

المعلمات

name

str

مطلوب

اسم الوظيفة.

download_path

Union[<xref:PathLike>, str]

المسار المحلي الذي سيتم استخدامه كوجهة التنزيل. الإعدادات الافتراضية إلى ".".

output_name

Optional[str]

اسم الإخراج المراد تنزيله. الإعدادات الافتراضية إلى بلا.

all

bool

يحدد ما إذا كان يجب تنزيل جميع السجلات والمخرجات المسماة. الإعدادات الافتراضية معينة على False.

استثناءات

JobException

يرفع إذا لم تكن الوظيفة في حالة طرفية بعد. سيتم توفير التفاصيل في رسالة الخطأ.

MlException

يرفع إذا تعذر تنزيل السجلات والمخرجات بنجاح. سيتم توفير التفاصيل في رسالة الخطأ.

أمثلة

تنزيل جميع السجلات والمخرجات المسماة للوظيفة "job-1" في الدليل المحلي "job-1-logs".

   ml_client.jobs.download(name=job_name, download_path="./job-1-logs", all=True)

get

الحصول على مورد وظيفة.

get(name: str) -> Job

المعلمات

name

str

مطلوب

اسم العمل.

المرتجعات

كائن المهمة الذي تم استرداده من الخدمة.

نوع الإرجاع

Job

استثناءات

ResourceNotFoundError

يرفع إذا لم يتم العثور على وظيفة بالاسم المحدد.

UserErrorException

يرفع إذا لم تكن معلمة الاسم سلسلة.

أمثلة

استرداد وظيفة تسمى "iris-dataset-job-1".

   retrieved_job = ml_client.jobs.get(job_name)

list

يسرد المهام في مساحة العمل.

list(*, parent_job_name: str | None = None, list_view_type: ListViewType = ListViewType.ACTIVE_ONLY, **kwargs) -> Iterable[Job]

المعلمات

parent_job_name

Optional[str]

عند توفيرها، تقوم بإرجاع الوظائف التي تكون تابعة للوظيفة المسماة فقط. الإعدادات الافتراضية إلى بلا، مع سرد جميع المهام في مساحة العمل.

list_view_type

ListViewType

نوع طريقة العرض لتضمين/استبعاد المهام المؤرشفة. الإعدادات الافتراضية ل ~azure.mgt.machinelearningservices.models.ListViewType.ACTIVE_ONLY، باستثناء المهام المؤرشفة.

المرتجعات

مثيل يشبه المكرر لكائنات الوظيفة.

نوع الإرجاع

ItemPaged[Job]

استثناءات

ResourceNotFoundError

يرفع إذا لم يتم العثور على وظيفة بالاسم المحدد.

أمثلة

استرداد قائمة بالمهام المؤرشفة في مساحة عمل مع مهمة أصل تسمى "iris-dataset-jobs".

   from azure.ai.ml._restclient.v2023_04_01_preview.models import ListViewType

   list_of_jobs = ml_client.jobs.list(parent_job_name=job_name, list_view_type=ListViewType.ARCHIVED_ONLY)

restore

استعادة مهمة مؤرشفة.

restore(name: str) -> None

المعلمات

name

str

مطلوب

اسم العمل.

استثناءات

ResourceNotFoundError

يرفع إذا لم يتم العثور على وظيفة بالاسم المحدد.

أمثلة

استعادة مهمة مؤرشفة.

   ml_client.jobs.restore(name=job_name)

show_services

يحصل على الخدمات المقترنة بعقدة الوظيفة.

show_services(name: str, node_index: int = 0) -> Dict[str, ServiceInstance]

المعلمات

name

str

مطلوب

اسم العمل.

node_index

int

مطلوب

فهرس العقدة (يستند إلى الصفر). الافتراضي 0.

المرتجعات

الخدمات المقترنة بالمهمة للعقدة المحددة.

نوع الإرجاع

dict[str, ServiceInstance]

استثناءات

ResourceNotFoundError

يرفع إذا لم يتم العثور على وظيفة بالاسم المحدد.

أمثلة

استرداد الخدمات المقترنة بالعقدة 1 للوظيفة.

   job_services = ml_client.jobs.show_services(job_name)

stream

دفق سجلات مهمة قيد التشغيل.

stream(name: str) -> None

المعلمات

name

str

مطلوب

اسم العمل.

استثناءات

ResourceNotFoundError

يرفع إذا لم يتم العثور على وظيفة بالاسم المحدد.

أمثلة

دفق مهمة قيد التشغيل.

   running_job = ml_client.jobs.create_or_update(
       load_job(
           "./sdk/ml/azure-ai-ml/tests/test_configs/command_job/command_job_test_local_env.yml",
           params_override=[{"name": job_name}, {"compute": "cpucluster"}],
       )
   )
   ml_client.jobs.stream(running_job.name)

validate

ملاحظة

هذه طريقة تجريبية، وقد تتغير في أي وقت. يرجى مراجعة https://aka.ms/azuremlexperimental لمزيد من المعلومات.

التحقق من صحة كائن Job قبل الإرسال إلى الخدمة. يمكن إنشاء أصول مجهولة إذا كانت هناك كيانات محددة مضمنة مثل المكون والبيئة والرمز. يتم دعم مهام البنية الأساسية لبرنامج ربط العمليات التجارية فقط للتحقق من الصحة حاليا.

validate(job: Job, *, raise_on_failure: bool = False, **kwargs) -> ValidationResult

المعلمات

job

Job

مطلوب

كائن الوظيفة المراد التحقق من صحته.

raise_on_failure

bool

يحدد ما إذا كان يجب رفع خطأ إذا فشل التحقق من الصحة. الإعدادات الافتراضية معينة على False.

المرتجعات

كائن ValidationResult يحتوي على جميع الأخطاء التي تم العثور عليها.

نوع الإرجاع

ValidationResult

استثناءات

ResourceNotFoundError

يرفع إذا لم يتم العثور على وظيفة بالاسم المحدد.

أمثلة

التحقق من صحة كائن PipelineJob وطباعة الأخطاء التي تم العثور عليها.

   from azure.ai.ml import load_job
   from azure.ai.ml.entities import PipelineJob

   pipeline_job: PipelineJob = load_job(
       "./sdk/ml/azure-ai-ml/tests/test_configs/pipeline_jobs/invalid/combo.yml",
       params_override=[{"name": job_name}, {"compute": "cpucluster"}],
   )
   print(ml_client.jobs.validate(pipeline_job).error_messages)