polysemy-research/polysemy
1
1
Fork 0
mirror of https://github.com/polysemy-research/polysemy.git synced 2024-12-02 11:54:06 +03:00
Code Issues Projects Releases Wiki Activity

Add performance instructions to README (#185)

Browse Source
This commit is contained in:
Jack Henahan 2019-07-24 08:35:44 -04:00 committed by Sandy Maguire
parent 011530bba1
commit c53357ca92
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -214,3 +214,20 @@ You're going to want to stick all of this into your `package.yaml` file.
- TypeOperators
- TypeFamilies
```
## Stellar Engineering - Aligning the stars to optimize `polysemy` away
Several things need to be in place to fully realize our performance goals:
- GHC Version
- GHC 8.9+
- Your code
- The module you want to be optimized needs to import `Polysemy.Internal` somewhere in its dependency tree (sufficient to `import Polysemy`)
- GHC Flags
- `-O` or `-O2`
- `-flate-specialise` (this should be automatically turned on by the plugin, but it's worth mentioning)
- Plugin
- `-fplugin=Polysemy.Plugin`
- Additional concerns:
- additional core passes (turned on by the plugin)