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

Clarify excluded parameter to Predictor.__init__ #19

Open
rafguns opened this issue Aug 21, 2018 · 1 comment
Open

Clarify excluded parameter to Predictor.__init__ #19

rafguns opened this issue Aug 21, 2018 · 1 comment

Comments

@rafguns
Copy link
Owner

rafguns commented Aug 21, 2018

#12 showed that the intended use of excluded can be misunderstood. As I write there:

Note that the excluded argument to a predictor (SimRank in this case) is intended to exclude certain edges from appearing in the results, not to exclude them during training.

So I think two things need to happen:

  • rename this to be clearer
  • document what it's for
@rafguns
Copy link
Owner Author

rafguns commented Aug 21, 2018

The doc string is actually fairly clear: https://github.com/rafguns/linkpred/blob/master/linkpred/predictors/base.py#L48. As it says

This is useful to, for instance, make sure that we only predict new links that are not currently in G.

Maybe a clearer (but somewhat less flexible) solution would be to revert the API to what was there many years ago: a boolean argument only_new (or a similar name).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant