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