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

Add power-user docs to bounter.py #18

Open
piskvorky opened this issue Oct 17, 2017 · 3 comments
Open

Add power-user docs to bounter.py #18

piskvorky opened this issue Oct 17, 2017 · 3 comments

Comments

@piskvorky
Copy link
Owner

piskvorky commented Oct 17, 2017

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 from bounter.py docstring.

@piskvorky piskvorky changed the title Add more docs to bounter.py Add power-user docs to bounter.py Oct 17, 2017
@thoppe
Copy link

thoppe commented Oct 31, 2017

Related to this, looking at the docs for the parameter:

size_mb (int): Desired memory footprint of the counter.

It's unclear what the default size is. If left to None, does it expand to available memory (this is what I'm assuming)?

@aneesh-joshi
Copy link
Contributor

@thoppe
https://github.com/RaRe-Technologies/bounter/blob/1585aff2afb20dca5bb7115e119497a7c22f1d2b/bounter/bounter.py#L32-L33

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?

@piskvorky
Copy link
Owner Author

piskvorky commented Oct 26, 2018

Yeah, why not.

But either way we should make clear what parameters are mandatory (size_mb) and which are optional, with what defaults.

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

No branches or pull requests

4 participants