[docs] Document --scheduler-cls base class requirement (extend AsyncScheduler, not Scheduler) (#43724)
Signed-off-by: Georgii Kliukovkin <kliukovkin@gmail.com> Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
This commit is contained in:
co-authored by
Claude Sonnet 4.6
Harry Mellor
parent
0d657e44dc
commit
7852e50e4d
@@ -175,12 +175,13 @@ class SchedulerConfig:
|
||||
|
||||
return Scheduler
|
||||
|
||||
# This warning can be removed once the Scheduler interface is
|
||||
# finalized and we can maintain support for scheduler classes that
|
||||
# implement it
|
||||
# The first half of this warning can be removed once the Scheduler interface is
|
||||
# finalized and we can maintain support for scheduler classes that implement it
|
||||
logger.warning_once(
|
||||
"Using custom scheduler class %s. This scheduler interface is "
|
||||
"not public and compatibility may not be maintained.",
|
||||
"Using custom scheduler class %s. This scheduler interface is not public "
|
||||
"and compatibility may not be maintained. If you have subclassed Scheduler "
|
||||
"instead of AsyncScheduler, you will see degraded performance due to async "
|
||||
"scheduling being disabled.",
|
||||
self.scheduler_cls, # type: ignore[arg-type]
|
||||
)
|
||||
if not isinstance(self.scheduler_cls, str):
|
||||
|
||||
Reference in New Issue
Block a user