Standardize dividend argument in option models #51
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request fixes #50.
Motivation/Rational
The argument for dividends across different option pricing models used two names when only one was needed. This pull request updates the files using
continuous_dividends
to instead usedividend_rates
. This makes it easier for end-users to reuse code when using the different option pricing models.Explanation of Changes
As requested in issue #50, deprecation decorators were used to alert users to the change in argument names. All argument names in the
tf_quant_finance/black_scholes/
directory and sub-directories forcontinuous_dividends
were changed todividend_rates
.Testing
Many of the methods changed start with the variadic argument (*), which caused test to fail as Bazel would not recognize that the deprecated argument
continuous_dividends
was in the argument list, causing an error. When the variadic argument was removed, tests completed successfully.