on master help sign in
Add some notes on performance optimizations

Especially what to look for first when using streamly.

commit50b7824d2e2af8ed56360a052c80989660d8371f authorHarendra Kumar <harendra.kumar@gmail.com> dateMon 25 Nov 2019, 15:29 (7 years ago) parent0569ab5
1 file changed+12
docs/Build.md+12
docs/Build.md+12
@@ -41,3 +41,15 @@ multi-core parallelism use the following GHC options:
4141GHC 8.2.2 may hog memory and hang when building certain application using
4242streamly (particularly the benchmark programs in the streamly package).
4343Therefore we recommend avoiding using the GHC version 8.2.x.
44+
45+# Performance Optimizations
46+
47+If performance is below expectations:
48+
49+* Look for inlining functions in the fast path
50+* Strictness annotations on data, specially the data used as accumulator in
51+ folds and scans, can help in improving performance.
52+* Strictness annotations on function arguments can help the compiler unbox
53+ constructors in certain cases, improving performance.
54+* Sometims using `-XStrict` extension can help improve performance, if so you
55+ may be missing some strictness annotations.