-
-
Notifications
You must be signed in to change notification settings - Fork 47
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
Add power-user docs to bounter.py
#18
Comments
bounter.py
bounter.py
Related to this, looking at the docs for the parameter:
It's unclear what the default size is. If left to |
@thoppe doesn't seem to do anything but raise an error. @piskvorky we should probably also move the docs style to be more like numpy docs (like is being done in gensim) wdyt? |
Yeah, why not. But either way we should make clear what parameters are mandatory (size_mb) and which are optional, with what defaults. |
Expand on the way the algos work under the hood, for power users: parameters of CMS (width, depth), memory vs accuracy trade-offs, log8/log1024 etc.
This should be either a part of
bounter.py
module docstring (where people are most likely to look for it; we also link to this from the README), or a link to a repo notebook /.md
file linked to frombounter.py
docstring.The text was updated successfully, but these errors were encountered: