Spaces:
Running on CPU Upgrade
Running on CPU Upgrade
File size: 32,308 Bytes
2ca459e 160da13 2ca459e 927e50a 2ca459e a6dcda8 2ca459e 9934918 b307ff7 160da13 b307ff7 160da13 b307ff7 160da13 b307ff7 160da13 2ca459e b63e2df 2ca459e 160da13 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e 9934918 2ca459e 9934918 2ca459e b63e2df 2ca459e ff2fb51 2ca459e b63e2df 2ca459e b63e2df ff2fb51 b63e2df ff2fb51 b63e2df ff2fb51 b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e 1598bb4 9934918 b63e2df 2ca459e b63e2df 2ca459e 9934918 b63e2df 927e50a ff2fb51 b63e2df ff2fb51 b63e2df ff2fb51 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e 1598bb4 9934918 b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e b63e2df 2ca459e 1598bb4 a6dcda8 1598bb4 a6dcda8 1598bb4 b307ff7 1598bb4 b7b2c0c 2ca459e b63e2df 2ca459e b63e2df 1598bb4 b63e2df 1598bb4 b63e2df 1598bb4 b63e2df 1598bb4 b63e2df a6dcda8 1598bb4 b63e2df b307ff7 2ca459e b307ff7 b63e2df 1598bb4 b63e2df 1598bb4 b63e2df 1598bb4 2ca459e b63e2df 2ca459e 9934918 2ca459e | 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 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 | """
Hugging Face Jobs Tool - Using huggingface-hub library
Refactored to use official huggingface-hub library instead of custom HTTP client
"""
import asyncio
import base64
import os
from typing import Any, Dict, Literal, Optional
from huggingface_hub import HfApi
from huggingface_hub.utils import HfHubHTTPError
from agent.tools.types import ToolResult
from agent.tools.utilities import (
format_job_details,
format_jobs_table,
format_scheduled_job_details,
format_scheduled_jobs_table,
)
# Hardware flavors
CPU_FLAVORS = ["cpu-basic", "cpu-upgrade", "cpu-performance", "cpu-xl"]
GPU_FLAVORS = [
"sprx8",
"zero-a10g",
"t4-small",
"t4-medium",
"l4x1",
"l4x4",
"l40sx1",
"l40sx4",
"l40sx8",
"a10g-small",
"a10g-large",
"a10g-largex2",
"a10g-largex4",
"a100-large",
"h100",
"h100x8",
]
# Detailed specs for display (vCPU/RAM/GPU VRAM)
CPU_FLAVORS_DESC = (
"cpu-basic(2vCPU/16GB), cpu-upgrade(8vCPU/32GB), cpu-performance, cpu-xl"
)
GPU_FLAVORS_DESC = (
"t4-small(4vCPU/15GB/GPU 16GB), t4-medium(8vCPU/30GB/GPU 16GB), "
"l4x1(8vCPU/30GB/GPU 24GB), l4x4(48vCPU/186GB/GPU 96GB), "
"l40sx1(8vCPU/62GB/GPU 48GB), l40sx4(48vCPU/382GB/GPU 192GB), l40sx8(192vCPU/1534GB/GPU 384GB), "
"a10g-small(4vCPU/14GB/GPU 24GB), a10g-large(12vCPU/46GB/GPU 24GB), "
"a10g-largex2(24vCPU/92GB/GPU 48GB), a10g-largex4(48vCPU/184GB/GPU 96GB), "
"a100-large(12vCPU/142GB/GPU 80GB), h100(23vCPU/240GB/GPU 80GB), h100x8(184vCPU/1920GB/GPU 640GB), "
"zero-a10g(dynamic alloc)"
)
SPECIALIZED_FLAVORS = ["inf2x6"]
ALL_FLAVORS = CPU_FLAVORS + GPU_FLAVORS + SPECIALIZED_FLAVORS
# Operation names
OperationType = Literal[
"run",
"ps",
"logs",
"inspect",
"cancel",
"scheduled run",
"scheduled ps",
"scheduled inspect",
"scheduled delete",
"scheduled suspend",
"scheduled resume",
]
# Constants
UV_DEFAULT_IMAGE = "ghcr.io/astral-sh/uv:python3.12-bookworm"
def _add_environment_variables(params: Dict[str, Any] | None) -> Dict[str, Any]:
token = os.environ.get("HF_TOKEN") or os.environ.get("HUGGINGFACE_HUB_TOKEN") or ""
# Start with user-provided env vars, then force-set token last
result = dict(params or {})
# If the caller passed HF_TOKEN="$HF_TOKEN", ignore it.
if result.get("HF_TOKEN", "").strip().startswith("$"):
result.pop("HF_TOKEN", None)
# Set both names to be safe (different libs check different vars)
if token:
result["HF_TOKEN"] = token
result["HUGGINGFACE_HUB_TOKEN"] = token
return result
def _build_uv_command(
script: str,
with_deps: list[str] | None = None,
python: str | None = None,
script_args: list[str] | None = None,
) -> list[str]:
"""Build UV run command"""
parts = ["uv", "run"]
if with_deps:
for dep in with_deps:
parts.extend(["--with", dep])
if python:
parts.extend(["-p", python])
parts.append(script)
if script_args:
parts.extend(script_args)
# add defaults
# parts.extend(["--push_to_hub"])
return parts
def _wrap_inline_script(
script: str,
with_deps: list[str] | None = None,
python: str | None = None,
script_args: list[str] | None = None,
) -> str:
"""Wrap inline script with base64 encoding to avoid file creation"""
encoded = base64.b64encode(script.encode("utf-8")).decode("utf-8")
# Build the uv command with stdin (-)
uv_command = _build_uv_command("-", with_deps, python, script_args)
# Join command parts with proper spacing
uv_command_str = " ".join(uv_command)
return f'echo "{encoded}" | base64 -d | {uv_command_str}'
def _ensure_hf_transfer_dependency(deps: list[str] | None) -> list[str]:
"""Ensure hf-transfer is included in the dependencies list"""
if isinstance(deps, list):
deps_copy = deps.copy() # Don't modify the original
if "hf-transfer" not in deps_copy:
deps_copy.append("hf-transfer")
return deps_copy
return ["hf-transfer"]
def _resolve_uv_command(
script: str,
with_deps: list[str] | None = None,
python: str | None = None,
script_args: list[str] | None = None,
) -> list[str]:
"""Resolve UV command based on script source (URL, inline, or file path)"""
# If URL, use directly
if script.startswith("http://") or script.startswith("https://"):
return _build_uv_command(script, with_deps, python, script_args)
# If contains newline, treat as inline script
if "\n" in script:
wrapped = _wrap_inline_script(script, with_deps, python, script_args)
return ["/bin/sh", "-lc", wrapped]
# Otherwise, treat as file path
return _build_uv_command(script, with_deps, python, script_args)
async def _async_call(func, *args, **kwargs):
"""Wrap synchronous HfApi calls for async context"""
return await asyncio.to_thread(func, *args, **kwargs)
def _job_info_to_dict(job_info) -> Dict[str, Any]:
"""Convert JobInfo object to dictionary for formatting functions"""
return {
"id": job_info.id,
"status": {"stage": job_info.status.stage, "message": job_info.status.message},
"command": job_info.command,
"createdAt": job_info.created_at.isoformat(),
"dockerImage": job_info.docker_image,
"spaceId": job_info.space_id,
"hardware_flavor": job_info.flavor,
"owner": {"name": job_info.owner.name},
}
def _scheduled_job_info_to_dict(scheduled_job_info) -> Dict[str, Any]:
"""Convert ScheduledJobInfo object to dictionary for formatting functions"""
job_spec = scheduled_job_info.job_spec
# Extract last run and next run from status
last_run = None
next_run = None
if scheduled_job_info.status:
if scheduled_job_info.status.last_job:
last_run = scheduled_job_info.status.last_job.created_at
if last_run:
last_run = (
last_run.isoformat()
if hasattr(last_run, "isoformat")
else str(last_run)
)
if scheduled_job_info.status.next_job_run_at:
next_run = scheduled_job_info.status.next_job_run_at
next_run = (
next_run.isoformat()
if hasattr(next_run, "isoformat")
else str(next_run)
)
return {
"id": scheduled_job_info.id,
"schedule": scheduled_job_info.schedule,
"suspend": scheduled_job_info.suspend,
"lastRun": last_run,
"nextRun": next_run,
"jobSpec": {
"dockerImage": job_spec.docker_image,
"spaceId": job_spec.space_id,
"command": job_spec.command or [],
"hardware_flavor": job_spec.flavor or "cpu-basic",
},
}
class HfJobsTool:
"""Tool for managing Hugging Face compute jobs using huggingface-hub library"""
def __init__(self, hf_token: Optional[str] = None, namespace: Optional[str] = None):
self.api = HfApi(token=hf_token)
self.namespace = namespace
async def execute(self, params: Dict[str, Any]) -> ToolResult:
"""Execute the specified operation"""
operation = params.get("operation")
args = params
# If no operation provided, return error
if not operation:
return {
"formatted": "Error: 'operation' parameter is required. See tool description for available operations and usage examples.",
"totalResults": 0,
"resultsShared": 0,
"isError": True,
}
# Normalize operation name
operation = operation.lower()
try:
# Route to appropriate handler
if operation == "run":
return await self._run_job(args)
elif operation == "ps":
return await self._list_jobs(args)
elif operation == "logs":
return await self._get_logs(args)
elif operation == "inspect":
return await self._inspect_job(args)
elif operation == "cancel":
return await self._cancel_job(args)
elif operation == "scheduled run":
return await self._scheduled_run(args)
elif operation == "scheduled ps":
return await self._list_scheduled_jobs(args)
elif operation == "scheduled inspect":
return await self._inspect_scheduled_job(args)
elif operation == "scheduled delete":
return await self._delete_scheduled_job(args)
elif operation == "scheduled suspend":
return await self._suspend_scheduled_job(args)
elif operation == "scheduled resume":
return await self._resume_scheduled_job(args)
else:
return {
"formatted": f'Unknown operation: "{operation}"\n\n'
"Available operations:\n"
"- run, ps, logs, inspect, cancel\n"
"- scheduled run, scheduled ps, scheduled inspect, "
"scheduled delete, scheduled suspend, scheduled resume\n\n"
"Call this tool with no operation for full usage instructions.",
"totalResults": 0,
"resultsShared": 0,
"isError": True,
}
except HfHubHTTPError as e:
return {
"formatted": f"API Error: {str(e)}",
"totalResults": 0,
"resultsShared": 0,
"isError": True,
}
except Exception as e:
return {
"formatted": f"Error executing {operation}: {str(e)}",
"totalResults": 0,
"resultsShared": 0,
"isError": True,
}
async def _wait_for_job_completion(
self, job_id: str, namespace: Optional[str] = None
) -> tuple[str, list[str]]:
"""
Stream job logs until completion, printing them in real-time.
Returns:
tuple: (final_status, all_logs)
"""
all_logs = []
# Fetch logs - generator streams logs as they arrive and ends when job completes
logs_gen = self.api.fetch_job_logs(job_id=job_id, namespace=namespace)
# Stream logs in real-time
for log_line in logs_gen:
print("\t" + log_line)
all_logs.append(log_line)
# After logs complete, fetch final job status
job_info = await _async_call(
self.api.inspect_job, job_id=job_id, namespace=namespace
)
final_status = job_info.status.stage
return final_status, all_logs
async def _run_job(self, args: Dict[str, Any]) -> ToolResult:
"""Run a job using HfApi.run_job() - smart detection of Python vs Docker mode"""
try:
script = args.get("script")
command = args.get("command")
# Validate mutually exclusive parameters
if script and command:
raise ValueError(
"'script' and 'command' are mutually exclusive. Provide one or the other, not both."
)
if not script and not command:
raise ValueError(
"Either 'script' (for Python) or 'command' (for Docker) must be provided."
)
# Python mode: script provided
if script:
# Get dependencies and ensure hf-transfer is included
deps = _ensure_hf_transfer_dependency(args.get("dependencies"))
# Resolve the command based on script type (URL, inline, or file)
command = _resolve_uv_command(
script=script,
with_deps=deps,
python=args.get("python"),
script_args=args.get("script_args"),
)
# Use UV image unless overridden
image = args.get("image", UV_DEFAULT_IMAGE)
job_type = "Python"
# Docker mode: command provided
else:
image = args.get("image", "python:3.12")
job_type = "Docker"
# Run the job
job = await _async_call(
self.api.run_job,
image=image,
command=command,
env=args.get("env"),
secrets=_add_environment_variables(args.get("secrets")),
flavor=args.get("hardware_flavor", "cpu-basic"),
timeout=args.get("timeout", "30m"),
namespace=self.namespace,
)
# Wait for completion and stream logs
print(f"{job_type} job started: {job.url}")
print("Streaming logs...\n---\n")
final_status, all_logs = await self._wait_for_job_completion(
job_id=job.id,
namespace=self.namespace,
)
# Format all logs for the agent
log_text = "\n".join(all_logs) if all_logs else "(no logs)"
response = f"""{job_type} job completed!
**Job ID:** {job.id}
**Final Status:** {final_status}
**View at:** {job.url}
**Logs:**
```
{log_text}
```"""
return {"formatted": response, "totalResults": 1, "resultsShared": 1}
except Exception as e:
raise Exception(f"Failed to run job: {str(e)}")
async def _list_jobs(self, args: Dict[str, Any]) -> ToolResult:
"""List jobs using HfApi.list_jobs()"""
jobs_list = await _async_call(self.api.list_jobs, namespace=self.namespace)
# Filter jobs
if not args.get("all", False):
jobs_list = [j for j in jobs_list if j.status.stage == "RUNNING"]
if args.get("status"):
status_filter = args["status"].upper()
jobs_list = [j for j in jobs_list if status_filter in j.status.stage]
# Convert JobInfo objects to dicts for formatting
jobs_dicts = [_job_info_to_dict(j) for j in jobs_list]
table = format_jobs_table(jobs_dicts)
if len(jobs_list) == 0:
if args.get("all", False):
return {
"formatted": "No jobs found.",
"totalResults": 0,
"resultsShared": 0,
}
return {
"formatted": 'No running jobs found. Use `{"operation": "ps", "all": true}` to show all jobs.',
"totalResults": 0,
"resultsShared": 0,
}
response = f"**Jobs ({len(jobs_list)} total):**\n\n{table}"
return {
"formatted": response,
"totalResults": len(jobs_list),
"resultsShared": len(jobs_list),
}
async def _get_logs(self, args: Dict[str, Any]) -> ToolResult:
"""Fetch logs using HfApi.fetch_job_logs()"""
job_id = args.get("job_id")
if not job_id:
return {
"formatted": "job_id is required",
"isError": True,
"totalResults": 0,
"resultsShared": 0,
}
try:
# Fetch logs (returns generator, convert to list)
logs_gen = self.api.fetch_job_logs(job_id=job_id, namespace=self.namespace)
logs = await _async_call(list, logs_gen)
if not logs:
return {
"formatted": f"No logs available for job {job_id}",
"totalResults": 0,
"resultsShared": 0,
}
log_text = "\n".join(logs)
return {
"formatted": f"**Logs for {job_id}:**\n\n```\n{log_text}\n```",
"totalResults": 1,
"resultsShared": 1,
}
except Exception as e:
return {
"formatted": f"Failed to fetch logs: {str(e)}",
"isError": True,
"totalResults": 0,
"resultsShared": 0,
}
async def _inspect_job(self, args: Dict[str, Any]) -> ToolResult:
"""Inspect job using HfApi.inspect_job()"""
job_id = args.get("job_id")
if not job_id:
return {
"formatted": "job_id is required",
"totalResults": 0,
"resultsShared": 0,
"isError": True,
}
job_ids = job_id if isinstance(job_id, list) else [job_id]
jobs = []
for jid in job_ids:
try:
job = await _async_call(
self.api.inspect_job,
job_id=jid,
namespace=self.namespace,
)
jobs.append(_job_info_to_dict(job))
except Exception as e:
raise Exception(f"Failed to inspect job {jid}: {str(e)}")
formatted_details = format_job_details(jobs)
response = f"**Job Details** ({len(jobs)} job{'s' if len(jobs) > 1 else ''}):\n\n{formatted_details}"
return {
"formatted": response,
"totalResults": len(jobs),
"resultsShared": len(jobs),
}
async def _cancel_job(self, args: Dict[str, Any]) -> ToolResult:
"""Cancel job using HfApi.cancel_job()"""
job_id = args.get("job_id")
if not job_id:
return {
"formatted": "job_id is required",
"totalResults": 0,
"resultsShared": 0,
"isError": True,
}
await _async_call(
self.api.cancel_job,
job_id=job_id,
namespace=self.namespace,
)
response = f"""β Job {job_id} has been cancelled.
To verify, call this tool with `{{"operation": "inspect", "job_id": "{job_id}"}}`"""
return {"formatted": response, "totalResults": 1, "resultsShared": 1}
async def _scheduled_run(self, args: Dict[str, Any]) -> ToolResult:
"""Create scheduled job using HfApi.create_scheduled_job() - smart detection of Python vs Docker mode"""
try:
script = args.get("script")
command = args.get("command")
schedule = args.get("schedule")
if not schedule:
raise ValueError("schedule is required for scheduled jobs")
# Validate mutually exclusive parameters
if script and command:
raise ValueError(
"'script' and 'command' are mutually exclusive. Provide one or the other, not both."
)
if not script and not command:
raise ValueError(
"Either 'script' (for Python) or 'command' (for Docker) must be provided."
)
# Python mode: script provided
if script:
# Get dependencies and ensure hf-transfer is included
deps = _ensure_hf_transfer_dependency(args.get("dependencies"))
# Resolve the command based on script type
command = _resolve_uv_command(
script=script,
with_deps=deps,
python=args.get("python"),
script_args=args.get("script_args"),
)
# Use UV image unless overridden
image = args.get("image", UV_DEFAULT_IMAGE)
job_type = "Python"
# Docker mode: command provided
else:
image = args.get("image", "python:3.12")
job_type = "Docker"
# Create scheduled job
scheduled_job = await _async_call(
self.api.create_scheduled_job,
image=image,
command=command,
schedule=schedule,
env=args.get("env"),
secrets=_add_environment_variables(args.get("secrets")),
flavor=args.get("hardware_flavor", "cpu-basic"),
timeout=args.get("timeout", "30m"),
namespace=self.namespace,
)
scheduled_dict = _scheduled_job_info_to_dict(scheduled_job)
response = f"""β Scheduled {job_type} job created successfully!
**Scheduled Job ID:** {scheduled_dict["id"]}
**Schedule:** {scheduled_dict["schedule"]}
**Suspended:** {"Yes" if scheduled_dict.get("suspend") else "No"}
**Next Run:** {scheduled_dict.get("nextRun", "N/A")}
To inspect, call this tool with `{{"operation": "scheduled inspect", "scheduled_job_id": "{scheduled_dict["id"]}"}}`
To list all, call this tool with `{{"operation": "scheduled ps"}}`"""
return {"formatted": response, "totalResults": 1, "resultsShared": 1}
except Exception as e:
raise Exception(f"Failed to create scheduled job: {str(e)}")
async def _list_scheduled_jobs(self, args: Dict[str, Any]) -> ToolResult:
"""List scheduled jobs using HfApi.list_scheduled_jobs()"""
scheduled_jobs_list = await _async_call(
self.api.list_scheduled_jobs,
namespace=self.namespace,
)
# Filter jobs - default: hide suspended jobs unless --all is specified
if not args.get("all", False):
scheduled_jobs_list = [j for j in scheduled_jobs_list if not j.suspend]
# Convert to dicts for formatting
scheduled_dicts = [_scheduled_job_info_to_dict(j) for j in scheduled_jobs_list]
table = format_scheduled_jobs_table(scheduled_dicts)
if len(scheduled_jobs_list) == 0:
if args.get("all", False):
return {
"formatted": "No scheduled jobs found.",
"totalResults": 0,
"resultsShared": 0,
}
return {
"formatted": 'No active scheduled jobs found. Use `{"operation": "scheduled ps", "all": true}` to show suspended jobs.',
"totalResults": 0,
"resultsShared": 0,
}
response = f"**Scheduled Jobs ({len(scheduled_jobs_list)} total):**\n\n{table}"
return {
"formatted": response,
"totalResults": len(scheduled_jobs_list),
"resultsShared": len(scheduled_jobs_list),
}
async def _inspect_scheduled_job(self, args: Dict[str, Any]) -> ToolResult:
"""Inspect scheduled job using HfApi.inspect_scheduled_job()"""
scheduled_job_id = args.get("scheduled_job_id")
if not scheduled_job_id:
return {
"formatted": "scheduled_job_id is required",
"totalResults": 0,
"resultsShared": 0,
"isError": True,
}
scheduled_job = await _async_call(
self.api.inspect_scheduled_job,
scheduled_job_id=scheduled_job_id,
namespace=self.namespace,
)
scheduled_dict = _scheduled_job_info_to_dict(scheduled_job)
formatted_details = format_scheduled_job_details(scheduled_dict)
return {
"formatted": f"**Scheduled Job Details:**\n\n{formatted_details}",
"totalResults": 1,
"resultsShared": 1,
}
async def _delete_scheduled_job(self, args: Dict[str, Any]) -> ToolResult:
"""Delete scheduled job using HfApi.delete_scheduled_job()"""
scheduled_job_id = args.get("scheduled_job_id")
if not scheduled_job_id:
return {
"formatted": "scheduled_job_id is required",
"totalResults": 0,
"resultsShared": 0,
"isError": True,
}
await _async_call(
self.api.delete_scheduled_job,
scheduled_job_id=scheduled_job_id,
namespace=self.namespace,
)
return {
"formatted": f"β Scheduled job {scheduled_job_id} has been deleted.",
"totalResults": 1,
"resultsShared": 1,
}
async def _suspend_scheduled_job(self, args: Dict[str, Any]) -> ToolResult:
"""Suspend scheduled job using HfApi.suspend_scheduled_job()"""
scheduled_job_id = args.get("scheduled_job_id")
if not scheduled_job_id:
return {
"formatted": "scheduled_job_id is required",
"totalResults": 0,
"resultsShared": 0,
"isError": True,
}
await _async_call(
self.api.suspend_scheduled_job,
scheduled_job_id=scheduled_job_id,
namespace=self.namespace,
)
response = f"""β Scheduled job {scheduled_job_id} has been suspended.
To resume, call this tool with `{{"operation": "scheduled resume", "scheduled_job_id": "{scheduled_job_id}"}}`"""
return {"formatted": response, "totalResults": 1, "resultsShared": 1}
async def _resume_scheduled_job(self, args: Dict[str, Any]) -> ToolResult:
"""Resume scheduled job using HfApi.resume_scheduled_job()"""
scheduled_job_id = args.get("scheduled_job_id")
if not scheduled_job_id:
return {
"formatted": "scheduled_job_id is required",
"totalResults": 0,
"resultsShared": 0,
"isError": True,
}
await _async_call(
self.api.resume_scheduled_job,
scheduled_job_id=scheduled_job_id,
namespace=self.namespace,
)
response = f"""β Scheduled job {scheduled_job_id} has been resumed.
To inspect, call this tool with `{{"operation": "scheduled inspect", "scheduled_job_id": "{scheduled_job_id}"}}`"""
return {"formatted": response, "totalResults": 1, "resultsShared": 1}
# Tool specification for agent registration
HF_JOBS_TOOL_SPEC = {
"name": "hf_jobs",
"description": (
"Run Python scripts or Docker containers on HF cloud GPUs/CPUs.\n\n"
"## Operations:\n"
"run, ps, logs, inspect, cancel, scheduled run, scheduled ps, scheduled inspect, scheduled delete, scheduled suspend, scheduled resume\n\n"
"## Two modes:\n"
"1. **Python mode:** Provide 'script' + 'dependencies' β auto-handles pip install\n"
"2. **Docker mode:** Provide 'image' + 'command' β full control\n"
"(script and command are mutually exclusive)\n\n"
"## Available Hardware (vCPU/RAM/GPU):\n"
f"CPU: {CPU_FLAVORS_DESC}\n"
f"GPU: {GPU_FLAVORS_DESC}\n"
"## Examples:\n\n"
"**Fine-tune LLM and push to Hub:**\n"
"{'operation': 'run', 'script': 'from transformers import AutoModelForCausalLM, AutoTokenizer, Trainer\\nmodel = AutoModelForCausalLM.from_pretrained(\"Qwen/Qwen3-4B-Thinking-2507\")\\n# ... training code ...\\nmodel.push_to_hub(\"user-name/my-finetuned-model\")', 'dependencies': ['transformers', 'torch', 'datasets'], 'hardware_flavor': 'a10g-large', 'timeout': '4h', 'env': {'CUSTOM_VAR': 'value'}}\n\n"
"**Generate dataset daily and upload:**\n"
"{'operation': 'scheduled run', 'script': 'from datasets import Dataset\\nimport pandas as pd\\n# scrape/generate data\\ndf = pd.DataFrame(data)\\nds = Dataset.from_pandas(df)\\nds.push_to_hub(\"user-name/daily-dataset\")', 'dependencies': ['datasets', 'pandas'], 'schedule': '@daily'}\n\n"
"**Run custom training with Docker:**\n"
"{'operation': 'run', 'image': 'pytorch/pytorch:2.0.0-cuda11.7-cudnn8-runtime', 'command': ['python', 'train.py', '--epochs', '10'], 'hardware_flavor': 'a100-large'}\n\n"
"**Monitor jobs:**\n"
"{'operation': 'ps'} - list running\n"
"{'operation': 'logs', 'job_id': 'xxx'} - stream logs\n"
"{'operation': 'cancel', 'job_id': 'xxx'} - stop job\n\n"
"## CRITICAL: Files are ephemeral!\n"
"Everything created during execution is DELETED when job finishes. Always .push_to_hub() your outputs (models, datasets, artifacts) in the script.\n\n"
"## After job completion:\n"
"If needed or asked by the user, use hf_private_repos tool to store scripts/logs/results to Hub for persistent storage."
),
"parameters": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"run",
"ps",
"logs",
"inspect",
"cancel",
"scheduled run",
"scheduled ps",
"scheduled inspect",
"scheduled delete",
"scheduled suspend",
"scheduled resume",
],
"description": (
"Operation to execute. Valid values: [run, ps, logs, inspect, cancel, "
"scheduled run, scheduled ps, scheduled inspect, scheduled delete, "
"scheduled suspend, scheduled resume]"
),
},
# Python/UV specific parameters
"script": {
"type": "string",
"description": "Python code to execute. Triggers Python mode (auto pip install). Use with 'run'/'scheduled run'. Mutually exclusive with 'command'.",
},
"dependencies": {
"type": "array",
"items": {"type": "string"},
"description": "Pip packages to install. Example: ['trl', 'torch', 'datasets', 'transformers']. Only used with 'script'.",
},
# Docker specific parameters
"image": {
"type": "string",
"description": "Docker image. Example: 'pytorch/pytorch:2.0.0-cuda11.7-cudnn8-runtime'. Use with 'run'/'scheduled run'. Optional (auto-selected if not provided).",
},
"command": {
"type": "array",
"items": {"type": "string"},
"description": "Command to execute as list. Example: ['python', 'train.py', '--epochs', '10']. Triggers Docker mode. Use with 'run'/'scheduled run'. Mutually exclusive with 'script'.",
},
# Hardware and environment
"hardware_flavor": {
"type": "string",
"description": f"Hardware type. Available CPU flavors: {CPU_FLAVORS}. Available GPU flavors: {GPU_FLAVORS}. Use with 'run'/'scheduled run'.",
},
"timeout": {
"type": "string",
"description": "Max runtime. Examples: '30m', '2h', '4h'. Default: '30m'. Important for long training jobs. Use with 'run'/'scheduled run'.",
},
"env": {
"type": "object",
"description": "Environment variables. Format: {'KEY': 'VALUE'}. HF_TOKEN is automatically included from your auth. Use with 'run'/'scheduled run'.",
},
# Job management parameters
"job_id": {
"type": "string",
"description": "Job ID to operate on. Required for: 'logs', 'inspect', 'cancel'.",
},
# Scheduled job parameters
"scheduled_job_id": {
"type": "string",
"description": "Scheduled job ID. Required for: 'scheduled inspect', 'scheduled delete', 'scheduled suspend', 'scheduled resume'.",
},
"schedule": {
"type": "string",
"description": "Schedule for recurring job. Presets: '@hourly', '@daily', '@weekly', '@monthly'. Cron: '0 9 * * 1' (Mon 9am). Required for: 'scheduled run'.",
},
},
"required": ["operation"],
},
}
async def hf_jobs_handler(arguments: Dict[str, Any]) -> tuple[str, bool]:
"""Handler for agent tool router"""
try:
tool = HfJobsTool(namespace=os.environ.get("HF_NAMESPACE", ""))
result = await tool.execute(arguments)
return result["formatted"], not result.get("isError", False)
except Exception as e:
return f"Error executing HF Jobs tool: {str(e)}", False
|