Metadata-Version: 2.1
Name: scheduling_utils
Version: 0.1.2
Summary: implementation of scheduling function utils
Home-page: https://github.com/SerezD/scheduling_utils
Author: DSerez
License: MIT
Description-Content-Type: text/markdown
License-File: LICENSE

# Scheduler Utils

Implements some scheduling functions to decay or ramp values across timestamps.  

Install with: `pip install scheduling_utils`

To initialize and use for example a cosine scheduler, do the following: 

```
from schedulers import CosineScheduler

start_step = 0
stop_step = 10

start_value = 5
stop_value = 20

scheduler = CosineScheduler(start_step, stop_step, start_value, stop_value)

# get values corresponding to step
for step in range(10):
    value = scheduler.step(step)
```

Available Schedulers at current version:
- Linear
    ![linear-ramp](images/linear_ramp.png)
    ![linear-decay](images/linear_decay.png)
- Cosine
    ![cosine-ramp](images/cosine_ramp.png)
    ![cosine-decay](images/cosine_decay.png)
- LinearCosine
    ![linear-cosine](images/linear_cosine.png)
 
