-
Notifications
You must be signed in to change notification settings - Fork 990
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
[docs] troubleshooting guide #2133
[docs] troubleshooting guide #2133
Conversation
The documentation is not available anymore as the PR was closed or merged. |
docs/source/_toctree.yml
Outdated
- local: usage_guides/troubleshooting | ||
title: Troubleshooting guide |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not wondering if these may have more value in the Getting Started or Tutorials area. Or put this at the top of the table of contents for this section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm ok with moving it into Tutorials, out of all the suggestions, it feels like the most fitting.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! I did a first passthrough on these, overall they're great!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for centralizing this all into a core doc!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Maria, this is a great addition and hopefully will help many users to come. I left a few small comments.
Also wondering if this would be a good place to mention that kernel issue @muellerzr, maybe in the "Hanging code and timeout errors" section.
Could you please provide some context about the kernel issue you mentioned? |
Users sometimes report hanging processes when using older Linux kernels, e.g. here #1929. I thought this could fit here but it's not a must have/can be added later. |
I have addressed the feedback and added: a) a small section on Early stopping (re: #1940) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the additions. LGTM.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Beautiful! 🤩 Thanks!
This PR adds a "Troubleshooting guide" to consolidate all the tips and tools that can be helpful when troubleshooting issues on one page.
What the page includes:
A centralized guide can make it easier to troubleshoot common issues as opposed to multiple docs.