ClearML/clearml
1
0
Fork 0
mirror of https://github.com/clearml/clearml synced 2025-06-04 03:47:57 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Edit TaskScheduler docstrings (#475)

Browse Source
This commit is contained in:
pollfly 2021-10-15 16:04:44 +03:00 committed by GitHub
parent b010f775bd
commit 8ca5346421
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 25 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
clearml/automation/scheduler.py
View File

@ -529,16 +529,21 @@ class TaskScheduler(BaseScheduler):
): ):
# type: (...) -> bool # type: (...) -> bool
""" """
Create a cron job alike scheduling for a pre existing Task. Create a cron job-like scheduling for a pre-existing Task.
Notice it is recommended to give the schedule entry a descriptive unique name, Notice, it is recommended to give the schedule entry a descriptive unique name,
if not provided a task ID is used. if not provided, a name is randomly generated.
When timespec parameters are specified exclusively, they define the time between task launches (see
`year` and `weekdays` exceptions). When multiple timespec parameter are specified, the parameter representing
the longest duration defines the time between task launches, and the shorter timespec parameters define specific
times.
Examples: Examples:
Launch every 15 minutes Launch every 15 minutes
add_task(schedule_task_id='1235', queue='default', minute=15) add_task(schedule_task_id='1235', queue='default', minute=15)
Launch every 1 hour Launch every 1 hour
add_task(schedule_task_id='1235', queue='default', hour=1) add_task(schedule_task_id='1235', queue='default', hour=1)
Launch every 1 hour and at hour:30 minutes (i.e. 1:30, 2:30 etc.) Launch every 1 hour at hour:30 minutes (i.e. 1:30, 2:30 etc.)
add_task(schedule_task_id='1235', queue='default', hour=1, minute=30) add_task(schedule_task_id='1235', queue='default', hour=1, minute=30)
Launch every day at 22:30 (10:30 pm) Launch every day at 22:30 (10:30 pm)
add_task(schedule_task_id='1235', queue='default', minute=30, hour=22, day=1) add_task(schedule_task_id='1235', queue='default', minute=30, hour=22, day=1)
@ -550,22 +555,27 @@ class TaskScheduler(BaseScheduler):
add_task(schedule_task_id='1235', queue='default', hour=2, weekdays=['saturday', 'sunday']) add_task(schedule_task_id='1235', queue='default', hour=2, weekdays=['saturday', 'sunday'])
Launch once a month at the 5th of each month Launch once a month at the 5th of each month
add_task(schedule_task_id='1235', queue='default', month=1, day=5) add_task(schedule_task_id='1235', queue='default', month=1, day=5)
Launch once a year on March 4th of each year Launch once a year on March 4th
add_task(schedule_task_id='1235', queue='default', year=1, month=3, day=4) add_task(schedule_task_id='1235', queue='default', year=1, month=3, day=4)
:param schedule_task_id: Task/task ID to be cloned and scheduled for execution :param schedule_task_id: ID of Task to be cloned and scheduled for execution
:param schedule_function: Optional, instead of providing Task ID to be scheduled, :param schedule_function: Optional, instead of providing Task ID to be scheduled,
provide a function to be called. Notice the function is called from the scheduler context provide a function to be called. Notice the function is called from the scheduler context
(i.e. running on the same machine as the scheduler) (i.e. running on the same machine as the scheduler)
:param queue: Queue name or ID to put the Task into (i.e. schedule) :param queue: Name or ID of queue to put the Task into (i.e. schedule)
:param name: Name or description for the cron Task (should be unique if provided otherwise randomly generated) :param name: Name or description for the cron Task (should be unique if provided, otherwise randomly generated)
:param target_project: Specify target project to put the cloned scheduled Task in. :param target_project: Specify target project to put the cloned scheduled Task in.
:param minute: If specified launch Task at a specific minute of the day (Valid values 0-60) :param minute: Time (in minutes) between task launches. If specified together with `hour`, `day`, `month`,
:param hour: If specified launch Task at a specific hour (24h) of the day (Valid values 0-24) and / or `year`, it defines the minute of the hour
:param day: If specified launch Task at a specific day (Valid values 1-31) :param hour: Time (in hours) between task launches. If specified together with `day`, `month`, and / or
:param weekdays: If specified a list of week days to schedule the Task in (assuming day, not given) `year`, it defines the hour of day.
:param month: If specified launch Task at a specific month (Valid values 1-12) :param day: Time (in days) between task executions. If specified together with `month` and / or `year`,
:param year: If specified launch Task at a specific year it defines the day of month
:param weekdays: Days of week to launch task (accepted inputs: 'monday', 'tuesday', 'wednesday',
'thursday', 'friday', 'saturday', 'sunday')
:param month: Time (in months) between task launches. If specified with `year`, it defines a specific month
:param year: Specific year if value >= current year. Time (in years) between task launches if
value <= 100
:param limit_execution_time: Limit the execution time (in hours) of the specific job. :param limit_execution_time: Limit the execution time (in hours) of the specific job.
:param single_instance: If True, do not launch the Task job if the previous instance is still running :param single_instance: If True, do not launch the Task job if the previous instance is still running
(skip until the next scheduled time period). Default False. (skip until the next scheduled time period). Default False.

2
examples/scheduler/cron_example.py
View File

@ -29,7 +29,7 @@ scheduler.add_task(
# add_task(schedule_task_id='1235', queue='default', minute=15) # add_task(schedule_task_id='1235', queue='default', minute=15)
# Launch every 1 hour # Launch every 1 hour
# add_task(schedule_task_id='1235', queue='default', hour=1) # add_task(schedule_task_id='1235', queue='default', hour=1)
# Launch every 1 hour and at hour:30 minutes (i.e. 1:30, 2:30 etc.) # Launch every 1 hour at hour:30 minutes (i.e. 1:30, 2:30 etc.)
# add_task(schedule_task_id='1235', queue='default', hour=1, minute=30) # add_task(schedule_task_id='1235', queue='default', hour=1, minute=30)
# Launch every day at 22:30 (10:30 pm) # Launch every day at 22:30 (10:30 pm)
# add_task(schedule_task_id='1235', queue='default', minute=30, hour=22, day=1) # add_task(schedule_task_id='1235', queue='default', minute=30, hour=22, day=1)