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

[FDS] Improve seed docstring #3223

Merged
merged 4 commits into from
Apr 12, 2024
Merged

[FDS] Improve seed docstring #3223

merged 4 commits into from
Apr 12, 2024

Conversation

charlesbvll
Copy link
Member

Issue

Description

The docstring for FederatedDataset didn't specify the default seed or what happened when seed=None.

Related issues/PRs

N/A

Proposal

Explanation

Add more details (based on https://huggingface.co/docs/datasets/v2.18.0/en/package_reference/main_classes#datasets.Dataset.shuffle).

Checklist

  • Implement proposed change
  • Update the changelog entry below
  • Make CI checks pass
  • Ping maintainers on Slack (channel #contributions)

Changelog entry

Any other comments?

N/A

Copy link
Contributor

@adam-narozniak adam-narozniak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, we can have a partial copy of the docs from the numpy (HF also seemed to copy the docstring from numpy). I quickly looked at "entropy" in the numpy documentation, though I'm not really familiar with that in this context.
Anyway, it's fine with me.

@charlesbvll charlesbvll merged commit 236990e into main Apr 12, 2024
34 checks passed
@charlesbvll charlesbvll deleted the fds-improve-seed-docstring branch April 12, 2024 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants