Update multistart option handling

[timmens]

In this PR, I update the multistart options handing.

• Add public MultistartOptions data class
• Add internal MultistartInfo data class
• Add a lot of type and value checks to the public data class
• Add deprecations and exceptions
• Only use MultistartOptions instead of dictionaries internally
• Add deprecation test
• Change default "sampling_method" to "random".
• Validate that RNG can be used as seeds.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[codecov]

Codecov Report

Attention: Patch coverage is 94.92188% with 13 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/optimagic/optimization/multistart_options.py	95.62%	7 Missing ⚠️
...imagic/optimization/create_optimization_problem.py	72.72%	3 Missing ⚠️
src/optimagic/optimization/multistart.py	92.59%	2 Missing ⚠️
src/optimagic/optimization/optimize_result.py	92.30%	1 Missing ⚠️

Files with missing lines	Coverage Δ
src/optimagic/__init__.py	100.00% <100.00%> (+10.00%)	⬆️
src/optimagic/deprecations.py	100.00% <100.00%> (ø)
src/optimagic/exceptions.py	86.66% <100.00%> (+0.45%)	⬆️
src/optimagic/optimization/optimize.py	91.73% <100.00%> (+1.59%)	⬆️
src/optimagic/optimization/process_results.py	96.10% <100.00%> (-0.05%)	⬇️
src/optimagic/parameters/scaling.py	97.22% <100.00%> (+0.34%)	⬆️
src/optimagic/optimization/optimize_result.py	93.89% <92.30%> (-0.28%)	⬇️
src/optimagic/optimization/multistart.py	92.56% <92.59%> (+0.11%)	⬆️
...imagic/optimization/create_optimization_problem.py	84.74% <72.72%> (-0.32%)	⬇️
src/optimagic/optimization/multistart_options.py	95.62% <95.62%> (ø)

... and 1 file with indirect coverage changes

[janosg]

Very nice PR.

After you are done with the current comments I will go over the how-to guide; Will be easier to make changes there myself than describing changes in comments.

One more thing: Since it is a breaking change we should convert the multistart_info dict in the OptimizeResult to a dataclass. You can add a __getitem__ method such that it behaves a bit more like a dict.

[janosg]

Thanks a lot. We can merge after two mini comments.