update benchmarks

Author: mileslucas

bench/bench.jl

@@ -4,10 +4,13 @@ using DataFrames
 using PSFModels: Gaussian, AiryDisk, Moffat
 using PyCall
 
-apm = pyimport("astropy.modeling.functional_models")
-
 @info "Starting PSF evaluation benchmark"
 
+ap = pyimport("astropy")
+apm = pyimport("astropy.modeling.models")
+@info "Using astropy version $(ap.__version__)"
+
+
 julia_models = [
     Gaussian((5.3, 4.7)), 
     AiryDisk(12.7), 
@@ -19,7 +22,7 @@ astropy_models = [
     apm.Moffat2D(gamma=8.1, alpha=-1)
 ]
 
-names = ("Gaussian", "AiryDisk", "Moffat")
+names = ["Gaussian", "AiryDisk", "Moffat"]
 jl_times = []
 py_times = []
 
@@ -36,7 +39,8 @@ end
 filename = joinpath(@__DIR__, "results.csv")
 DataFrame(name=names, psfmodels=jl_times, astropy=py_times) |> CSV.write(filename)
 
+@info "Results saved to $filename"
 
-@info "Finished PSF evaluation benchmark. Results saved to $filename"
+@info "Finished PSF evaluation benchmark"
 
 nothing

bench/requirements.txt

@@ -0,0 +1 @@
+astropy==4.*

bench/results.csv

@@ -1,4 +1,4 @@
 name,psfmodels,astropy
-"(""Gaussian"", ""AiryDisk"", ""Moffat"")",1.5927855711422846e-8,0.000165969
-"(""Gaussian"", ""AiryDisk"", ""Moffat"")",3.7001009081735617e-8,0.000135154
-"(""Gaussian"", ""AiryDisk"", ""Moffat"")",1.192685370741483e-8,0.000134448
+Gaussian,1.5832665330661323e-8,0.000164387
+AiryDisk,3.699092741935484e-8,0.000108041
+Moffat,1.192685370741483e-8,9.8272e-5

docs/Project.toml

@@ -1,10 +1,13 @@
 [deps]
+CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 HCIDatasets = "1893dc6a-5236-4cb8-aa54-62ea411c10cd"
 LossFunctions = "30fc2ffe-d236-52d8-8643-a9d8f7c094a7"
 Optim = "429524aa-4258-5aef-a3af-852621145aeb"
 PSFModels = "9ba017d1-7760-46cd-84a3-1e79e9ae9ddc"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
+StatsPlots = "f3b207a7-027a-5e70-b257-86293d7955fd"
 
 [compat]
 Documenter = "0.25"

docs/src/index.md

@@ -51,3 +51,50 @@ model = M.Gaussian(10)
 ```@docs
 PSFModels
 ```
+
+## Benchmarks
+
+The benchmarks can be found in the [`bench/`](https://github.com/JuliaAstro/PSFModels.jl/tree/master/bench) folder. To run them, first install the python dependencies
+
+```
+$ pip install -r bench/requirements.txt
+```
+
+Then run the benchmark
+
+```
+$ julia --project=bench bench/bench.jl
+```
+
+**System Information**
+
+```
+Julia Version 1.5.0
+Commit 96786e22cc (2020-08-01 23:44 UTC)
+Platform Info:
+  OS: macOS (x86_64-apple-darwin18.7.0)
+  CPU: Intel(R) Core(TM) i5-8259U CPU @ 2.30GHz
+  WORD_SIZE: 64
+  LIBM: libopenlibm
+  LLVM: libLLVM-9.0.1 (ORCJIT, skylake)
+Environment:
+  JULIA_NUM_THREADS = 4
+```
+
+```@setup bench
+using CSV, DataFrames
+using StatsPlots
+benchdir(args...) = joinpath("..", ".." ,"bench", args...);
+```
+
+---
+
+```@example bench
+table = CSV.File(benchdir("results.csv")) |> DataFrame
+```
+
+```@example bench
+@df table groupedbar(:name, [:psfmodels :astropy];
+    ylabel="time (s)", yscale=:log10, leg=:outerbottom,
+    label=["PSFModels.jl" "Astropy"])
+```