Ranx

Fixed
- Fixed a bug in `report.py:Report`: some metric labels were missing.
- `SciPy` version explicitly stated in `setup.py` to avoid errors.

Changed
- `Qrels`'s `save` and `from_file` functions now automatically infer file extension. `kind` parameter can be used to override default behavior.
- `Qrels`'s `save` and `from_file` functions are now much faster with `json` files thanks to [`orjson`](https://github.com/ijl/orjson).
- `Run`'s `save` and `from_file` functions now automatically infer file extension. `kind` parameter can be used to override default behavior.
- `Run`'s `save` and `from_file` functions are now much faster with `json` files thanks to [`orjson`](https://github.com/ijl/orjson).
- `Two-sided Paired Student's t-Test` is now the default statistical test used when calling `compare`. It is much faster than `Fisher's` and usually agrees with it.

[0.2.x] - 2022

Sorry, I have been lazy.

Fixed
- Fixed a bug in `report.py:Report.to_dict`.

Added
- Added `from_ir_datasets` to `qrels.py`. It allows loading qrels from [`ir_metadata`](https://ir-datasets.com).

Added
- Added `paired_student_t_test` to `statistical_testing.py`.
- Added `stat_test` parameter to `compare`. Defaults to `fisher`.
- Added `stat_test` parameter to `report`. Defaults to `fisher`.

Changed
- `Report`'s `to_latex` function now takes into account the newly introduced `stat_test` parameter to correctly generating LaTeX tables' captions.
- `Report`'s `to_dict` function now takes into account the newly introduced `stat_test` parameter and adds it to the output dictionary.
- `Report`'s `save` function now takes into account the newly introduced `stat_test` parameter and adds it to the output JSON file.

Added
- Added `show_percentages` parameter to `Report`. Defaults to `False`.
- Added `show_percentages` parameter to `compare`. Defaults to `False`.
- Added `rounding_digits` parameter to `compare`. Defaults to `3`.
- Added usage example notebooks for Google Colab.

Changed
- <span style="color:blue">\[IMPORTANT\]</span> `Qrels` and `Run` now accept a Python Dictionary as initialization parameter and this is the preferred way of creating new instances for those classes. They also accept a `name` parameter. None of those is mandatory, so it should not break code based on previous `ranx` version although this could be changed in the future.
- <span style="color:red">\[BREAKING CHANGE\]</span> `Qrels` and `Run` `save` function `type` parameter renamed to `kind` to prevent it to be interpreted as the `type` Python utility function.
- <span style="color:red">\[BREAKING CHANGE\]</span> `Qrels` and `Run` `save` function now defaults to `json` instead of `trec` for the `kind` parameter (previously called `type`).
- <span style="color:red">\[BREAKING CHANGE\]</span> `Qrels` and `Run` `from_file` function `type` parameter renamed to `kind` to prevent it to be interpreted as the `type` Python utility function.
- <span style="color:red">\[BREAKING CHANGE\]</span> `Qrels` and `Run` `from_file` function now defaults to `json` instead of `trec` for the `kind` parameter (previously called `type`).
- `rounding_digits` parameter of `Report` now defaults to `3`.
- `Report`'s `to_latex` function now produces a simplified LaTeX table.
- Various improvements to `Report` source code.