wip docs and edge cases #15
Conversation
| function __init__() | ||
| gr() | ||
| GR.inline("png") | ||
| end |
There was a problem hiding this comment.
I think this might be better but I am not totally sure
There was a problem hiding this comment.
@hannahilea pointed out that this code would be unnecessary after #1
src/utilities.jl
Outdated
| @@ -17,6 +17,7 @@ using the trapezoidal rule. | |||
| """ | |||
| function area_under_curve(x, y) | |||
| @assert length(x) == length(y) | |||
| length(x) == 0 && return 0.0 | |||
There was a problem hiding this comment.
hit some strange edge case in beacon-biosignals/LighthouseFlux.jl#20 which is why I added this; possibly this should error or something instead though
There was a problem hiding this comment.
In any case, let's add a unit tests that demonstrates the expected behavior.
| @@ -0,0 +1,28 @@ | |||
| # Evaluation metrics | |||
There was a problem hiding this comment.
I wonder if these should be docstrings? The reason I didn't do so from the start is that I meant this page to be more pedagogical (and hopefully to have references), instead of just documenting the programmatic API.
|
I added push previews and the cleanup workflow. This has been working well over at KeywordSearch and since this is a docs PR, I think it would help to see the generated docs! Preview docs are here: https://beacon-biosignals.github.io/Lighthouse.jl/previews/PR15/ |
|
Update on this: I think #18 already addressed the indentation stuff from this PR and the GR stuff is removed in (#28), and the doc-cleanup script I included here is out-dated (newer one is at https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#gh-pages-Branch). So what's left that's useful here is the WIP terminology and the edge-case bit. Hopefully I'll be able to get back to those at some point and update this then. |
This is a companion of sorts to beacon-biosignals/LighthouseFlux.jl#20
Preview: https://beacon-biosignals.github.io/Lighthouse.jl/previews/PR15/