update README about BoundedMean function #455
Merged
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.
Description
What is written in README.md file is old. So I updated it.
First of all, the execution of
BoundedMean(0.6, 1, 10)
has an error, because the arguments of BoundedMean function areepsilon: float = 1.0, delta: float = 0, lower_bound: Union[int, float, None] = None, upper_bound: Union[int, float, None] = None, l0_sensitivity: int = 1, linf_sensitivity: int = 1, dtype: str = "int"
in order. So the second argument ofBoundedMean(0.6, 1, 10)
is incompatible todelta
, which should be float type not integer type.Also the type of epsilon should be float not double, and modify some names of arguments like from
lower
tolower_bound
.Affected Dependencies
None.