-
Notifications
You must be signed in to change notification settings - Fork 228
Documentation: the import of KNeighborsClassifier is missing in "Getting Started" #258
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
Comments
KNeighborsClassifier
is missing in **Getting Started**
Hi @RobinVogel , the copy-paste feature is nice ! |
Thank you @wdevazelhes, I managed to generate the documentation using the "installation in editable mode" I did not know about. My documentation is very close from the one hosted by metric-learn, but differs slightly. I don't have experience with sphinx and if you happened to know where it comes from, it would help. I need to familiarize myself with sphinx in all cases. My log and the generated documentation, that I inspect using a local server with I have many warnings of the type |
Here's what I usually do (as suggested by @wdevazelhes some time ago). I create a specific environment in anaconda and install the relevant packages:
Then I install metric-learn in editable mode as suggested above:
Perhaps working in a clean environment solves the problem you're experiencing |
@RobinVogel: regarding the missing import, I think it is likely that the doc contains other missing imports and also syntax errors. It would definitely be nice to fix everything by trying to run everything. Note that to avoid more problems in the future we should have doctests, see #156 |
I have noticed that in fact I have the same problem in the references as you @RobinVogel, so I think before I was probably building the docs with an old sphinx version: using Regarding the |
The getting started example at the bottom of this page misses the import of
KNeighborsClassifier
.Also, changing the presentation of code in the
*.rst
file from:to:
as in
supervised.rst
allows to copy and paste the code as a block and try it straightaway.I tried to generate the documentation to solve that, I wrote this line but I keep getting:
what is the process to build and test the website locally ?
The text was updated successfully, but these errors were encountered: