File size: 10,803 Bytes
8193465 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 | # coding=utf-8
# Copyright 2025-present, the HuggingFace Inc. team.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from dataclasses import dataclass
from datetime import datetime
from enum import Enum
from typing import Any, Dict, List, Optional, Union
from huggingface_hub import constants
from huggingface_hub._space_api import SpaceHardware
from huggingface_hub.utils._datetime import parse_datetime
class JobStage(str, Enum):
"""
Enumeration of possible stage of a Job on the Hub.
Value can be compared to a string:
```py
assert JobStage.COMPLETED == "COMPLETED"
```
Taken from https://github.com/huggingface/moon-landing/blob/main/server/job_types/JobInfo.ts#L61 (private url).
"""
# Copied from moon-landing > server > lib > Job.ts
COMPLETED = "COMPLETED"
CANCELED = "CANCELED"
ERROR = "ERROR"
DELETED = "DELETED"
RUNNING = "RUNNING"
@dataclass
class JobStatus:
stage: JobStage
message: Optional[str]
@dataclass
class JobOwner:
id: str
name: str
type: str
@dataclass
class JobInfo:
"""
Contains information about a Job.
Args:
id (`str`):
Job ID.
created_at (`datetime` or `None`):
When the Job was created.
docker_image (`str` or `None`):
The Docker image from Docker Hub used for the Job.
Can be None if space_id is present instead.
space_id (`str` or `None`):
The Docker image from Hugging Face Spaces used for the Job.
Can be None if docker_image is present instead.
command (`List[str]` or `None`):
Command of the Job, e.g. `["python", "-c", "print('hello world')"]`
arguments (`List[str]` or `None`):
Arguments passed to the command
environment (`Dict[str]` or `None`):
Environment variables of the Job as a dictionary.
secrets (`Dict[str]` or `None`):
Secret environment variables of the Job (encrypted).
flavor (`str` or `None`):
Flavor for the hardware, as in Hugging Face Spaces. See [`SpaceHardware`] for possible values.
E.g. `"cpu-basic"`.
status: (`JobStatus` or `None`):
Status of the Job, e.g. `JobStatus(stage="RUNNING", message=None)`
See [`JobStage`] for possible stage values.
owner: (`JobOwner` or `None`):
Owner of the Job, e.g. `JobOwner(id="5e9ecfc04957053f60648a3e", name="lhoestq", type="user")`
Example:
```python
>>> 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), docker_image='python:3.12', space_id=None, command=['python', '-c', "print('Hello from the cloud!')"], arguments=[], environment={}, secrets={}, flavor='cpu-basic', status=JobStatus(stage='RUNNING', message=None), owner=JobOwner(id='5e9ecfc04957053f60648a3e', name='lhoestq', type='user'), 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'
```
"""
id: str
created_at: Optional[datetime]
docker_image: Optional[str]
space_id: Optional[str]
command: Optional[List[str]]
arguments: Optional[List[str]]
environment: Optional[Dict[str, Any]]
secrets: Optional[Dict[str, Any]]
flavor: Optional[SpaceHardware]
status: JobStatus
owner: JobOwner
# Inferred fields
endpoint: str
url: str
def __init__(self, **kwargs) -> None:
self.id = kwargs["id"]
created_at = kwargs.get("createdAt") or kwargs.get("created_at")
self.created_at = parse_datetime(created_at) if created_at else None
self.docker_image = kwargs.get("dockerImage") or kwargs.get("docker_image")
self.space_id = kwargs.get("spaceId") or kwargs.get("space_id")
owner = kwargs.get("owner", {})
self.owner = JobOwner(id=owner["id"], name=owner["name"], type=owner["type"])
self.command = kwargs.get("command")
self.arguments = kwargs.get("arguments")
self.environment = kwargs.get("environment")
self.secrets = kwargs.get("secrets")
self.flavor = kwargs.get("flavor")
status = kwargs.get("status", {})
self.status = JobStatus(stage=status["stage"], message=status.get("message"))
# Inferred fields
self.endpoint = kwargs.get("endpoint", constants.ENDPOINT)
self.url = f"{self.endpoint}/jobs/{self.owner.name}/{self.id}"
@dataclass
class JobSpec:
docker_image: Optional[str]
space_id: Optional[str]
command: Optional[List[str]]
arguments: Optional[List[str]]
environment: Optional[Dict[str, Any]]
secrets: Optional[Dict[str, Any]]
flavor: Optional[SpaceHardware]
timeout: Optional[int]
tags: Optional[List[str]]
arch: Optional[str]
def __init__(self, **kwargs) -> None:
self.docker_image = kwargs.get("dockerImage") or kwargs.get("docker_image")
self.space_id = kwargs.get("spaceId") or kwargs.get("space_id")
self.command = kwargs.get("command")
self.arguments = kwargs.get("arguments")
self.environment = kwargs.get("environment")
self.secrets = kwargs.get("secrets")
self.flavor = kwargs.get("flavor")
self.timeout = kwargs.get("timeout")
self.tags = kwargs.get("tags")
self.arch = kwargs.get("arch")
@dataclass
class LastJobInfo:
id: str
at: datetime
def __init__(self, **kwargs) -> None:
self.id = kwargs["id"]
self.at = parse_datetime(kwargs["at"])
@dataclass
class ScheduledJobStatus:
last_job: Optional[LastJobInfo]
next_job_run_at: Optional[datetime]
def __init__(self, **kwargs) -> None:
last_job = kwargs.get("lastJob") or kwargs.get("last_job")
self.last_job = LastJobInfo(**last_job) if last_job else None
next_job_run_at = kwargs.get("nextJobRunAt") or kwargs.get("next_job_run_at")
self.next_job_run_at = parse_datetime(str(next_job_run_at)) if next_job_run_at else None
@dataclass
class ScheduledJobInfo:
"""
Contains information about a Job.
Args:
id (`str`):
Scheduled Job ID.
created_at (`datetime` or `None`):
When the scheduled Job was created.
tags (`List[str]` or `None`):
The tags of the scheduled Job.
schedule (`str` or `None`):
One of "@annually", "@yearly", "@monthly", "@weekly", "@daily", "@hourly", or a
CRON schedule expression (e.g., '0 9 * * 1' for 9 AM every Monday).
suspend (`bool` or `None`):
Whether the scheduled job is suspended (paused).
concurrency (`bool` or `None`):
Whether multiple instances of this Job can run concurrently.
status (`ScheduledJobStatus` or `None`):
Status of the scheduled Job.
owner: (`JobOwner` or `None`):
Owner of the scheduled Job, e.g. `JobOwner(id="5e9ecfc04957053f60648a3e", name="lhoestq", type="user")`
job_spec: (`JobSpec` or `None`):
Specifications of the Job.
Example:
```python
>>> from huggingface_hub import run_job
>>> scheduled_job = create_scheduled_job(
... image="python:3.12",
... command=["python", "-c", "print('Hello from the cloud!')"],
... schedule="@hourly",
... )
>>> scheduled_job.id
'687fb701029421ae5549d999'
>>> scheduled_job.status.next_job_run_at
datetime.datetime(2025, 7, 22, 17, 6, 25, 79000, tzinfo=datetime.timezone.utc)
```
"""
id: str
created_at: Optional[datetime]
job_spec: JobSpec
schedule: Optional[str]
suspend: Optional[bool]
concurrency: Optional[bool]
status: ScheduledJobStatus
owner: JobOwner
def __init__(self, **kwargs) -> None:
self.id = kwargs["id"]
created_at = kwargs.get("createdAt") or kwargs.get("created_at")
self.created_at = parse_datetime(created_at) if created_at else None
self.job_spec = JobSpec(**(kwargs.get("job_spec") or kwargs.get("jobSpec", {})))
self.schedule = kwargs.get("schedule")
self.suspend = kwargs.get("suspend")
self.concurrency = kwargs.get("concurrency")
status = kwargs.get("status", {})
self.status = ScheduledJobStatus(
last_job=status.get("last_job") or status.get("lastJob"),
next_job_run_at=status.get("next_job_run_at") or status.get("nextJobRunAt"),
)
owner = kwargs.get("owner", {})
self.owner = JobOwner(id=owner["id"], name=owner["name"], type=owner["type"])
def _create_job_spec(
*,
image: str,
command: List[str],
env: Optional[Dict[str, Any]],
secrets: Optional[Dict[str, Any]],
flavor: Optional[SpaceHardware],
timeout: Optional[Union[int, float, str]],
) -> Dict[str, Any]:
# prepare job spec to send to HF Jobs API
job_spec: Dict[str, Any] = {
"command": command,
"arguments": [],
"environment": env or {},
"flavor": flavor or SpaceHardware.CPU_BASIC,
}
# secrets are optional
if secrets:
job_spec["secrets"] = secrets
# timeout is optional
if timeout:
time_units_factors = {"s": 1, "m": 60, "h": 3600, "d": 3600 * 24}
if isinstance(timeout, str) and timeout[-1] in time_units_factors:
job_spec["timeoutSeconds"] = int(float(timeout[:-1]) * time_units_factors[timeout[-1]])
else:
job_spec["timeoutSeconds"] = int(timeout)
# input is either from docker hub or from HF spaces
for prefix in (
"https://huggingface.co/spaces/",
"https://hf.co/spaces/",
"huggingface.co/spaces/",
"hf.co/spaces/",
):
if image.startswith(prefix):
job_spec["spaceId"] = image[len(prefix) :]
break
else:
job_spec["dockerImage"] = image
return job_spec
|