Skip to content
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

update README about BoundedMean function #455

Merged
merged 1 commit into from
May 29, 2023

Conversation

tak-ka3
Copy link

@tak-ka3 tak-ka3 commented May 22, 2023

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 are epsilon: 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 of BoundedMean(0.6, 1, 10) is incompatible to delta, 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 to lower_bound.

Affected Dependencies

None.

@chinmayshah99
Copy link
Member

good catch! thank you @tak-ka3 for the PR :)

@chinmayshah99 chinmayshah99 merged commit 0e6ad34 into OpenMined:dev May 29, 2023
@chinmayshah99 chinmayshah99 added the Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase label May 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants