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 L1-regularization parameter tutorial #264

Conversation

wassimmazouz
Copy link
Contributor

@wassimmazouz wassimmazouz commented Jul 2, 2024

This PR aims to add documentation about the mathematical context behind the choice of L1-regularization in skglm as it is one of the frequently asked questions.

Tasks :

  • Created .rst tutorial and added its tag to the tutorials.rst file
  • Introduced the problem and aim of the tutorial
  • Finished the theoretical background
  • Illustrated with an example
  • Added references

@Badr-MOUFAD
Copy link
Collaborator

Thanks for the PR @wassimmazouz

I will follow along with you so ping me when you are done or need a hand

@mathurinm
Copy link
Collaborator

@wassimmazouz almost done, can you look into this rendering bug for the align environment that I was not able to fix ?

image

@wassimmazouz
Copy link
Contributor Author

@mathurinm Is it a local issue? It renders correctly for me
image

@mathurinm
Copy link
Collaborator

We have an action that builds the doc on the PR and publishes it (build doc artifacts on circle CI), see the buggy rendering here too: https://output.circle-artifacts.com/output/job/c0047b51-706d-4b6c-ba96-4160db844411/artifacts/0/dev/tutorials/alpha_max.html#theoretical-background (from 1 commit ago)

@wassimmazouz
Copy link
Contributor Author

@mathurinm it might have to do with the sphinx or mathjax versions. Some forums report similar errors in older versions of these packages. I tried to change the version and test locally but no progress for now.
I added a eqnarray to try if it works without changing anything else.

@Badr-MOUFAD
Copy link
Collaborator

The problem seems to appear only for multiline equations.
Fixed it by adding :nowrap: directive and writing plain tex.

Perhaps, sphinx/mathjax has troubles parsing the equation 🤷‍♂️

@mathurinm
Copy link
Collaborator

@wassimmazouz can you report this back to sphinx with a minimal example ?

Copy link
Collaborator

@mathurinm mathurinm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking great, thanks @wassimmazouz @Badr-MOUFAD

@mathurinm mathurinm merged commit 776afdf into scikit-learn-contrib:main Jul 2, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants