-
Notifications
You must be signed in to change notification settings - Fork 36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
289 fib decoder #293
289 fib decoder #293
Conversation
I think something might be wrong with our checks? This should be flagging pylint errors for lack of documentation, no? |
@@ -0,0 +1,19 @@ | |||
import numpy as np | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please make sure to include a strong description of what this method is doing and building.
Comments:
- Missing documentation stating what the method is creating and a reference to the paper. i.e. Sec II of paper gives the appropriate definitions ... Also state that is this the particular case for L=2^k. Need to include what
start_arr
is. I might relabel this asstart_array
orstart_vector
or simplyseed
- Missing type hints
- I might change
dtype=int
todtype=np.int8
- I might shorten the name to just
gen_fib_code_word
- This is only well defined for L=2^k so that should be checked for. It is not clear to me if the input should therefor be k instead of L then. Either way I would create a
gen_fib_code_word
and_gen_fib_code_word
which is consistent with the framework style.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the code from Georgia and Ben or is this code that you developed? If code from Georgia and Ben please add to comments that code was originally developed by ... and include a reference to the paper.
Does this code "specialty" code, i.e. not really using the framework but just an inclusion, If so we should discuss how to include such code and an initial set. We have to make the same decisions for the machine learning decoder that we are moving in. Let's discuss.
Hey Drew, |
…nctionality into ClassicFibDecoder * ClassicFibDecoder -> ClassicFibonacciDecoder * Added Documentation * Pylint/Black Adherence
b6f169d
to
4ac9ee9
Compare
Summary
Addresses #289
Fibonacci Decoder
Details and comments