huggingface/pytorch-image-models · error · ValueError
schedule_spread must be non-negative.
Error message
schedule_spread must be non-negative.
What it means
schedule_spread (how spread out/soft the transition between batch-size choices is during a progressive schedule) must be >= 0; negative values fail validation in the constructor.
Source
Thrown at timm/data/scheduled_sampler.py:78
if not hasattr(sampler, '__len__'):
raise TypeError('ScheduledBatchSampler requires a sampler with a length.')
if len(sampler) <= 0:
raise ValueError('ScheduledBatchSampler requires a non-empty sampler.')
if not batch_sizes:
raise ValueError('batch_sizes must contain at least one value.')
if any(int(batch_size) != batch_size or batch_size <= 0 for batch_size in batch_sizes):
raise ValueError('All scheduled batch sizes must be positive integers.')
if num_batches is not None and (int(num_batches) != num_batches or num_batches <= 0):
raise ValueError('num_batches must be a positive integer when specified.')
if choice_schedule not in ('constant', 'progressive'):
raise ValueError("choice_schedule must be 'constant' or 'progressive'.")
if choice_schedule == 'progressive':
if len(batch_sizes) < 2:
raise ValueError('A progressive schedule requires at least two choices.')
if schedule_epochs is None or int(schedule_epochs) != schedule_epochs or schedule_epochs <= 0:
raise ValueError('schedule_epochs must be a positive integer for a progressive schedule.')
if schedule_spread < 0:
raise ValueError('schedule_spread must be non-negative.')
if not 0 <= schedule_random_mix <= 1:
raise ValueError('schedule_random_mix must be between 0 and 1.')
self.sampler = sampler
self.batch_sizes = tuple(int(batch_size) for batch_size in batch_sizes)
self.choice_weights = self._normalize_choice_weights(choice_weights)
self._active_choices = tuple(
choice_index
for choice_index, choice_weight in enumerate(self.choice_weights)
if choice_weight > 0
)
self.seed = seed
self.drop_last = drop_last
self.shuffle_schedule = shuffle_schedule
self.choice_schedule = choice_schedule
self.schedule_epochs = int(schedule_epochs) if schedule_epochs is not None else None
self.schedule_spread = schedule_spread
self.schedule_random_mix = schedule_random_mixView on GitHub (pinned to 9a5261e31b)
Solutions
- Use a non-negative spread (default 0.65; larger values make transitions more gradual).
- If you wanted sharp switching, set schedule_spread=0.
Example fix
# before ScheduledBatchSampler(s, batch_sizes=[64,256], choice_schedule='progressive', schedule_epochs=20, schedule_spread=-0.65) # after ScheduledBatchSampler(s, batch_sizes=[64,256], choice_schedule='progressive', schedule_epochs=20, schedule_spread=0.65)
Defensive patterns
Strategy: validation
Validate before calling
assert schedule_spread is None or schedule_spread >= 0
Prevention
- Use the documented default (0.65).
- Treat spread as a non-negative softness knob; 0 for hard transitions.
When it happens
Trigger: choice_schedule='progressive' with schedule_spread=-0.2 (or any negative number).
Common situations: Typo'd sign in a config; borrowed hyperparameters from a paper/codebase using a signed spread convention.
Related errors
- All scheduled batch sizes must be positive integers.
- num_batches must be a positive integer when specified.
- A progressive schedule requires at least two choices.
- schedule_epochs must be a positive integer for a progressive
- schedule_random_mix must be between 0 and 1.
AI-assisted analysis of huggingface/pytorch-image-models@9a5261e31b (2026-08-27).
Data as JSON: /api/errors/5216cc6c6d6cc476.
Report an issue: GitHub.