cstjean / ScikitLearn.jl

Julia implementation of the scikit-learn API https://cstjean.github.io/ScikitLearn.jl/dev/
Other
547 stars 75 forks source link

Links don't work and docs outdated #85

Closed PallHaraldsson closed 3 years ago

PallHaraldsson commented 4 years ago

"example gallery" link from the readme doesn't work:

https://github.com/cstjean/ScikitLearn.jl/blob/master/docs/examples.md

Seemingly the package works, and I got up to:

accuracy: 0.9733333333333334

The docs say 0.96, for some reason, so I was going to update, but the "Edit" link in the right corner doesn't work:

https://github.com/cstjean/ScikitLearn.jl/edit/master/docs/quickstart.md

https://scikitlearnjl.readthedocs.io/en/latest/models/#installation

Importing the Python models requires Python 2.7 with numpy, and the scikit-learn library. This is easiest to get through Conda.jl, which is already installed on your system.

I'm pretty sure I (only) Python3 scikitlearn installed (and only for 3.x still supported?)

I think I actually have Conda.jl, but while it's used by default on Windows I don't think it is on Linux.

Maybe change to Python 3.x or later (for some appropriate x, or just have x; and if Python 2.7 still works and you want it supported, "2.7 or 3.x" and later").

"JLD.jl is the preferred way of saving ScikitLearn.jl models."

I don't care too much either way, but should JLD2.jl also work and be mentioned?

cstjean commented 4 years ago

Thanks for all the feedback. I haven't had much time for this package in a while, but PRs are very appreciated. I'm not even entirely sure if Python 3 is supported, but if you can confirm that it is what's being used, and if it works well, then the docs should be updated for sure.

I don't care too much either way, but should JLD2.jl also work and be mentioned?

JLD.jl has PyCallJLD, which uses pickle. I'm not sure about JLD2

PallHaraldsson commented 4 years ago

https://scikit-learn.org/stable/install.html#install-official-release

Install the 64bit version of Python 3 [..] Scikit-learn now requires Python 3.6 or newer.

You're using Python 3 already (PyCall's default since 2018), unless you're changing: https://github.com/cstjean/ScikitLearn.jl/commit/211d615b9714bd15293206da83e108d065dbef42 https://github.com/JuliaPy/PyCall.jl/pull/512

OkonSamuel commented 4 years ago

https://scikitlearnjl.readthedocs.io/en/latest/models/#installation

@PallHaraldsson It appears your reading the old documentation (I have just updated the link to the docs in the README). The edit button in the updated docs work

OkonSamuel commented 4 years ago

accuracy: 0.9733333333333334

The updated documentation actually arrives at the above ans

OkonSamuel commented 4 years ago

@PallHaraldsson if your okay with the updated docs can we close this issue?

PallHaraldsson commented 4 years ago

https://scikitlearnjl.readthedocs.io/en/latest/models/#installation

still shows Python 2.7, but if I click "edit" in the corner there I get an error. I think maybe you updated the docs, but need to press some publish button?

OkonSamuel commented 3 years ago

@PallHaraldsson I meant you were using the old link. Here is the updated link https://cstjean.github.io/ScikitLearn.jl/dev/

OkonSamuel commented 3 years ago

@PallHaraldsson surely we can close this ?