search

mlr-org / mlr3filters

Filter-based feature selection for mlr3
https://mlr3filters.mlr-org.com
GNU Lesser General Public License v3.0
20 stars 8 forks source link

Docs #132

Closed sebffischer closed 2 years ago

sebffischer commented 2 years ago

Addresses https://github.com/mlr-org/mlr3filters/issues/103

sebffischer commented 2 years ago

why do we have pre-commit in the ci? What is circle ci?

sebffischer commented 2 years ago

Why does pre-commit push into my commits?

sebffischer commented 2 years ago

@pat-s

mllg commented 2 years ago

IDK if you have to touch each example. I think it would be better to demonstrate filtering in the book, and include the URL on the man pages of the filters. You could also plot the graph and show how to extract the filter values and the model.

mllg commented 2 years ago

So basically extend https://mlr3book.mlr-org.com/optimization.html#fs-filter and link here; having a smaller example in the README is also good.

pat-s commented 2 years ago

IDK if you have to touch each example. I think it would be better to demonstrate filtering in the book, and include the URL on the man pages of the filters. You could also plot the graph and show how to extract the filter values and the model.

+1, also because just adding pipelines into the dep stack for this is not worth it.

Why does pre-commit push into my commits?

Why not? It just does what you should have done locally, rendering the man files. I'd like to have it in repos I maintain, pre-commit is nothing new - we extensively discussed it during the last workshop.

sebffischer commented 2 years ago
  1. I agree that making one nice example in the book and linking is better.
  2. @pat-s Adding mlr3pipelines to suggests is still required to be able to link to PipeOpFilter (see michel's original issue)
pat-s commented 2 years ago

@pat-s Adding mlr3pipelines to suggests is still required to be able to link to PipeOpFilter (see michel's original issue)

Only if you use roxygen2 syntax. We have similar cases in other extension pkgs where we don't link via roxygen2 if this would be only reason to put a pkg into the dependency stack.

I'd really avoid having mlr3pipelines as a dep in here. Instead we can add a sentence into the help files which say "for examples how to use mlr3filters with mlr3pipelines, have a look at this book section".

mllg commented 2 years ago

Why is putting mlr3pipelines in Suggests a problem? This is only one more package in the CI (without any additional dependencies or system libraries), and no extra packages to install for the user.