At/docs #90
At/docs #90
Conversation
Codecov Report
@@ Coverage Diff @@
## main #90 +/- ##
=======================================
Coverage 81.08% 81.08%
=======================================
Files 11 11
Lines 312 312
=======================================
Hits 253 253
Misses 59 59
Continue to review full report at Codecov.
|
|
Can you grab commits 3c7032 through 4581d1c from #87 (excluding 04a1b78, I don't think we need to tag this) and add them to this since that's probably not going to get merged and those definitely fit under this header? Also, for my own educational purposes, can you send me the lines of git that you run to do that? 🥺 |
|
(All the other stuff here looks great to me, thanks for adding those missing docstrings!) |
src/features/elementfeature.jl
Outdated
| output_shape(efd::ElementFeatureDescriptor) = output_shape(efd, efd.encoder_decoder) | ||
|
|
||
| """ | ||
| output_shape(efd::ElementFeatureDescriptor, ed::OneHotOneCold) |
There was a problem hiding this comment.
I'm not sure this actually needs to be a separate docstring?
test/runtests.jl
Outdated
| @@ -4,6 +4,7 @@ using Test | |||
| const testdir = dirname(@__FILE__) | |||
|
|
|||
| tests = [ | |||
| "module_tests.jl" | |||
There was a problem hiding this comment.
I think this needs a comma and then the CI should pass again ;)
There was a problem hiding this comment.
oops, fixing it now.
Fixed this in main module file Signed-off-by: Rachel Kurchin <[email protected]>
this must not be covered by tests because featurizations aren't lists anymore so we can't iterate on them Signed-off-by: Rachel Kurchin <[email protected]>
Signed-off-by: Rachel Kurchin <[email protected]>
Signed-off-by: Rachel Kurchin <[email protected]>
…g that Signed-off-by: Rachel Kurchin <[email protected]>
It used to be a Union type included Vector{Integer}, but it should have been Vector{<:Integer}
Also added a test to disambiguate this case a bit better.
Signed-off-by: Rachel Kurchin <[email protected]>
Signed-off-by: Rachel Kurchin <[email protected]>
formatting Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
`ElementFeatureDescriptor` has been updated to include `encoder_decoder` field, and exclude the `length` and `logspaced` fields. Update the docstring of the type to reflect this. Accordingly, create a doctring for `ElementFeatureDescriptor`'s constructor as well. Signed-off-by: Anant Thazhemadam <[email protected]>
Create docstrings for the `default_efd_encode` and `default_efd_decode` (the default encode and decode functions for an ElementFeatureDescriptor respectively). Signed-off-by: Anant Thazhemadam <[email protected]>
Signed-off-by: Anant Thazhemadam <[email protected]>
Signed-off-by: Anant Thazhemadam <[email protected]>
Signed-off-by: Rachel Kurchin <[email protected]>
Signed-off-by: Rachel Kurchin <[email protected]>
Signed-off-by: Rachel Kurchin <[email protected]>
Test the functions `encodable_elements`, `decode`, and `featurize!` that are defined at the module level Signed-off-by: Rachel Kurchin <[email protected]> Signed-off-by: Anant Thazhemadam <[email protected]>
module_tests had .jl and it was getting added again, removed it so CI should hopefully pass now
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
following formatter suggestions Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
formatter suggestion Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Add a few docstrings, and new section for
Codecs