feat: scikit-base registry and testing framework

[fkiraly]

Depends on #10 which should be merged first. Implements #9

Adds scikit-base machinery, for sktime compatibility.
Contents:

• registry with lookup utility all_objects, including tests
• BaseObject interface contract test class, TestAllObjects
• test scenarios for bootstrap algorithms
• TestAllBootstraps a test class specific to bootstrap objects, currently testing input/output contract of the bootstrap method
• new tag capability:multivariate, which distinguishes boostrap algorithms that can vs cannot handle multivariate data. Used in an informative user facing error message, and matching algorithms with test scenarios.

One open question is, where should tests live?
I added tests currently in a sub-folder of tsbootstrap rather than the current tests folder, but that's not necessary.

[astrogilda]

Depends on #10 which should be merged first. Implements #9

Adds scikit-base machinery, for sktime compatibility. Contents:

• registry with lookup utility all_objects, including tests
• BaseObject interface contract test class, TestAllObjects
• test scenarios for bootstrap algorithms
• TestAllBootstraps a test class specific to bootstrap objects, currently testing input/output contract of the bootstrap method

One open question is, where should tests live? I added tests currently in a sub-folder of tsbootstrap rather than the current tests folder, but that's not necessary.

What's the rationale behind changing the location for the tests folder?

[fkiraly]

technically, I've added it, not changed it. I just did not know for certain where to put it. No strong opinions where it should go.

[fkiraly]

2nd one is resolved, the issue was:

• not all bootstrap algorithms accept multivariate input, i.e., shape (n_inst, n_vars) with n_vars>1.
• the exception that was supposed to be raised was internally silenced (try/except/print, not try/except/raise)

This is solved by:

• adding a tag, and testing dependent on the tag
• moving the multivariate check to _check_input

[fkiraly]

I've investigated the first issue, and the failure is not, as I thought, about generators or not. The problem is that if return_index=True, then the return generator produces (non-generator) returns that are non-compliant with specification, namely tuples of shape

(list-of[list-of[np.ndarray]], list-of[np.ndarray]), and it looks like the second tuple element is the bootstrapped series, not the first.

Reproducing code:

from tsbootstrap.block_bootstrap import BlackmanBootstrap
from tsbootstrap.tests.scenarios.scenarios_bootstrap import BootstrapUnivarRetIx

boot = BlackmanBootstrap()
sc = BootstrapUnivarRetIx()

# this is the same as running the blackman bootstrap
# with some X, y, and return_indices=True
result_gen = sc.run(boot, method_sequence=["bootstrap"])

result_list = list(result_gen)  # then investigate this list

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 77.06186% with 89 lines in your changes are missing coverage. Please review.

Project coverage is 88.59%. Comparing base (5d53806) to head (83d5b65).
Report is 32 commits behind head on main.

Files	Patch %	Lines
src/tsbootstrap/tests/scenarios/scenarios.py	68.11%	22 Missing ⚠️
src/tsbootstrap/utils/estimator_checks.py	19.04%	17 Missing ⚠️
...rc/tsbootstrap/tests/scenarios/scenarios_getter.py	63.15%	14 Missing ⚠️
src/tsbootstrap/tests/test_class_register.py	26.31%	14 Missing ⚠️
src/tsbootstrap/registry/_lookup.py	71.42%	8 Missing ⚠️
src/tsbootstrap/utils/dependencies.py	77.77%	4 Missing ⚠️
src/tsbootstrap/tests/test_all_estimators.py	92.85%	3 Missing ⚠️
src/tsbootstrap/registry/tests/test_tags.py	88.88%	2 Missing ⚠️
...tsbootstrap/tests/scenarios/scenarios_bootstrap.py	96.55%	2 Missing ⚠️
src/tsbootstrap/tests/test_switch.py	84.61%	2 Missing ⚠️
... and 1 more

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #26      +/-   ##
==========================================
+ Coverage   84.77%   88.59%   +3.82%     
==========================================
  Files          17       31      +14     
  Lines        2607     2763     +156     
==========================================
+ Hits         2210     2448     +238     
+ Misses        397      315      -82     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.