Spaces:
Running
Running
File size: 44,317 Bytes
3bb804c |
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 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 |
# Copyright 2025 The HuggingFace Team. All rights reserved.
#
# 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.
"""Contains commands to interact with jobs on the Hugging Face Hub.
Usage:
# run a job
hf jobs run <image> <command>
# List running or completed jobs
hf jobs ps [-a] [-f key=value] [--format TEMPLATE]
# Stream logs from a job
hf jobs logs <job-id>
# Inspect detailed information about a job
hf jobs inspect <job-id>
# Cancel a running job
hf jobs cancel <job-id>
"""
import json
import os
import re
from argparse import Namespace, _SubParsersAction
from dataclasses import asdict
from pathlib import Path
from typing import Dict, List, Optional, Union
import requests
from huggingface_hub import HfApi, SpaceHardware, get_token
from huggingface_hub.utils import logging
from huggingface_hub.utils._dotenv import load_dotenv
from . import BaseHuggingfaceCLICommand
logger = logging.get_logger(__name__)
SUGGESTED_FLAVORS = [item.value for item in SpaceHardware if item.value != "zero-a10g"]
class JobsCommands(BaseHuggingfaceCLICommand):
@staticmethod
def register_subcommand(parser: _SubParsersAction):
jobs_parser = parser.add_parser("jobs", help="Run and manage Jobs on the Hub.")
jobs_subparsers = jobs_parser.add_subparsers(help="huggingface.co jobs related commands")
# Show help if no subcommand is provided
jobs_parser.set_defaults(func=lambda args: jobs_parser.print_help())
# Register commands
InspectCommand.register_subcommand(jobs_subparsers)
LogsCommand.register_subcommand(jobs_subparsers)
PsCommand.register_subcommand(jobs_subparsers)
RunCommand.register_subcommand(jobs_subparsers)
CancelCommand.register_subcommand(jobs_subparsers)
UvCommand.register_subcommand(jobs_subparsers)
ScheduledJobsCommands.register_subcommand(jobs_subparsers)
class RunCommand(BaseHuggingfaceCLICommand):
@staticmethod
def register_subcommand(parser: _SubParsersAction) -> None:
run_parser = parser.add_parser("run", help="Run a Job")
run_parser.add_argument("image", type=str, help="The Docker image to use.")
run_parser.add_argument("-e", "--env", action="append", help="Set environment variables. E.g. --env ENV=value")
run_parser.add_argument(
"-s",
"--secrets",
action="append",
help=(
"Set secret environment variables. E.g. --secrets SECRET=value "
"or `--secrets HF_TOKEN` to pass your Hugging Face token."
),
)
run_parser.add_argument("--env-file", type=str, help="Read in a file of environment variables.")
run_parser.add_argument("--secrets-file", type=str, help="Read in a file of secret environment variables.")
run_parser.add_argument(
"--flavor",
type=str,
help=f"Flavor for the hardware, as in HF Spaces. Defaults to `cpu-basic`. Possible values: {', '.join(SUGGESTED_FLAVORS)}.",
)
run_parser.add_argument(
"--timeout",
type=str,
help="Max duration: int/float with s (seconds, default), m (minutes), h (hours) or d (days).",
)
run_parser.add_argument(
"-d",
"--detach",
action="store_true",
help="Run the Job in the background and print the Job ID.",
)
run_parser.add_argument(
"--namespace",
type=str,
help="The namespace where the Job will be created. Defaults to the current user's namespace.",
)
run_parser.add_argument(
"--token",
type=str,
help="A User Access Token generated from https://huggingface.co/settings/tokens",
)
run_parser.add_argument("command", nargs="...", help="The command to run.")
run_parser.set_defaults(func=RunCommand)
def __init__(self, args: Namespace) -> None:
self.image: str = args.image
self.command: List[str] = args.command
self.env: dict[str, Optional[str]] = {}
if args.env_file:
self.env.update(load_dotenv(Path(args.env_file).read_text(), environ=os.environ.copy()))
for env_value in args.env or []:
self.env.update(load_dotenv(env_value, environ=os.environ.copy()))
self.secrets: dict[str, Optional[str]] = {}
extended_environ = _get_extended_environ()
if args.secrets_file:
self.secrets.update(load_dotenv(Path(args.secrets_file).read_text(), environ=extended_environ))
for secret in args.secrets or []:
self.secrets.update(load_dotenv(secret, environ=extended_environ))
self.flavor: Optional[SpaceHardware] = args.flavor
self.timeout: Optional[str] = args.timeout
self.detach: bool = args.detach
self.namespace: Optional[str] = args.namespace
self.token: Optional[str] = args.token
def run(self) -> None:
api = HfApi(token=self.token)
job = api.run_job(
image=self.image,
command=self.command,
env=self.env,
secrets=self.secrets,
flavor=self.flavor,
timeout=self.timeout,
namespace=self.namespace,
)
# Always print the job ID to the user
print(f"Job started with ID: {job.id}")
print(f"View at: {job.url}")
if self.detach:
return
# Now let's stream the logs
for log in api.fetch_job_logs(job_id=job.id):
print(log)
class LogsCommand(BaseHuggingfaceCLICommand):
@staticmethod
def register_subcommand(parser: _SubParsersAction) -> None:
run_parser = parser.add_parser("logs", help="Fetch the logs of a Job")
run_parser.add_argument("job_id", type=str, help="Job ID")
run_parser.add_argument(
"--namespace",
type=str,
help="The namespace where the job is running. Defaults to the current user's namespace.",
)
run_parser.add_argument(
"--token", type=str, help="A User Access Token generated from https://huggingface.co/settings/tokens"
)
run_parser.set_defaults(func=LogsCommand)
def __init__(self, args: Namespace) -> None:
self.job_id: str = args.job_id
self.namespace: Optional[str] = args.namespace
self.token: Optional[str] = args.token
def run(self) -> None:
api = HfApi(token=self.token)
for log in api.fetch_job_logs(job_id=self.job_id, namespace=self.namespace):
print(log)
def _tabulate(rows: List[List[Union[str, int]]], headers: List[str]) -> str:
"""
Inspired by:
- stackoverflow.com/a/8356620/593036
- stackoverflow.com/questions/9535954/printing-lists-as-tabular-data
"""
col_widths = [max(len(str(x)) for x in col) for col in zip(*rows, headers)]
terminal_width = max(os.get_terminal_size().columns, len(headers) * 12)
while len(headers) + sum(col_widths) > terminal_width:
col_to_minimize = col_widths.index(max(col_widths))
col_widths[col_to_minimize] //= 2
if len(headers) + sum(col_widths) <= terminal_width:
col_widths[col_to_minimize] = terminal_width - sum(col_widths) - len(headers) + col_widths[col_to_minimize]
row_format = ("{{:{}}} " * len(headers)).format(*col_widths)
lines = []
lines.append(row_format.format(*headers))
lines.append(row_format.format(*["-" * w for w in col_widths]))
for row in rows:
row_format_args = [
str(x)[: col_width - 3] + "..." if len(str(x)) > col_width else str(x)
for x, col_width in zip(row, col_widths)
]
lines.append(row_format.format(*row_format_args))
return "\n".join(lines)
class PsCommand(BaseHuggingfaceCLICommand):
@staticmethod
def register_subcommand(parser: _SubParsersAction) -> None:
run_parser = parser.add_parser("ps", help="List Jobs")
run_parser.add_argument(
"-a",
"--all",
action="store_true",
help="Show all Jobs (default shows just running)",
)
run_parser.add_argument(
"--namespace",
type=str,
help="The namespace from where it lists the jobs. Defaults to the current user's namespace.",
)
run_parser.add_argument(
"--token",
type=str,
help="A User Access Token generated from https://huggingface.co/settings/tokens",
)
# Add Docker-style filtering argument
run_parser.add_argument(
"-f",
"--filter",
action="append",
default=[],
help="Filter output based on conditions provided (format: key=value)",
)
# Add option to format output
run_parser.add_argument(
"--format",
type=str,
help="Format output using a custom template",
)
run_parser.set_defaults(func=PsCommand)
def __init__(self, args: Namespace) -> None:
self.all: bool = args.all
self.namespace: Optional[str] = args.namespace
self.token: Optional[str] = args.token
self.format: Optional[str] = args.format
self.filters: Dict[str, str] = {}
# Parse filter arguments (key=value pairs)
for f in args.filter:
if "=" in f:
key, value = f.split("=", 1)
self.filters[key.lower()] = value
else:
print(f"Warning: Ignoring invalid filter format '{f}'. Use key=value format.")
def run(self) -> None:
"""
Fetch and display job information for the current user.
Uses Docker-style filtering with -f/--filter flag and key=value pairs.
"""
try:
api = HfApi(token=self.token)
# Fetch jobs data
jobs = api.list_jobs(namespace=self.namespace)
# Define table headers
table_headers = ["JOB ID", "IMAGE/SPACE", "COMMAND", "CREATED", "STATUS"]
# Process jobs data
rows = []
for job in jobs:
# Extract job data for filtering
status = job.status.stage if job.status else "UNKNOWN"
# Skip job if not all jobs should be shown and status doesn't match criteria
if not self.all and status not in ("RUNNING", "UPDATING"):
continue
# Extract job ID
job_id = job.id
# Extract image or space information
image_or_space = job.docker_image or "N/A"
# Extract and format command
command = job.command or []
command_str = " ".join(command) if command else "N/A"
# Extract creation time
created_at = job.created_at.strftime("%Y-%m-%d %H:%M:%S") if job.created_at else "N/A"
# Create a dict with all job properties for filtering
job_properties = {
"id": job_id,
"image": image_or_space,
"status": status.lower(),
"command": command_str,
}
# Check if job matches all filters
if not self._matches_filters(job_properties):
continue
# Create row
rows.append([job_id, image_or_space, command_str, created_at, status])
# Handle empty results
if not rows:
filters_msg = ""
if self.filters:
filters_msg = f" matching filters: {', '.join([f'{k}={v}' for k, v in self.filters.items()])}"
print(f"No jobs found{filters_msg}")
return
# Apply custom format if provided or use default tabular format
self._print_output(rows, table_headers)
except requests.RequestException as e:
print(f"Error fetching jobs data: {e}")
except (KeyError, ValueError, TypeError) as e:
print(f"Error processing jobs data: {e}")
except Exception as e:
print(f"Unexpected error - {type(e).__name__}: {e}")
def _matches_filters(self, job_properties: Dict[str, str]) -> bool:
"""Check if job matches all specified filters."""
for key, pattern in self.filters.items():
# Check if property exists
if key not in job_properties:
return False
# Support pattern matching with wildcards
if "*" in pattern or "?" in pattern:
# Convert glob pattern to regex
regex_pattern = pattern.replace("*", ".*").replace("?", ".")
if not re.search(f"^{regex_pattern}$", job_properties[key], re.IGNORECASE):
return False
# Simple substring matching
elif pattern.lower() not in job_properties[key].lower():
return False
return True
def _print_output(self, rows, headers):
"""Print output according to the chosen format."""
if self.format:
# Custom template formatting (simplified)
template = self.format
for row in rows:
line = template
for i, field in enumerate(["id", "image", "command", "created", "status"]):
placeholder = f"{{{{.{field}}}}}"
if placeholder in line:
line = line.replace(placeholder, str(row[i]))
print(line)
else:
# Default tabular format
print(
_tabulate(
rows,
headers=headers,
)
)
class InspectCommand(BaseHuggingfaceCLICommand):
@staticmethod
def register_subcommand(parser: _SubParsersAction) -> None:
run_parser = parser.add_parser("inspect", help="Display detailed information on one or more Jobs")
run_parser.add_argument(
"--namespace",
type=str,
help="The namespace where the job is running. Defaults to the current user's namespace.",
)
run_parser.add_argument(
"--token", type=str, help="A User Access Token generated from https://huggingface.co/settings/tokens"
)
run_parser.add_argument("job_ids", nargs="...", help="The jobs to inspect")
run_parser.set_defaults(func=InspectCommand)
def __init__(self, args: Namespace) -> None:
self.namespace: Optional[str] = args.namespace
self.token: Optional[str] = args.token
self.job_ids: List[str] = args.job_ids
def run(self) -> None:
api = HfApi(token=self.token)
jobs = [api.inspect_job(job_id=job_id, namespace=self.namespace) for job_id in self.job_ids]
print(json.dumps([asdict(job) for job in jobs], indent=4, default=str))
class CancelCommand(BaseHuggingfaceCLICommand):
@staticmethod
def register_subcommand(parser: _SubParsersAction) -> None:
run_parser = parser.add_parser("cancel", help="Cancel a Job")
run_parser.add_argument("job_id", type=str, help="Job ID")
run_parser.add_argument(
"--namespace",
type=str,
help="The namespace where the job is running. Defaults to the current user's namespace.",
)
run_parser.add_argument(
"--token", type=str, help="A User Access Token generated from https://huggingface.co/settings/tokens"
)
run_parser.set_defaults(func=CancelCommand)
def __init__(self, args: Namespace) -> None:
self.job_id: str = args.job_id
self.namespace = args.namespace
self.token: Optional[str] = args.token
def run(self) -> None:
api = HfApi(token=self.token)
api.cancel_job(job_id=self.job_id, namespace=self.namespace)
class UvCommand(BaseHuggingfaceCLICommand):
"""Run UV scripts on Hugging Face infrastructure."""
@staticmethod
def register_subcommand(parser):
"""Register UV run subcommand."""
uv_parser = parser.add_parser(
"uv",
help="Run UV scripts (Python with inline dependencies) on HF infrastructure",
)
subparsers = uv_parser.add_subparsers(dest="uv_command", help="UV commands", required=True)
# Run command only
run_parser = subparsers.add_parser(
"run",
help="Run a UV script (local file or URL) on HF infrastructure",
)
run_parser.add_argument("script", help="UV script to run (local file or URL)")
run_parser.add_argument("script_args", nargs="...", help="Arguments for the script", default=[])
run_parser.add_argument("--image", type=str, help="Use a custom Docker image with `uv` installed.")
run_parser.add_argument(
"--repo",
help="Repository name for the script (creates ephemeral if not specified)",
)
run_parser.add_argument(
"--flavor",
type=str,
help=f"Flavor for the hardware, as in HF Spaces. Defaults to `cpu-basic`. Possible values: {', '.join(SUGGESTED_FLAVORS)}.",
)
run_parser.add_argument("-e", "--env", action="append", help="Environment variables")
run_parser.add_argument(
"-s",
"--secrets",
action="append",
help=(
"Set secret environment variables. E.g. --secrets SECRET=value "
"or `--secrets HF_TOKEN` to pass your Hugging Face token."
),
)
run_parser.add_argument("--env-file", type=str, help="Read in a file of environment variables.")
run_parser.add_argument(
"--secrets-file",
type=str,
help="Read in a file of secret environment variables.",
)
run_parser.add_argument("--timeout", type=str, help="Max duration (e.g., 30s, 5m, 1h)")
run_parser.add_argument("-d", "--detach", action="store_true", help="Run in background")
run_parser.add_argument(
"--namespace",
type=str,
help="The namespace where the Job will be created. Defaults to the current user's namespace.",
)
run_parser.add_argument("--token", type=str, help="HF token")
# UV options
run_parser.add_argument("--with", action="append", help="Run with the given packages installed", dest="with_")
run_parser.add_argument(
"-p", "--python", type=str, help="The Python interpreter to use for the run environment"
)
run_parser.set_defaults(func=UvCommand)
def __init__(self, args: Namespace) -> None:
"""Initialize the command with parsed arguments."""
self.script = args.script
self.script_args = args.script_args
self.dependencies = args.with_
self.python = args.python
self.image = args.image
self.env: dict[str, Optional[str]] = {}
if args.env_file:
self.env.update(load_dotenv(Path(args.env_file).read_text(), environ=os.environ.copy()))
for env_value in args.env or []:
self.env.update(load_dotenv(env_value, environ=os.environ.copy()))
self.secrets: dict[str, Optional[str]] = {}
extended_environ = _get_extended_environ()
if args.secrets_file:
self.secrets.update(load_dotenv(Path(args.secrets_file).read_text(), environ=extended_environ))
for secret in args.secrets or []:
self.secrets.update(load_dotenv(secret, environ=extended_environ))
self.flavor: Optional[SpaceHardware] = args.flavor
self.timeout: Optional[str] = args.timeout
self.detach: bool = args.detach
self.namespace: Optional[str] = args.namespace
self.token: Optional[str] = args.token
self._repo = args.repo
def run(self) -> None:
"""Execute UV command."""
logging.set_verbosity(logging.INFO)
api = HfApi(token=self.token)
job = api.run_uv_job(
script=self.script,
script_args=self.script_args,
dependencies=self.dependencies,
python=self.python,
image=self.image,
env=self.env,
secrets=self.secrets,
flavor=self.flavor,
timeout=self.timeout,
namespace=self.namespace,
_repo=self._repo,
)
# Always print the job ID to the user
print(f"Job started with ID: {job.id}")
print(f"View at: {job.url}")
if self.detach:
return
# Now let's stream the logs
for log in api.fetch_job_logs(job_id=job.id):
print(log)
def _get_extended_environ() -> Dict[str, str]:
extended_environ = os.environ.copy()
if (token := get_token()) is not None:
extended_environ["HF_TOKEN"] = token
return extended_environ
class ScheduledJobsCommands(BaseHuggingfaceCLICommand):
@staticmethod
def register_subcommand(parser: _SubParsersAction):
scheduled_jobs_parser = parser.add_parser("scheduled", help="Create and manage scheduled Jobs on the Hub.")
scheduled_jobs_subparsers = scheduled_jobs_parser.add_subparsers(
help="huggingface.co scheduled jobs related commands"
)
# Show help if no subcommand is provided
scheduled_jobs_parser.set_defaults(func=lambda args: scheduled_jobs_subparsers.print_help())
# Register commands
ScheduledRunCommand.register_subcommand(scheduled_jobs_subparsers)
ScheduledPsCommand.register_subcommand(scheduled_jobs_subparsers)
ScheduledInspectCommand.register_subcommand(scheduled_jobs_subparsers)
ScheduledDeleteCommand.register_subcommand(scheduled_jobs_subparsers)
ScheduledSuspendCommand.register_subcommand(scheduled_jobs_subparsers)
ScheduledResumeCommand.register_subcommand(scheduled_jobs_subparsers)
ScheduledUvCommand.register_subcommand(scheduled_jobs_subparsers)
class ScheduledRunCommand(BaseHuggingfaceCLICommand):
@staticmethod
def register_subcommand(parser: _SubParsersAction) -> None:
run_parser = parser.add_parser("run", help="Schedule a Job")
run_parser.add_argument(
"schedule",
type=str,
help="One of annually, yearly, monthly, weekly, daily, hourly, or a CRON schedule expression.",
)
run_parser.add_argument("image", type=str, help="The Docker image to use.")
run_parser.add_argument(
"--suspend",
action="store_true",
help="Suspend (pause) the scheduled Job",
default=None,
)
run_parser.add_argument(
"--concurrency",
action="store_true",
help="Allow multiple instances of this Job to run concurrently",
default=None,
)
run_parser.add_argument("-e", "--env", action="append", help="Set environment variables. E.g. --env ENV=value")
run_parser.add_argument(
"-s",
"--secrets",
action="append",
help=(
"Set secret environment variables. E.g. --secrets SECRET=value "
"or `--secrets HF_TOKEN` to pass your Hugging Face token."
),
)
run_parser.add_argument("--env-file", type=str, help="Read in a file of environment variables.")
run_parser.add_argument("--secrets-file", type=str, help="Read in a file of secret environment variables.")
run_parser.add_argument(
"--flavor",
type=str,
help=f"Flavor for the hardware, as in HF Spaces. Defaults to `cpu-basic`. Possible values: {', '.join(SUGGESTED_FLAVORS)}.",
)
run_parser.add_argument(
"--timeout",
type=str,
help="Max duration: int/float with s (seconds, default), m (minutes), h (hours) or d (days).",
)
run_parser.add_argument(
"--namespace",
type=str,
help="The namespace where the scheduled Job will be created. Defaults to the current user's namespace.",
)
run_parser.add_argument(
"--token",
type=str,
help="A User Access Token generated from https://huggingface.co/settings/tokens",
)
run_parser.add_argument("command", nargs="...", help="The command to run.")
run_parser.set_defaults(func=ScheduledRunCommand)
def __init__(self, args: Namespace) -> None:
self.schedule: str = args.schedule
self.image: str = args.image
self.command: List[str] = args.command
self.suspend: Optional[bool] = args.suspend
self.concurrency: Optional[bool] = args.concurrency
self.env: dict[str, Optional[str]] = {}
if args.env_file:
self.env.update(load_dotenv(Path(args.env_file).read_text(), environ=os.environ.copy()))
for env_value in args.env or []:
self.env.update(load_dotenv(env_value, environ=os.environ.copy()))
self.secrets: dict[str, Optional[str]] = {}
extended_environ = _get_extended_environ()
if args.secrets_file:
self.secrets.update(load_dotenv(Path(args.secrets_file).read_text(), environ=extended_environ))
for secret in args.secrets or []:
self.secrets.update(load_dotenv(secret, environ=extended_environ))
self.flavor: Optional[SpaceHardware] = args.flavor
self.timeout: Optional[str] = args.timeout
self.namespace: Optional[str] = args.namespace
self.token: Optional[str] = args.token
def run(self) -> None:
api = HfApi(token=self.token)
scheduled_job = api.create_scheduled_job(
image=self.image,
command=self.command,
schedule=self.schedule,
suspend=self.suspend,
concurrency=self.concurrency,
env=self.env,
secrets=self.secrets,
flavor=self.flavor,
timeout=self.timeout,
namespace=self.namespace,
)
# Always print the scheduled job ID to the user
print(f"Scheduled Job created with ID: {scheduled_job.id}")
class ScheduledPsCommand(BaseHuggingfaceCLICommand):
@staticmethod
def register_subcommand(parser: _SubParsersAction) -> None:
run_parser = parser.add_parser("ps", help="List scheduled Jobs")
run_parser.add_argument(
"-a",
"--all",
action="store_true",
help="Show all scheduled Jobs (default hides suspended)",
)
run_parser.add_argument(
"--namespace",
type=str,
help="The namespace from where it lists the jobs. Defaults to the current user's namespace.",
)
run_parser.add_argument(
"--token",
type=str,
help="A User Access Token generated from https://huggingface.co/settings/tokens",
)
# Add Docker-style filtering argument
run_parser.add_argument(
"-f",
"--filter",
action="append",
default=[],
help="Filter output based on conditions provided (format: key=value)",
)
# Add option to format output
run_parser.add_argument(
"--format",
type=str,
help="Format output using a custom template",
)
run_parser.set_defaults(func=ScheduledPsCommand)
def __init__(self, args: Namespace) -> None:
self.all: bool = args.all
self.namespace: Optional[str] = args.namespace
self.token: Optional[str] = args.token
self.format: Optional[str] = args.format
self.filters: Dict[str, str] = {}
# Parse filter arguments (key=value pairs)
for f in args.filter:
if "=" in f:
key, value = f.split("=", 1)
self.filters[key.lower()] = value
else:
print(f"Warning: Ignoring invalid filter format '{f}'. Use key=value format.")
def run(self) -> None:
"""
Fetch and display scheduked job information for the current user.
Uses Docker-style filtering with -f/--filter flag and key=value pairs.
"""
try:
api = HfApi(token=self.token)
# Fetch jobs data
scheduled_jobs = api.list_scheduled_jobs(namespace=self.namespace)
# Define table headers
table_headers = [
"ID",
"SCHEDULE",
"IMAGE/SPACE",
"COMMAND",
"LAST RUN",
"NEXT RUN",
"SUSPEND",
]
# Process jobs data
rows = []
for scheduled_job in scheduled_jobs:
# Extract job data for filtering
suspend = scheduled_job.suspend
# Skip job if not all jobs should be shown and status doesn't match criteria
if not self.all and suspend:
continue
# Extract job ID
scheduled_job_id = scheduled_job.id
# Extract schedule
schedule = scheduled_job.schedule
# Extract image or space information
image_or_space = scheduled_job.job_spec.docker_image or "N/A"
# Extract and format command
command = scheduled_job.job_spec.command or []
command_str = " ".join(command) if command else "N/A"
# Extract status
last_job_at = (
scheduled_job.status.last_job.at.strftime("%Y-%m-%d %H:%M:%S")
if scheduled_job.status.last_job
else "N/A"
)
next_job_run_at = (
scheduled_job.status.next_job_run_at.strftime("%Y-%m-%d %H:%M:%S")
if scheduled_job.status.next_job_run_at
else "N/A"
)
# Create a dict with all job properties for filtering
job_properties = {
"id": scheduled_job_id,
"image": image_or_space,
"suspend": str(suspend),
"command": command_str,
}
# Check if job matches all filters
if not self._matches_filters(job_properties):
continue
# Create row
rows.append(
[
scheduled_job_id,
schedule,
image_or_space,
command_str,
last_job_at,
next_job_run_at,
suspend,
]
)
# Handle empty results
if not rows:
filters_msg = ""
if self.filters:
filters_msg = f" matching filters: {', '.join([f'{k}={v}' for k, v in self.filters.items()])}"
print(f"No scheduled jobs found{filters_msg}")
return
# Apply custom format if provided or use default tabular format
self._print_output(rows, table_headers)
except requests.RequestException as e:
print(f"Error fetching scheduled jobs data: {e}")
except (KeyError, ValueError, TypeError) as e:
print(f"Error processing scheduled jobs data: {e}")
except Exception as e:
print(f"Unexpected error - {type(e).__name__}: {e}")
def _matches_filters(self, job_properties: Dict[str, str]) -> bool:
"""Check if scheduled job matches all specified filters."""
for key, pattern in self.filters.items():
# Check if property exists
if key not in job_properties:
return False
# Support pattern matching with wildcards
if "*" in pattern or "?" in pattern:
# Convert glob pattern to regex
regex_pattern = pattern.replace("*", ".*").replace("?", ".")
if not re.search(f"^{regex_pattern}$", job_properties[key], re.IGNORECASE):
return False
# Simple substring matching
elif pattern.lower() not in job_properties[key].lower():
return False
return True
def _print_output(self, rows, headers):
"""Print output according to the chosen format."""
if self.format:
# Custom template formatting (simplified)
template = self.format
for row in rows:
line = template
for i, field in enumerate(
["id", "schedule", "image", "command", "last_job_at", "next_job_run_at", "suspend"]
):
placeholder = f"{{{{.{field}}}}}"
if placeholder in line:
line = line.replace(placeholder, str(row[i]))
print(line)
else:
# Default tabular format
print(
_tabulate(
rows,
headers=headers,
)
)
class ScheduledInspectCommand(BaseHuggingfaceCLICommand):
@staticmethod
def register_subcommand(parser: _SubParsersAction) -> None:
run_parser = parser.add_parser("inspect", help="Display detailed information on one or more scheduled Jobs")
run_parser.add_argument(
"--namespace",
type=str,
help="The namespace where the scheduled job is. Defaults to the current user's namespace.",
)
run_parser.add_argument(
"--token", type=str, help="A User Access Token generated from https://huggingface.co/settings/tokens"
)
run_parser.add_argument("scheduled_job_ids", nargs="...", help="The scheduled jobs to inspect")
run_parser.set_defaults(func=ScheduledInspectCommand)
def __init__(self, args: Namespace) -> None:
self.namespace: Optional[str] = args.namespace
self.token: Optional[str] = args.token
self.scheduled_job_ids: List[str] = args.scheduled_job_ids
def run(self) -> None:
api = HfApi(token=self.token)
scheduled_jobs = [
api.inspect_scheduled_job(scheduled_job_id=scheduled_job_id, namespace=self.namespace)
for scheduled_job_id in self.scheduled_job_ids
]
print(json.dumps([asdict(scheduled_job) for scheduled_job in scheduled_jobs], indent=4, default=str))
class ScheduledDeleteCommand(BaseHuggingfaceCLICommand):
@staticmethod
def register_subcommand(parser: _SubParsersAction) -> None:
run_parser = parser.add_parser("delete", help="Delete a scheduled Job")
run_parser.add_argument("scheduled_job_id", type=str, help="Scheduled Job ID")
run_parser.add_argument(
"--namespace",
type=str,
help="The namespace where the scheduled job is. Defaults to the current user's namespace.",
)
run_parser.add_argument(
"--token", type=str, help="A User Access Token generated from https://huggingface.co/settings/tokens"
)
run_parser.set_defaults(func=ScheduledDeleteCommand)
def __init__(self, args: Namespace) -> None:
self.scheduled_job_id: str = args.scheduled_job_id
self.namespace = args.namespace
self.token: Optional[str] = args.token
def run(self) -> None:
api = HfApi(token=self.token)
api.delete_scheduled_job(scheduled_job_id=self.scheduled_job_id, namespace=self.namespace)
class ScheduledSuspendCommand(BaseHuggingfaceCLICommand):
@staticmethod
def register_subcommand(parser: _SubParsersAction) -> None:
run_parser = parser.add_parser("suspend", help="Suspend (pause) a scheduled Job")
run_parser.add_argument("scheduled_job_id", type=str, help="Scheduled Job ID")
run_parser.add_argument(
"--namespace",
type=str,
help="The namespace where the scheduled job is. Defaults to the current user's namespace.",
)
run_parser.add_argument(
"--token", type=str, help="A User Access Token generated from https://huggingface.co/settings/tokens"
)
run_parser.set_defaults(func=ScheduledSuspendCommand)
def __init__(self, args: Namespace) -> None:
self.scheduled_job_id: str = args.scheduled_job_id
self.namespace = args.namespace
self.token: Optional[str] = args.token
def run(self) -> None:
api = HfApi(token=self.token)
api.suspend_scheduled_job(scheduled_job_id=self.scheduled_job_id, namespace=self.namespace)
class ScheduledResumeCommand(BaseHuggingfaceCLICommand):
@staticmethod
def register_subcommand(parser: _SubParsersAction) -> None:
run_parser = parser.add_parser("resume", help="Resume (unpause) a scheduled Job")
run_parser.add_argument("scheduled_job_id", type=str, help="Scheduled Job ID")
run_parser.add_argument(
"--namespace",
type=str,
help="The namespace where the scheduled job is. Defaults to the current user's namespace.",
)
run_parser.add_argument(
"--token", type=str, help="A User Access Token generated from https://huggingface.co/settings/tokens"
)
run_parser.set_defaults(func=ScheduledResumeCommand)
def __init__(self, args: Namespace) -> None:
self.scheduled_job_id: str = args.scheduled_job_id
self.namespace = args.namespace
self.token: Optional[str] = args.token
def run(self) -> None:
api = HfApi(token=self.token)
api.resume_scheduled_job(scheduled_job_id=self.scheduled_job_id, namespace=self.namespace)
class ScheduledUvCommand(BaseHuggingfaceCLICommand):
"""Schedule UV scripts on Hugging Face infrastructure."""
@staticmethod
def register_subcommand(parser):
"""Register UV run subcommand."""
uv_parser = parser.add_parser(
"uv",
help="Schedule UV scripts (Python with inline dependencies) on HF infrastructure",
)
subparsers = uv_parser.add_subparsers(dest="uv_command", help="UV commands", required=True)
# Run command only
run_parser = subparsers.add_parser(
"run",
help="Run a UV script (local file or URL) on HF infrastructure",
)
run_parser.add_argument(
"schedule",
type=str,
help="One of annually, yearly, monthly, weekly, daily, hourly, or a CRON schedule expression.",
)
run_parser.add_argument("script", help="UV script to run (local file or URL)")
run_parser.add_argument("script_args", nargs="...", help="Arguments for the script", default=[])
run_parser.add_argument(
"--suspend",
action="store_true",
help="Suspend (pause) the scheduled Job",
default=None,
)
run_parser.add_argument(
"--concurrency",
action="store_true",
help="Allow multiple instances of this Job to run concurrently",
default=None,
)
run_parser.add_argument("--image", type=str, help="Use a custom Docker image with `uv` installed.")
run_parser.add_argument(
"--repo",
help="Repository name for the script (creates ephemeral if not specified)",
)
run_parser.add_argument(
"--flavor",
type=str,
help=f"Flavor for the hardware, as in HF Spaces. Defaults to `cpu-basic`. Possible values: {', '.join(SUGGESTED_FLAVORS)}.",
)
run_parser.add_argument("-e", "--env", action="append", help="Environment variables")
run_parser.add_argument(
"-s",
"--secrets",
action="append",
help=(
"Set secret environment variables. E.g. --secrets SECRET=value "
"or `--secrets HF_TOKEN` to pass your Hugging Face token."
),
)
run_parser.add_argument("--env-file", type=str, help="Read in a file of environment variables.")
run_parser.add_argument(
"--secrets-file",
type=str,
help="Read in a file of secret environment variables.",
)
run_parser.add_argument("--timeout", type=str, help="Max duration (e.g., 30s, 5m, 1h)")
run_parser.add_argument("-d", "--detach", action="store_true", help="Run in background")
run_parser.add_argument(
"--namespace",
type=str,
help="The namespace where the Job will be created. Defaults to the current user's namespace.",
)
run_parser.add_argument("--token", type=str, help="HF token")
# UV options
run_parser.add_argument("--with", action="append", help="Run with the given packages installed", dest="with_")
run_parser.add_argument(
"-p", "--python", type=str, help="The Python interpreter to use for the run environment"
)
run_parser.set_defaults(func=ScheduledUvCommand)
def __init__(self, args: Namespace) -> None:
"""Initialize the command with parsed arguments."""
self.schedule: str = args.schedule
self.script = args.script
self.script_args = args.script_args
self.suspend: Optional[bool] = args.suspend
self.concurrency: Optional[bool] = args.concurrency
self.dependencies = args.with_
self.python = args.python
self.image = args.image
self.env: dict[str, Optional[str]] = {}
if args.env_file:
self.env.update(load_dotenv(Path(args.env_file).read_text(), environ=os.environ.copy()))
for env_value in args.env or []:
self.env.update(load_dotenv(env_value, environ=os.environ.copy()))
self.secrets: dict[str, Optional[str]] = {}
extended_environ = _get_extended_environ()
if args.secrets_file:
self.secrets.update(load_dotenv(Path(args.secrets_file).read_text(), environ=extended_environ))
for secret in args.secrets or []:
self.secrets.update(load_dotenv(secret, environ=extended_environ))
self.flavor: Optional[SpaceHardware] = args.flavor
self.timeout: Optional[str] = args.timeout
self.detach: bool = args.detach
self.namespace: Optional[str] = args.namespace
self.token: Optional[str] = args.token
self._repo = args.repo
def run(self) -> None:
"""Schedule UV command."""
logging.set_verbosity(logging.INFO)
api = HfApi(token=self.token)
job = api.create_scheduled_uv_job(
script=self.script,
script_args=self.script_args,
schedule=self.schedule,
suspend=self.suspend,
concurrency=self.concurrency,
dependencies=self.dependencies,
python=self.python,
image=self.image,
env=self.env,
secrets=self.secrets,
flavor=self.flavor,
timeout=self.timeout,
namespace=self.namespace,
_repo=self._repo,
)
# Always print the job ID to the user
print(f"Scheduled Job created with ID: {job.id}")
|