semvec/pypi-packages huggingface dataset:
ctrl-bench 0.0.3
The Continual Transfer Learning Benchmark
License: MIT License

# Continual Transfer Learning Benchmark
The CTrL benchmark aims to help research by studying the transfer behaviour of different models in the Lifelong Learning context.

For a quick presentation of the benchmark, please check out [this blog post](https://ai.facebook.com/blog/ctrl-and-mntdp-a-new-open-source-benchmark-and-model-for-continual-learning/).

For more details, the paper is available on [arxiv](https://arxiv.org/abs/2012.12631).

## Creating a Stream:

The `TaskGenerator` class is at the center of the implementation of the CTrL Benchmark. 
It gives access to a high-level API allowing to seamlessly generate a wide variety of streams with a loose coupling between the different components such as the underlying dataset(s), the strategy to generate the tasks (split, incremental, mixture of datasets, ...) and the processing to apply to each task.   

The 3 main components of a `Task Generator` are:
- A pool of concepts to select from to generate the tasks. It can be a few classes, a full dataset or even a mixture of datasets.
- A pool of transformation that can be modified or combined to apply specific processing to the data for each task.
- A Strategy, describing how to combine the conecpts and trasnformation over time to generate an actual stream.

Each of these components can be created by hand or using our automatic `TaskGenerator` creation tool using yaml configuration files.

For examples simply executing
```python
import ctrl
task_gen = CTrl.get_stream('s_minus')
```
will return the corresponding task generator that be used either directy to generate tasks on the fly:
```python
t1 = task_gen.add_task()
t2 = task_gen.add_task()
t3 = task_gen.add_task()
...
```

or as an iterator:
```python
for t in task_gen():
    ...
```

### Available streams:
In the current version, only the streams of the CTrL benchmark are directly available, they can be obtained by passing the following `name` arguments in `ctrl.get_stream`:
- S<sup>+</sup>: `"s_plus"`
- S<sup>-</sup>: `"s_minus"`
- S<sup>in</sup>: `"s_in"`
- S<sup>out</sup>: `"s_out"`
- S<sup>pl</sup>: `"s_pl"`
- S<sup>long</sup>: `"s_long"`


More documentation and details on the internal components will be progressively added.

See the CONTRIBUTING file for how to help out.

# LICENSE
See the LICENSE file.