Baal

Quite a large update with a renewed experience for researchers: Experiment API.

Nonetheless, production users will benefit from EPIG, the new SotA in Active Learning!

**Experiment API**
The new experiment object will simplify your experiments by reducing it to a 1-liner.


**EPIG**
Contribution from reeshipaul Dref360 and fbickfordsmith, EPIG is the new state-of-the-art in Bayesian Active Learning.
It better estimates the predictive uncertainty than PowerBALD and considers the labeled training set.


**Stopping Criterion**
A new object that helps you stop an experiment when reaching your labeling budget or a plateau in uncertainty/performance.


Breaking Changes

* Arguments in `ModelWrapper.*_on_dataset` have been for the most part moved to `TrainingArguments` and are included in `ModelWrapper` constructor. Visit the [documentation](https://baal.readthedocs.io/api/modelwrapper/) for more details.

What's Changed
* Add Stopping Criteria for loop by Dref360 in https://github.com/baal-org/baal/pull/286
* Add EPIG by reeshipaul Dref360 fbickfordsmith in https://github.com/baal-org/baal/pull/293
* Add Args to ModelWrapper to simplify common API by Dref360 in https://github.com/baal-org/baal/pull/294
* Add documentation for criterion by Dref360 in https://github.com/baal-org/baal/pull/297
* Experiment API v2 by Dref360 in https://github.com/baal-org/baal/pull/296


**Full Changelog**: https://github.com/baal-org/baal/compare/v1.9.2...v2.0.0

What's Changed
* Allow HF to not replicate in memory by Dref360 in https://github.com/baal-org/baal/pull/281
* Run poetry.lock by Dref360 in https://github.com/baal-org/baal/pull/282
* Fix typo in logging and bump structlog by Dref360 in https://github.com/baal-org/baal/pull/285


**Full Changelog**: https://github.com/baal-org/baal/compare/v1.9.1...v1.9.2

**Full Changelog**: https://github.com/baal-org/baal/compare/v1.9.0...v1.9.1

What's Changed
* Handle NER usecase by Dref360 in https://github.com/baal-org/baal/pull/263
* Add warnings when using replicate_in_memory=True and MCCachingModule by Dref360 in https://github.com/baal-org/baal/pull/273
* `weights=None` in vgg models by arthur-thuy in https://github.com/baal-org/baal/pull/276
* fix: no pool preds for random heuristic by arthur-thuy in https://github.com/baal-org/baal/pull/277


**Full Changelog**: https://github.com/baal-org/baal/compare/v1.8.0...v1.9.0

New features

* MCCachingModule: Cache computation between Monte Carlo iteration [link](https://baal.readthedocs.io/en/latest/notebooks/mccaching_layer/). Special thanks to pieterblok for introducing this capability!
* We can now evaluation every `x` epochs in `ModelWrapper.train_and_test_on_datasets`.


What's Changed
* Fix doc for NLP example by Dref360 in https://github.com/baal-org/baal/pull/241
* 246 Fix issue where training was not kept consistent by Dref360 in https://github.com/baal-org/baal/pull/249
* Baal in Production Notebook | Classification | NLP | Hugging Face by nitish1295 in https://github.com/baal-org/baal/pull/245
* Add code walkthrough for CIFAR10 by Dref360 in https://github.com/baal-org/baal/pull/253
* Deprecate shuffle prop in favor of PowerSampling by Dref360 in https://github.com/baal-org/baal/pull/260
* docs: use correct link to experiment script by arthur-thuy in https://github.com/baal-org/baal/pull/267
* added setting to skip x epochs when using train_and_test_on_datasets by studentWUR in https://github.com/baal-org/baal/pull/258
* Add caching mechanism for MCDropout by Dref360 in https://github.com/baal-org/baal/pull/268
* Improve get_indices_for_active_step by caching the result according t… by Dref360 in https://github.com/baal-org/baal/pull/269

New Contributors
* nitish1295 made their first contribution in https://github.com/baal-org/baal/pull/245
* arthur-thuy made their first contribution in https://github.com/baal-org/baal/pull/267
* studentWUR made their first contribution in https://github.com/baal-org/baal/pull/258

Deprecation

We will deprecate `shuffle_prop` in favor of PowerSampling. Look [here](https://baal.readthedocs.io/en/latest/user_guide/heuristics/) to know more about PowerBALD!

**Full Changelog**: https://github.com/baal-org/baal/compare/v1.7.0...v1.8.0

Large release where we added support for `torchmetrics`, moved to `mkdocs` and made the app more robust!

We also updated our visual identity, huge thanks to Donasolo for the new logos!

What's Changed
* Move to Github Actions by Dref360 in https://github.com/baal-org/baal/pull/212
* Added None to act as max for np.clip by GeorgePearse in https://github.com/baal-org/baal/pull/213
* Assign version to pytorch-lightning by Dref360 in https://github.com/baal-org/baal/pull/226
* Update README and CONTRIBUTING by Dref360 in https://github.com/baal-org/baal/pull/222
* Add metric logging by Dref360 in https://github.com/baal-org/baal/pull/223
* Throw away value for custom dataloaders by bresilla in https://github.com/baal-org/baal/pull/228
* 232 Allow for Python <4 by Dref360 in https://github.com/baal-org/baal/pull/233
* 156 Support torchmetrics by Dref360 in https://github.com/baal-org/baal/pull/230
* Add warning when data augmentation is applied on the pool by Dref360 in https://github.com/baal-org/baal/pull/229
* Add structure for mkdocs instead of Sphinx by Dref360 in https://github.com/baal-org/baal/pull/225

New Contributors
* GeorgePearse made their first contribution in https://github.com/baal-org/baal/pull/213
* bresilla made their first contribution in https://github.com/baal-org/baal/pull/228

**Full Changelog**: https://github.com/baal-org/baal/compare/v1.6.0...v1.7.0