Merge pull request #11 from tpapp/tp/api-rewrite

Added reporting infrastructure, code reorganization.
tpapp · May 3, 2018 · 0f52b21 · 0f52b21
2 parents 842fe82 + e8e2497
commit 0f52b21
Show file tree

Hide file tree

Showing 14 changed files with 1,344 additions and 1,184 deletions.
diff --git a/docs/src/lowlevel.md b/docs/src/lowlevel.md
@@ -121,6 +121,29 @@ ACCEPTANCE_QUANTILES
 explore_local_acceptance_ratios
 ```
 
+## Reporting information during runs
+
+Samplers take an [`AbstractReport`](@ref) argument, which is then used for reporting. The interface is as follows.
+
+```@docs
+DynamicHMC.AbstractReport
+DynamicHMC.report!
+DynamicHMC.start_progress!
+DynamicHMC.end_progress!
+```
+
+The default is
+```@docs
+ReportIO
+```
+
+Reporting information can be suppressed with
+```@docs
+ReportSilent
+```
+
+Other interfaces should define similar types.
+
 ## Utilities and miscellanea
 
 ```@docs