Add README.md

This commit is contained in:
RunasSudo 2022-10-17 20:38:05 +11:00
parent afc0a724fe
commit 6d1802fbaf
Signed by: RunasSudo
GPG Key ID: 7234E476BF21C61A

View File

@ -77,3 +77,7 @@ Relevant statistical functions are all directly available from the top-level *yl
* *bayesfactor_afbf*: Adjusted fractional Bayes factor for a hypothesis on parameters from regression * *bayesfactor_afbf*: Adjusted fractional Bayes factor for a hypothesis on parameters from regression
Each function is documented in the respective docstring within the source code. Examples can be found in the unit tests in the *tests* directory. Each function is documented in the respective docstring within the source code. Examples can be found in the unit tests in the *tests* directory.
## Warning
No warranty is made as to the correctness of any function in this library. While the library is unit tested, the validation is not extensive. This applies particularly for functions which are more than simple wrappers for existing implementations. Please apply appropriate caution.