Update docs and encoders - Githubissues

redmod-team / profit

Probabilistic Response mOdel Fitting with Interactive Tools

https://profit.readthedocs.io

MIT License

14 stars 9 forks source link

Update docs and encoders #161

Closed mkendler closed 2 years ago

mkendler commented 2 years ago

[x] Add default values for API usage.
[x] Update documentation.
[x] Edit encoders and improve encoder config.
[x] Minor adaptations, e.g. consistent shapes of variables and hyperparameters.

coveralls commented 2 years ago

Pull Request Test Coverage Report for Build 2044710600

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

308 of 401 (76.81%) changed or added relevant lines in 12 files are covered.
31 unchanged lines in 4 files lost coverage.
Overall coverage increased (+2.1%) to 66.23%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
profit/sur/gp/gaussian_process.py	11	12	91.67%
profit/sur/gp/gpy_surrogate.py	31	32	96.88%
profit/main.py	1	3	33.33%
profit/util/variable.py	8	17	47.06%
profit/sur/gp/custom_surrogate.py	36	48	75.0%
profit/config.py	123	136	90.44%
profit/sur/encoders.py	49	66	74.24%
profit/al/aquisition_functions.py	20	58	34.48%
<!--	Total:	308	401	76.81%	-->

Files with Coverage Reduction	New Missed Lines	%
profit/sur/gp/custom_surrogate.py	1	82.32%
profit/sur/gp/sklearn_surrogate.py	1	26.42%
profit/sur/gp/gpy_surrogate.py	9	85.19%
profit/al/aquisition_functions.py	20	45.66%
<!--	Total:	31		-->

Totals
Change from base Build 2003302899:	2.1%
Covered Lines:	2577
Relevant Lines:	3891

💛 - Coveralls