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

[DOC] simple examples in documentation are broken #37

Closed
rolling-robot opened this issue Mar 18, 2023 · 11 comments
Closed

[DOC] simple examples in documentation are broken #37

rolling-robot opened this issue Mar 18, 2023 · 11 comments
Labels
documentation Improvements or additions to documentation

Comments

@rolling-robot
Copy link

rolling-robot commented Mar 18, 2023

Simple examples on https://outlierdetectionjl.github.io/OutlierDetection.jl/dev/API/detectors/#lofdetector
https://juliapackages.com/p/outlierdetection
do not seem to work.

How is it possible to fix them?

@rolling-robot rolling-robot added the documentation Improvements or additions to documentation label Mar 18, 2023
@rolling-robot
Copy link
Author

@rolling-robot
Copy link
Author

I see that MLJ pipelines do not work for OutlierDetection now: #31, but they are mentioned on the title page https://juliapackages.com/p/outlierdetection (and do not work indeed) in MLJ section.

Is it appropriate to change example on title page to something like #31 (comment) ?

@davnn
Copy link
Member

davnn commented Mar 24, 2023

You are right that pipelines do not currently work since they were changed in MLJ. It would be an option to add learning networks to the README, but maybe its enough to show a simple MLJ-based model in the readme.

Edit: Thank you for your pull request!

@davnn
Copy link
Member

davnn commented Mar 24, 2023

@all-contributors add @rolling-robot for docs.

@allcontributors
Copy link
Contributor

@davnn

I've put up a pull request to add @rolling-robot! 🎉

@rolling-robot
Copy link
Author

I think that something like that would fit title page (at least it works)
But I can't find the source for it https://juliapackages.com/p/outlierdetection to correct.

using MLJ
using OutlierDetection
using OutlierDetectionData: ODDS

X, y = ODDS.load("annthyroid")

LOF = @iload LOFDetector pkg=OutlierDetectionNeighbors verbosity=0

lof = ProbabilisticDetector(LOF())
cv = StratifiedCV(nfolds=5, shuffle=true, rng=0)
r = range(lof, :(detector.k), values=[1,2,3,4,5:5:100...])

t = TunedModel(model=lof, resampling=cv, tuning=Grid(), range=r, acceleration=CPUThreads())
m = machine(t, X, y) |> fit!
report(m).best_history_entry
b = report(m).best_model
evaluate(b, X, y, resampling=cv)
ŷ=predict(m, X)

@rolling-robot
Copy link
Author

Also this warning should be corrected, as current version is 0.3.3, according to github

🚧 Experimental, install from master branch until 0.2 is released and expect breaking changes 🚧

@davnn
Copy link
Member

davnn commented Mar 24, 2023

Do you, by any chance, know how to update that page?

@rolling-robot
Copy link
Author

Well, I have found where it comes from. The page was statically generated long ago from a readme in this repo. This statically generated page is now at https://github.com/djsegal/JuliaPackages.jl/blob/2862c325ecf0c7e3da10e3cc7a210750a39914bf/data/readme_html/outlierdetection.txt

@rolling-robot
Copy link
Author

Looks like title page for every single package on juliapackages.com is a 2 year old readme.

@rolling-robot
Copy link
Author

I think this issue can be closed as the main problem for my OP is upstream.

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

No branches or pull requests

2 participants