Hugging Face's logo

Hub Python Library documentation

الوظائف

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

الوظائف

راجع صفحة توثيق HfApi للاطلاع على مرجع الطرق لإدارة مهامك على Hub.

هياكل البيانات

JobInfo

فئة huggingface_hub.JobInfo

< >

( **kwargs )

المعاملات

  • id (str) — معرّف المهمة.
  • created_at (datetime أو None) — وقت إنشاء المهمة.
  • started_at (datetime أو None) — وقت بدء تشغيل المهمة. تكون القيمة None ما دامت المهمة لا تزال في مرحلة الجدولة.
  • finished_at (datetime أو None) — وقت انتهاء المهمة. تكون القيمة None ما دامت المهمة ما تزال في مرحلة الجدولة أو قيد التنفيذ.
  • docker_image (str أو None) — صورة Docker من Docker Hub المستخدمة للعمل. يمكن أن تكون None إذا كان space_id موجودًا بدلاً من ذلك.
  • space_id (str or None) — صورة Docker من Hugging Face Spaces المستخدمة للوظيفة. يمكن أن تكون None إذا كان docker_image موجودًا بدلاً من ذلك.
  • command (list[str] أو None) — أمر المهمة، على سبيل المثال ["python", "-c", "print('hello world')"]
  • arguments (list[str] أو None) — الحجج المُمرَّرة إلى الأمر
  • environment (dict[str] أو None) — متغيرات البيئة الخاصة بالمهمة (Job) على شكل قاموس.
  • secrets (dict[str] أو None) — متغيرات البيئة السرية الخاصة بالمهمة (مشفّرة).
  • flavor (str أو None) — النوع الخاص بالعتاد. راجع JobHardware لمعرفة القيم الممكنة. مثال: "cpu-basic".
  • labels (dict[str, str] أو None) — التسميات التي سيتم إرفاقها بالمهمة (أزواج مفتاح-قيمة).
  • volumes (list[Volume] أو None) — الأحجام المثبتة في حاوية المهمة (الدلاء، النماذج، مجموعات البيانات، المساحات).
  • status — (JobStatus أو None): حالة المهمة، مثل JobStatus(stage="RUNNING", message=None) راجع JobStage لمعرفة قيم المراحل الممكنة.
  • durations (JobDurations أو None) — تفصيل زمني للوظيفة. موجود لجميع حالات الوظيفة بما في ذلك SCHEDULING.
  • owner — (JobOwner أو None): مالك المهمة، على سبيل المثال JobOwner(id="5e9ecfc04957053f60648a3e", name="lhoestq", type="user")
  • initiator (JobInitiator أو None) — ما الذي أطلق المهمة، على سبيل المثال JobInitiator(type="scheduled-job", id="...") لتشغيل محفّز عبر cron.
  • expose_urls (list[str] أو None) — عناوين URL عامة يمكن من خلالها الوصول إلى المنافذ المكشوفة للـ Job (عنوان واحد لكل منفذ مكشوف)، مثل ["https://687fb701029421ae5549d998--8000.hf.jobs"]. تكون None إذا لم يكن هناك أي منفذ مكشوف. يتطلب الوصول إلى عنوان URL رمز HF مع صلاحية قراءة في مساحة الأسماء الخاصة بالـ Job، ما لم يكن المنفذ عامًا.
  • ssh_url (str أو None) — نقطة نهاية SSH للمهمة، مثل "ssh://687fb701029421ae5549d998@ssh.hf.jobs". لا يظهر إلا عندما تكون المهمة قد بدأت مع ssh=True. يتطلب الاتصال صلاحية الكتابة في مساحة أسماء المهمة ومفتاح SSH عام مسجّل على Hub (https://huggingface.co/settings/keys).
  • network (JobNetwork or None) — Network group the Job joined and the aliases it claims, e.g. JobNetwork(group="train", aliases=["master"]). None when the Job was started without network_group=.
  • retry (int أو None) — عدد محاولات إعادة المحاولة المُهيّأة للعمل (attempts - 1).
  • expose (list[int] أو None) — جميع المنافذ المعرّضة عبر وكيل Jobs، بما في ذلك العامة منها.
  • expose_public (list[int] أو None) — منافذ مكشوفة يمكن الوصول إليها دون مصادقة.

تحتوي على معلومات حول مهمة.

مثال:

>>> from huggingface_hub import run_job
>>> job = run_job(
...     image="python:3.12",
...     command=["python", "-c", "print('Hello from the cloud!')"]
... )
>>> job
JobInfo(id='687fb701029421ae5549d998', created_at=datetime.datetime(2025, 7, 22, 16, 6, 25, 79000, tzinfo=datetime.timezone.utc), started_at=datetime.datetime(2025, 7, 22, 16, 6, 31, 79000, tzinfo=datetime.timezone.utc), finished_at=None, docker_image='python:3.12', space_id=None, command=['python', '-c', "print('Hello from the cloud!')"], arguments=[], environment={}, secrets={}, flavor='cpu-basic', labels=None, status=JobStatus(stage='RUNNING', message=None), durations=JobDurations(scheduling_secs=6, running_secs=2, total_secs=8), owner=JobOwner(id='5e9ecfc04957053f60648a3e', name='lhoestq', type='user'), initiator=JobInitiator(type='user', id='5e9ecfc04957053f60648a3e', name='lhoestq'), endpoint='https://huggingface.co', url='https://huggingface.co/jobs/lhoestq/687fb701029421ae5549d998')
>>> job.id
'687fb701029421ae5549d998'
>>> job.url
'https://huggingface.co/jobs/lhoestq/687fb701029421ae5549d998'
>>> job.status.stage
'RUNNING'

JobOwner

فئة huggingface_hub.JobOwner

< >

( id: strname: strtype: str )

JobNetwork

class huggingface_hub.JobNetwork

< >

( **kwargs )

المعاملات

  • group (str) — اسم مجموعة الشبكة، كما تم تمريره إلى network_group=.
  • aliases (list[str]) — المستعarentات التي يدّعيها Job ضمن المجموعة، كما تم تمريرها إلى network_aliases=. تكون فارغة عند عدم وجود أي مستعarentات.

انضم إلى مجموعة الشبكة Job.

JobStage

فئة huggingface_hub.JobStage

< >

( valuenames = Nonemodule = Nonequalname = Nonetype = Nonestart = 1 )

قائمة بالمرحلة المحتملة للوظيفة على Hub.

يمكن مقارنة القيمة Value بسلسلة نصية:

assert JobStage.COMPLETED == "COMPLETED"
Possible values are: `COMPLETED`, `CANCELED`, `ERROR`, `DELETED`, `SCHEDULING`, `RUNNING`. Taken from https://github.com/huggingface/moon-landing/blob/main/server/job_types/JobInfo.ts#L61 (private url).

JobStatus

فئة huggingface_hub.JobStatus

< >

( stage: JobStagemessage: str | Noneexpose_urls: list[str] | Nonessh_url: str | None )

الحجم

فئة huggingface_hub.Volume

< >

( **kwargs )

المعاملات

  • type (str) — نوع الحجم: "bucket" أو "model" أو "dataset" أو "space".
  • source (str) — معرّف المصدر، مثل "username/my-bucket" أو "username/my-model".
  • mount_path (str) — مسار التركيب داخل الحاوية، مثل "/data". يجب أن يبدأ بـ /.
  • revision (str أو None) — مراجعة Git (للمستودعات فقط، القيمة الافتراضية هي "main").
  • read_only (bool أو None) — تركيب للقراءة فقط. يُفرض True للمستودعات، والافتراضي هو False للبراميل.
  • path (str أو None) — بادئة مجلد فرعي داخل الدلو/المستودع لتركيبه، مثل "path/to/dir".

يصف وحدة تخزين (Volume) لتركيبها في حاوية Space أو Job.

to_dict

< >

( )

تسلسل إلى حمولة JSON المتوقعة من واجهة برمجة تطبيقات Hub.

to_uri

< >

( )

أعد الحجم كـ URI لتركيب HF بالصيغة التي يتوقعها سطر الأوامر.

Update on GitHub

←OAuth صناديق الرمل→